OpenDaVINCI  4.15.3
odcontext::base::SystemContextComponent Class Referenceabstract

#include <SystemContextComponent.h>

Inheritance diagram for odcontext::base::SystemContextComponent:
Inheritance graph

Public Member Functions

virtual ~SystemContextComponent ()
 
virtual void setup ()=0
 
virtual void tearDown ()=0
 
virtual void nextContainer (odcore::data::Container &c)
 
odcore::base::FIFOQueuegetFIFO ()
 
odcore::base::KeyValueDataStoregetKeyValueDataStore ()
 
bool needsExecution (const odcore::wrapper::Time &t) const
 
virtual bool hasFinished () const
 
virtual float getFrequency () const =0
 

Protected Member Functions

 SystemContextComponent ()
 

Detailed Description

This class can be used to compute data for system's parts which can be either feedback or reporting components.

Constructor & Destructor Documentation

odcontext::base::SystemContextComponent::SystemContextComponent ( )
protected

Protected constructor to enforce subclasses.

References odcore::wrapper::KeyValueDatabaseFactory::createKeyValueDatabase().

odcontext::base::SystemContextComponent::~SystemContextComponent ( )
virtual

Member Function Documentation

odcore::base::FIFOQueue & odcontext::base::SystemContextComponent::getFIFO ( )

This method returns the FIFO containing received containers.

Returns
FIFO containing received containers.

Referenced by odcontext::base::RecordingContainer::report(), and odcontext::base::PlaybackContainer::step().

virtual float odcore::base::module::Periodic::getFrequency ( ) const
pure virtualinherited

This method returns the runtime frequency.

Returns
Runtime frequency.

Implemented in odcore::base::module::AbstractCIDModule.

Referenced by odcontext::base::Runner::needsExecution().

odcore::base::KeyValueDataStore & odcontext::base::SystemContextComponent::getKeyValueDataStore ( )

This method returns the key/value-data store.

Returns
Key/value-datastore.
bool odcontext::base::Runner::hasFinished ( ) const
virtualinherited

This method should be overridden in subclasses to add an additional condition to the time needsExecution indicating whether an application has finished. This implementation simply returns always true.

Returns
true.

Reimplemented in odcontext::base::TimeTriggeredConferenceClientModuleRunner.

Referenced by odcontext::base::Runner::needsExecution().

void odcontext::base::SystemContextComponent::nextContainer ( odcore::data::Container c)
virtual

This method is called whenever a new container occurs.

Parameters
cContainer that has been occured.

Implements odcore::io::conference::ContainerListener.

References odcore::base::FIFOQueue::add(), and odcore::data::Container::getDataType().

virtual void odcontext::base::SystemContextComponent::setup ( )
pure virtual
virtual void odcontext::base::SystemContextComponent::tearDown ( )
pure virtual

This method is called to tear down this component.

Implemented in odcontext::base::PlaybackContainer, and odcontext::base::RecordingContainer.

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