MIRA
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
IRigidModelConsumer Class Referenceabstract

IRigidModelConsumer is a unit that has a ServiceProperty 'ModelProvider' for an IRigidModelProvider service. More...

#include <model/IRigidModelProvider.h>

Public Member Functions

 IRigidModelConsumer ()
 
virtual ~IRigidModelConsumer ()
 
template<typename Reflector >
void reflect (Reflector &r)
 Reflect method for serialization. More...
 
void setModelProvider (ServiceProperty service)
 
virtual std::string getModelProviderChannel ()
 

Protected Member Functions

void initialize ()
 Must be called in service's initialize() method, after initializing mModelProvider. More...
 
virtual void setModelProviderInternal (ServiceProperty service)=0
 Must be implemented in subclasses and must set mModelProvider. More...
 
virtual AuthoritygetAuthority ()=0
 Must be implemented and return a valid authority. More...
 
virtual std::string getModelProviderChannelInternal ()
 Can be implemented in subclasses to override the default channel name "<namespace/of/service>/ModelProvider". More...
 

Protected Attributes

ServiceProperty mModelProvider
 
Channel< std::string > mModelProviderChannel
 

Detailed Description

IRigidModelConsumer is a unit that has a ServiceProperty 'ModelProvider' for an IRigidModelProvider service.

Constructor & Destructor Documentation

◆ IRigidModelConsumer()

IRigidModelConsumer ( )
inline

◆ ~IRigidModelConsumer()

virtual ~IRigidModelConsumer ( )
inlinevirtual

Member Function Documentation

◆ reflect()

void reflect ( Reflector &  r)
inline

Reflect method for serialization.

◆ setModelProvider()

void setModelProvider ( ServiceProperty  service)

◆ getModelProviderChannel()

virtual std::string getModelProviderChannel ( )
virtual

◆ initialize()

void initialize ( )
protected

Must be called in service's initialize() method, after initializing mModelProvider.

◆ setModelProviderInternal()

virtual void setModelProviderInternal ( ServiceProperty  service)
protectedpure virtual

Must be implemented in subclasses and must set mModelProvider.

◆ getAuthority()

virtual Authority* getAuthority ( )
protectedpure virtual

Must be implemented and return a valid authority.

◆ getModelProviderChannelInternal()

virtual std::string getModelProviderChannelInternal ( )
protectedvirtual

Can be implemented in subclasses to override the default channel name "<namespace/of/service>/ModelProvider".

The service will post the new ModelProvider name to this channel whenever it is changed.

Member Data Documentation

◆ mModelProvider

ServiceProperty mModelProvider
protected

◆ mModelProviderChannel

Channel<std::string> mModelProviderChannel
protected

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