OpenDaVINCI  4.16.0
odcontext::base::RuntimeEnvironment Class Reference

#include <RuntimeEnvironment.h>

Public Member Functions

 RuntimeEnvironment ()
 
virtual ~RuntimeEnvironment ()
 
void add (odcore::base::module::TimeTriggeredConferenceClientModule &ttccm)
 
void add (SystemFeedbackComponent &sfc)
 
void add (SystemReportingComponent &src)
 
uint32_t getGreatestTimeStep () const
 
vector
< odcore::base::module::TimeTriggeredConferenceClientModule * > 
getListOfTimeTriggeredConferenceClientModules ()
 
vector< SystemFeedbackComponent * > getListOfSystemFeedbackComponents ()
 
vector
< SystemReportingComponent * > 
getListOfSystemReportingComponents ()
 
void beginExecution ()
 
bool isValid () const
 
bool isExecuting () const
 

Detailed Description

This class describes a runtime environment. A runtime environment consists of several ConferenceClientModules and a SystemContext.

Constructor & Destructor Documentation

odcontext::base::RuntimeEnvironment::RuntimeEnvironment ( )
odcontext::base::RuntimeEnvironment::~RuntimeEnvironment ( )
virtual

Member Function Documentation

void odcontext::base::RuntimeEnvironment::add ( odcore::base::module::TimeTriggeredConferenceClientModule ttccm)

This method adds another TimeTriggeredConferenceClientModule to be executed.

Parameters
ttccmTimeTriggeredConferenceClientModule to be executed.

References isExecuting().

Referenced by odcontext::base::StandaloneRuntimeControl::add().

void odcontext::base::RuntimeEnvironment::add ( SystemFeedbackComponent sfc)

This method adds another SystemFeedbackComponent to be executed.

Parameters
sfcSystemFeedbackComponent to be executed.

References isExecuting().

void odcontext::base::RuntimeEnvironment::add ( SystemReportingComponent src)

This method adds another SystemReportingComponent to be executed.

Parameters
srcSystemReportingComponent to be executed.

References isExecuting().

void odcontext::base::RuntimeEnvironment::beginExecution ( )

This method disallows the further adding of ConferenceClientModules or SystemContexts.

Referenced by odcontext::base::RuntimeControl::run().

uint32_t odcontext::base::RuntimeEnvironment::getGreatestTimeStep ( ) const

This method returns the greatest possible time step or DEFAULT_TIMESTEP if all getFrequency()-calls return 0.

Returns
Greatest possible time step among all added ConferenceClientModules and SystemContexts.

References odcontext::base::TimeConstants::ONE_SECOND_IN_MILLISECONDS.

Referenced by odcontext::base::RuntimeControl::run().

vector< SystemFeedbackComponent * > odcontext::base::RuntimeEnvironment::getListOfSystemFeedbackComponents ( )

This method returns the list of added SystemFeedbackComponents.

Returns
List of added SystemFeedbackComponents.

Referenced by odcontext::base::RuntimeControl::run(), odcontext::base::RuntimeControl::setupSystemContextComponents(), and odcontext::base::RuntimeControl::tearDownSystemContextComponents().

vector< SystemReportingComponent * > odcontext::base::RuntimeEnvironment::getListOfSystemReportingComponents ( )

This method returns the list of added SystemReportingComponents.

Returns
List of added SystemReportingComponents.

Referenced by odcontext::base::RuntimeControl::tearDownSystemContextComponents().

vector< odcore::base::module::TimeTriggeredConferenceClientModule * > odcontext::base::RuntimeEnvironment::getListOfTimeTriggeredConferenceClientModules ( )

This method returns the list of added TimeTriggeredConferenceClientModules.

Returns
List of added TimeTriggeredConferenceClientModules.
bool odcontext::base::RuntimeEnvironment::isExecuting ( ) const

This method returns true if this runtime environment is currently executed.

Returns
True if this RuntimeEnvironment is executed.

Referenced by add(), and odcontext::base::RuntimeControl::tearDownSystemContextComponents().

bool odcontext::base::RuntimeEnvironment::isValid ( ) const

This method returns true, if the lists of ConferenceClientModules and SystemContexts contain at least one entry, respectively.

Returns
true or false (see above).

Referenced by odcontext::base::RuntimeControl::run(), and odcontext::base::RuntimeControl::tearDownSystemContextComponents().