dart::common::EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT > Class Template Reference

This is the implementation of a standard combination of embedded-state and embedded-properties Aspect. More...

#include <EmbeddedAspect.hpp>

Inheritance diagram for dart::common::EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >:

Collaboration diagram for dart::common::EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >:

Public Types
using	Derived = EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >
using	AspectStateImpl = detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, Derived, StateDataT >
using	AspectPropertiesImpl = detail::EmbeddedPropertiesAspect< AspectStateImpl, Derived, PropertiesDataT >
using	AspectImpl = Derived
using	State = typename AspectStateImpl::State
using	StateData = typename AspectStateImpl::StateData
using	Properties = typename AspectPropertiesImpl::Properties
using	PropertiesData = typename AspectPropertiesImpl::PropertiesData
using	CompositeType = CompositeT
Public Types inherited from dart::common::detail::EmbeddedPropertiesAspect< detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, PropertiesDataT >
using	Base = detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >
using	Derived = EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >
using	Properties = common::Aspect::MakeProperties< PropertiesDataT >
using	PropertiesData = PropertiesDataT
Public Types inherited from dart::common::detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >
enum	DelegateTag
using	Base = CompositeTrackingAspect< CompositeT >
using	Derived = EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >
using	State = common::Aspect::MakeState< StateDataT >
using	StateData = StateDataT
Public Types inherited from dart::common::Aspect
template<class Mixin >
using	MakeState = MakeCloneable< State, Mixin >
	Use the MakeState class to easily create a State extension from an existing class or struct. More...
template<class Mixin >
using	MakeProperties = MakeCloneable< Properties, Mixin >
	Use the MakeProperties class to easily create a Properties extension from an existing class or struct. More...

Public Member Functions
	EmbeddedStateAndPropertiesAspect (const EmbeddedStateAndPropertiesAspect &)=delete
	EmbeddedStateAndPropertiesAspect ()
	Construct using nothing. The object will remain unaffected.
	EmbeddedStateAndPropertiesAspect (const StateData &state)
	Construct using a State. The object's Properties will remain unaffected.
	EmbeddedStateAndPropertiesAspect (const PropertiesData &properties)
	Construct using Properties. The object's State will remain unaffected.
	EmbeddedStateAndPropertiesAspect (const StateData &state, const PropertiesData &properties)
	Construct using a State and Properties instance.
	EmbeddedStateAndPropertiesAspect (const PropertiesData &properties, const StateData &state)
	Construct using a Properties and State instance.
std::unique_ptr< Aspect >	cloneAspect () const override
	Clone this Aspect into a new composite.
Public Member Functions inherited from dart::common::detail::EmbeddedPropertiesAspect< detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, PropertiesDataT >
	EmbeddedPropertiesAspect (const EmbeddedPropertiesAspect &)=delete
	EmbeddedPropertiesAspect ()
	Construct this Aspect without affecting the Properties.
	EmbeddedPropertiesAspect (const T &arg1, RemainingArgs &&... remainingArgs)
	Construct this Aspect. More...
void	setAspectProperties (const Aspect::Properties &properties) override final
void	setProperties (const Properties &properties)
const Aspect::Properties *	getAspectProperties () const override final
const Properties &	getProperties () const
std::unique_ptr< Aspect >	cloneAspect () const override
Public Member Functions inherited from dart::common::detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >
	EmbeddedStateAspect (const EmbeddedStateAspect &)=delete
	EmbeddedStateAspect ()
	Construct this Aspect without affecting the State.
	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.
Public Member Functions inherited from dart::common::CompositeTrackingAspect< CompositeT >
	CompositeTrackingAspect ()
	Default constructor.
CompositeT *	getComposite ()
	Get the Composite of this Aspect.
const CompositeT *	getComposite () const
	Get the Composite of this Aspect.
bool	hasComposite () const
	Returns true if this Aspect has a Composite that matches CompositeType.
Public Member Functions inherited from dart::common::Aspect
virtual	~Aspect ()=default
	Virtual destructor.

Additional Inherited Members
Static Public Attributes inherited from dart::common::detail::EmbeddedPropertiesAspect< detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, PropertiesDataT >
static constexpr void(*	SetEmbeddedProperties )(Derived *, const Properties &)
static constexpr const Properties &(*	GetEmbeddedProperties )(const Derived *)
Static Public Attributes inherited from dart::common::detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >
static constexpr void(*	SetEmbeddedState )(Derived *, const State &)
static constexpr const State &(*	GetEmbeddedState )(const Derived *)
Protected Types inherited from dart::common::detail::EmbeddedPropertiesAspect< detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, PropertiesDataT >
enum	DelegateTag
Protected Member Functions inherited from dart::common::detail::EmbeddedPropertiesAspect< detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, PropertiesDataT >
	EmbeddedPropertiesAspect (DelegateTag, const PropertiesData &properties, RemainingArgs &&... remainingArgs)
	Construct this Aspect using the PropertiesData, and pass the remaining arguments into the constructor of the Base class. More...
	EmbeddedPropertiesAspect (DelegateTag, BaseArgs &&... args)
	Construct this Aspect without affecting the Properties, and pass all the arguments into the constructor of the Base class. More...
void	setComposite (Composite *newComposite) override
	Pass the temporary Properties of this Aspect into the new Composite.
void	loseComposite (Composite *oldComposite) override
	Save the embedded Properties of this Composite before we remove the Aspect.
Protected Member Functions inherited from dart::common::detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >
	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...
	EmbeddedStateAspect (DelegateTag, BaseArgs &&... args)
	Construct this Aspect without affecting the State, and pass all the arguments into the constructor of the Base class. More...
Protected Attributes inherited from dart::common::detail::EmbeddedPropertiesAspect< detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, PropertiesDataT >
std::unique_ptr< Properties >	mTemporaryProperties
	After this Aspect is constructed and during transitions between Composite objects, this will hold the Properties of the Aspect. More...
Protected Attributes inherited from dart::common::detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >
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...
Protected Attributes inherited from dart::common::CompositeTrackingAspect< CompositeT >
CompositeT *	mComposite
	Pointer to the current Composite of this Aspect.

Detailed Description

template<class CompositeT, typename StateDataT, typename PropertiesDataT>
class dart::common::EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >

This is the implementation of a standard combination of embedded-state and embedded-properties Aspect.

Inherit the EmbedStateAndProperties (next class down in the header) to use this Aspect implementation.

---

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

• dart/common/EmbeddedAspect.hpp