dart::common::detail::EmbeddedStateAspect< BaseT, DerivedT, StateDataT, StateT, setEmbeddedState, getEmbeddedState > Class Template Reference

Inheritance diagram for dart::common::detail::EmbeddedStateAspect< BaseT, DerivedT, StateDataT, StateT, setEmbeddedState, getEmbeddedState >:

Collaboration diagram for dart::common::detail::EmbeddedStateAspect< BaseT, DerivedT, StateDataT, StateT, setEmbeddedState, getEmbeddedState >:

Classes
struct	ConvertIfState
	Used to identify constructor arguments that can be used as a State. More...

Public Types
enum	DelegateTag { Delegate }
using	Base = BaseT
using	Derived = DerivedT
using	State = StateT
using	StateData = StateDataT

Public Member Functions
	EmbeddedStateAspect (const EmbeddedStateAspect &)=delete
	EmbeddedStateAspect ()
	Construct this Aspect without affecting the State.
template<typename T , typename... RemainingArgs>
	EmbeddedStateAspect (const T &arg1, RemainingArgs &&... remainingArgs)
	Construct this Aspect. More...
void	setAspectState (const Aspect::State &state) override final
void	setState (const State &state)
	Set the State of this Aspect.
const Aspect::State *	getAspectState () const override final
const State &	getState () const
	Get the State of this Aspect.
std::unique_ptr< Aspect >	cloneAspect () const override

Static Public Attributes
static constexpr void(*	SetEmbeddedState )(Derived *, const State &) = setEmbeddedState
static constexpr const State &(*	GetEmbeddedState )(const Derived *) = getEmbeddedState

Protected Member Functions
template<typename... RemainingArgs>
	EmbeddedStateAspect (DelegateTag, const StateData &state, RemainingArgs &&... remainingArgs)
	Construct this Aspect using the StateData, and pass the remaining arguments into the constructor of the Base class. More...
template<typename... BaseArgs>
	EmbeddedStateAspect (DelegateTag, BaseArgs &&... args)
	Construct this Aspect without affecting the State, and pass all the arguments into the constructor of the Base class. More...
void	setComposite (Composite *newComposite) override
	Pass the temporary State of this Aspect into the new Composite.
void	loseComposite (Composite *oldComposite) override
	Save the embedded State of this Composite before we remove the Aspect.

Protected Attributes
std::unique_ptr< State >	mTemporaryState
	After this Aspect is constructed and during transitions between Composite objects, this will hold the State of the Aspect. More...

Constructor & Destructor Documentation

EmbeddedStateAspect() [1/3]

template<class BaseT, class DerivedT, typename StateDataT, typename StateT = common::Aspect::MakeState<StateDataT>, void(*)(DerivedT *, const StateT &) setEmbeddedState = &DefaultSetEmbeddedState<DerivedT, StateT>, const StateT &(*)(const DerivedT *) getEmbeddedState = &DefaultGetEmbeddedState<DerivedT, StateT>>

template<typename T , typename... RemainingArgs>

dart::common::detail::EmbeddedStateAspect< BaseT, DerivedT, StateDataT, StateT, setEmbeddedState, getEmbeddedState >::EmbeddedStateAspect ( const T &  arg1, RemainingArgs &&...  remainingArgs  )

inline

Construct this Aspect.

If the first argument contains StateData, then it will be used by this Aspect. Otherwise, all arguments will be forwarded to the Base class.

EmbeddedStateAspect() [2/3]

template<class BaseT, class DerivedT, typename StateDataT, typename StateT = common::Aspect::MakeState<StateDataT>, void(*)(DerivedT *, const StateT &) setEmbeddedState = &DefaultSetEmbeddedState<DerivedT, StateT>, const StateT &(*)(const DerivedT *) getEmbeddedState = &DefaultGetEmbeddedState<DerivedT, StateT>>

template<typename... RemainingArgs>

dart::common::detail::EmbeddedStateAspect< BaseT, DerivedT, StateDataT, StateT, setEmbeddedState, getEmbeddedState >::EmbeddedStateAspect ( DelegateTag  , const StateData &  state, RemainingArgs &&...  remainingArgs  )

inlineprotected

Construct this Aspect using the StateData, and pass the remaining arguments into the constructor of the Base class.

EmbeddedStateAspect() [3/3]

template<class BaseT, class DerivedT, typename StateDataT, typename StateT = common::Aspect::MakeState<StateDataT>, void(*)(DerivedT *, const StateT &) setEmbeddedState = &DefaultSetEmbeddedState<DerivedT, StateT>, const StateT &(*)(const DerivedT *) getEmbeddedState = &DefaultGetEmbeddedState<DerivedT, StateT>>

template<typename... BaseArgs>

dart::common::detail::EmbeddedStateAspect< BaseT, DerivedT, StateDataT, StateT, setEmbeddedState, getEmbeddedState >::EmbeddedStateAspect ( DelegateTag  , BaseArgs &&...  args  )

inlineprotected

Construct this Aspect without affecting the State, and pass all the arguments into the constructor of the Base class.

Member Data Documentation

mTemporaryState

template<class BaseT, class DerivedT, typename StateDataT, typename StateT = common::Aspect::MakeState<StateDataT>, void(*)(DerivedT *, const StateT &) setEmbeddedState = &DefaultSetEmbeddedState<DerivedT, StateT>, const StateT &(*)(const DerivedT *) getEmbeddedState = &DefaultGetEmbeddedState<DerivedT, StateT>>

std::unique_ptr<State> dart::common::detail::EmbeddedStateAspect< BaseT, DerivedT, StateDataT, StateT, setEmbeddedState, getEmbeddedState >::mTemporaryState

protected

After this Aspect is constructed and during transitions between Composite objects, this will hold the State of the Aspect.

Once the Aspect has been moved into a new Composite, this State will be pushed into the Composite and cleared.

---

The documentation for this class was generated from the following file:

• dart/common/detail/EmbeddedAspect.hpp