DART  6.10.1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
dart::common::CompositeTrackingAspect< CompositeType > Class Template Referenceabstract

#include <Aspect.hpp>

Inheritance diagram for dart::common::CompositeTrackingAspect< CompositeType >:
dart::common::Aspect

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. 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

 CompositeTrackingAspect ()
 Default constructor. More...
 
CompositeType * getComposite ()
 Get the Composite of this Aspect. More...
 
const CompositeType * getComposite () const
 Get the Composite of this Aspect. More...
 
bool hasComposite () const
 Returns true if this Aspect has a Composite that matches CompositeType. More...
 
virtual std::unique_ptr< Aspect > cloneAspect () const =0
 Clone this Aspect into a new composite. More...
 
virtual void setAspectState (const State &otherState)
 Set the State of this Aspect. By default, this does nothing. More...
 
virtual const State * getAspectState () const
 Get the State of this Aspect. More...
 
virtual void setAspectProperties (const Properties &someProperties)
 Set the Properties of this Aspect. By default, this does nothing. More...
 
virtual const Properties * getAspectProperties () const
 Get the Properties of this Aspect. More...
 

Protected Member Functions

void setComposite (Composite *newComposite) override
 Grab the new Composite. More...
 
void loseComposite (Composite *oldComposite) override
 Clear the old Composite. More...
 

Protected Attributes

CompositeType * mComposite
 Pointer to the current Composite of this Aspect. More...
 

Member Typedef Documentation

◆ MakeProperties

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

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>
inherited

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

Constructor & Destructor Documentation

◆ CompositeTrackingAspect()

template<class CompositeType >
dart::common::CompositeTrackingAspect< CompositeType >::CompositeTrackingAspect

Default constructor.

Member Function Documentation

◆ cloneAspect()

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

Clone this Aspect into a new composite.

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

◆ getAspectProperties()

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

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< detail::EmbeddedStateAspect< CompositeTrackingAspect< CompositeT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, StateDataT >, EmbeddedStateAndPropertiesAspect< CompositeT, StateDataT, PropertiesDataT >, PropertiesDataT >, and dart::common::detail::EmbeddedPropertiesAspect< CompositeTrackingAspect< CompositeT >, EmbeddedPropertiesAspect< CompositeT, PropertiesDataT >, PropertiesDataT >.

◆ getAspectState()

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

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 >.

◆ getComposite() [1/2]

template<class CompositeType >
CompositeType * dart::common::CompositeTrackingAspect< CompositeType >::getComposite

Get the Composite of this Aspect.

◆ getComposite() [2/2]

template<class CompositeType >
const CompositeType * dart::common::CompositeTrackingAspect< CompositeType >::getComposite

Get the Composite of this Aspect.

◆ hasComposite()

template<class CompositeType >
bool dart::common::CompositeTrackingAspect< CompositeType >::hasComposite

Returns true if this Aspect has a Composite that matches CompositeType.

◆ loseComposite()

template<class CompositeType >
void dart::common::CompositeTrackingAspect< CompositeType >::loseComposite ( Composite *  oldComposite)
overrideprotectedvirtual

Clear the old Composite.

Reimplemented from dart::common::Aspect.

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

◆ setAspectProperties()

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

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

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

◆ setAspectState()

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

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()

template<class CompositeType >
void dart::common::CompositeTrackingAspect< CompositeType >::setComposite ( Composite *  newComposite)
overrideprotectedvirtual

Grab the new Composite.

Reimplemented from dart::common::Aspect.

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

Member Data Documentation

◆ mComposite

template<class CompositeType >
CompositeType* dart::common::CompositeTrackingAspect< CompositeType >::mComposite
protected

Pointer to the current Composite of this Aspect.