OpenDaVINCI  4.15.3
odcontext::base::SystemReportingComponent Class Referenceabstract

#include <SystemReportingComponent.h>

Inheritance diagram for odcontext::base::SystemReportingComponent:
Inheritance graph

Public Member Functions

virtual ~SystemReportingComponent ()
 
virtual void report (const odcore::wrapper::Time &t)=0
 
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
 

Protected Member Functions

 SystemReportingComponent ()
 

Detailed Description

This interface can be used to compute reporting data.

Constructor & Destructor Documentation

odcontext::base::SystemReportingComponent::SystemReportingComponent ( )
protected

Protected constructor to enforce subclasses.

odcontext::base::SystemReportingComponent::~SystemReportingComponent ( )
virtual

Member Function Documentation

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

This method returns the FIFO containing received containers.

Returns
FIFO containing received containers.

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

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

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

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::SystemReportingComponent::report ( const odcore::wrapper::Time t)
pure virtual

This method is called whenever any application component was activated to validate the new situation.

Parameters
tCurrent system time.

Implemented in odcontext::base::RecordingContainer.

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

This method is called to tear down this component.

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

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