dart::common::Aspect Class Reference

#include <Aspect.hpp>

Inheritance diagram for dart::common::Aspect:

Classes
class	Properties
	If your Aspect has Properties, then that Properties class should inherit this Aspect::Properties class. More...
class	State
	If your Aspect has a State, then that State class should inherit this Aspect::State class. More...

Public Types
template<class Mixin >
using	MakeState = MakeCloneable< State, Mixin >
	Use the MakeState class to easily create a State extension from an existing class or struct.
template<class Mixin >
using	MakeProperties = MakeCloneable< Properties, Mixin >
	Use the MakeProperties class to easily create a Properties extension from an existing class or struct.

Public Member Functions
virtual	~Aspect ()=default
	Virtual destructor.
virtual std::unique_ptr< Aspect >	cloneAspect () const =0
	Clone this Aspect into a new composite.
virtual void	setAspectState (const State &otherState)
	Set the State of this Aspect. By default, this does nothing.
virtual const State *	getAspectState () const
	Get the State of this Aspect.
virtual void	setAspectProperties (const Properties &someProperties)
	Set the Properties of this Aspect. By default, this does nothing.
virtual const Properties *	getAspectProperties () const
	Get the Properties of this Aspect.

Protected Member Functions
virtual void	setComposite (Composite *newComposite)
	This function will be triggered (1) after the Aspect has been created [transfer will be false] and (2) after the Aspect has been transferred to a new Composite [transfer will be true].
virtual void	loseComposite (Composite *oldComposite)
	This function will be triggered if your Aspect is about to be removed from its Composite.

Friends
class	Composite

Member Typedef Documentation

MakeProperties

template<class Mixin >

using dart::common::Aspect::MakeProperties = MakeCloneable<Properties, Mixin>

Use the MakeProperties class to easily create a Properties extension from an existing class or struct.

MakeState

template<class Mixin >

using dart::common::Aspect::MakeState = MakeCloneable<State, Mixin>

Use the MakeState class to easily create a State extension from an existing class or struct.

Constructor & Destructor Documentation

~Aspect()

virtual dart::common::Aspect::~Aspect ( )

virtualdefault

Virtual destructor.

Member Function Documentation

cloneAspect()

virtual std::unique_ptr< Aspect > dart::common::Aspect::cloneAspect ( ) const

pure virtual

Clone this Aspect into a new composite.

Implemented in dart::common::detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >, dart::common::detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAspect< CompositeT, StateDataT >, StateDataT >, dart::common::detail::EmbeddedPropertiesAspect< CompositeTrackingAspect< CompositeT >, EmbeddedPropertiesAspect< CompositeT, PropertiesDataT >, PropertiesDataT >, dart::common::detail::EmbeddedPropertiesAspect< detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, PropertiesDataT >, and dart::common::EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >.

getAspectProperties()

const Aspect::Properties * dart::common::Aspect::getAspectProperties ( ) const

virtual

Get the Properties of this Aspect.

By default, this returns a nullptr which implies that the Aspect has no properties.

Reimplemented in dart::common::detail::EmbeddedPropertiesAspect< CompositeTrackingAspect< CompositeT >, EmbeddedPropertiesAspect< CompositeT, PropertiesDataT >, PropertiesDataT >, and dart::common::detail::EmbeddedPropertiesAspect< detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, PropertiesDataT >.

getAspectState()

const Aspect::State * dart::common::Aspect::getAspectState ( ) const

virtual

Get the State of this Aspect.

By default, this returns a nullptr which implies that the Aspect is stateless.

Reimplemented in dart::common::detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >, and dart::common::detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAspect< CompositeT, StateDataT >, StateDataT >.

loseComposite()

void dart::common::Aspect::loseComposite ( Composite *  oldComposite )

protectedvirtual

This function will be triggered if your Aspect is about to be removed from its Composite.

While this function is being called, the Aspect is still a valid part of the Composite; it will be removed immediately after this function call. By default, this function does nothing.

Reimplemented in dart::common::CompositeTrackingAspect< CompositeType >, dart::common::CompositeTrackingAspect< CompositeT >, dart::common::detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >, dart::common::detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAspect< CompositeT, StateDataT >, StateDataT >, dart::common::detail::EmbeddedPropertiesAspect< CompositeTrackingAspect< CompositeT >, EmbeddedPropertiesAspect< CompositeT, PropertiesDataT >, PropertiesDataT >, and dart::common::detail::EmbeddedPropertiesAspect< detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, PropertiesDataT >.

setAspectProperties()

void dart::common::Aspect::setAspectProperties ( const Properties &  someProperties )

virtual

Set the Properties of this Aspect. By default, this does nothing.

Reimplemented in dart::common::detail::EmbeddedPropertiesAspect< CompositeTrackingAspect< CompositeT >, EmbeddedPropertiesAspect< CompositeT, PropertiesDataT >, PropertiesDataT >, and dart::common::detail::EmbeddedPropertiesAspect< detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, PropertiesDataT >.

setAspectState()

void dart::common::Aspect::setAspectState ( const State &  otherState )

virtual

Set the State of this Aspect. By default, this does nothing.

Reimplemented in dart::common::detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >, and dart::common::detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAspect< CompositeT, StateDataT >, StateDataT >.

setComposite()

void dart::common::Aspect::setComposite ( Composite *  newComposite )

protectedvirtual

This function will be triggered (1) after the Aspect has been created [transfer will be false] and (2) after the Aspect has been transferred to a new Composite [transfer will be true].

You should override this function if your Aspect requires special handling in either of those cases. By default, this function does nothing.

Reimplemented in dart::common::CompositeTrackingAspect< CompositeType >, dart::common::CompositeTrackingAspect< CompositeT >, dart::common::detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >, dart::common::detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAspect< CompositeT, StateDataT >, StateDataT >, dart::common::detail::EmbeddedPropertiesAspect< CompositeTrackingAspect< CompositeT >, EmbeddedPropertiesAspect< CompositeT, PropertiesDataT >, PropertiesDataT >, and dart::common::detail::EmbeddedPropertiesAspect< detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, PropertiesDataT >.

Friends And Related Symbol Documentation

Composite

friend class Composite

friend