DC_DummyObsClock Class Reference

#include <DC_DummyObsClock.h>

Inheritance diagram for DC_DummyObsClock:

List of all members.

Detailed Description

Dummy OBS Clock component useful for testing purposes or for applications where timing information is not available.

This component provides a dummy implementation of the OBS Clock abstract class. It exposes a method setTime through which an external entity can set the on-board time and the on-board cycle. These values are then returned by the standard timing services declared by the OBS Clock abstract base class. No timing synchronization service is implemented.

A dummy clock can be useful because the correct configuration of the CC_RootObject class requires the class to be provided with an OBS Clock plug-in component. This dummy component can be used when no "real" OBS Clock component is available (for instance, during testing).

Author:: Alessandro Pasetti (P&P Software GmbH)

Version:: 1.0

Definition at line 32 of file DC_DummyObsClock.h.

Public Member Functions

DC_DummyObsClock (void)

Reset the OBS Clock component and set the class identifier.

virtual TD_ObsTime getTime (void)

Return the on-board time last set with setTime.

virtual TD_ObsCycle getCycle (void)

Return the on-board cycle last set with setTime.

virtual void synchronizeWithSystemTime (void)

No synchronization service is implemented: method returns without taking any action.

virtual void reset (void)

Reset the OBS clock by resetting the on-board time and cycle to zero.

void setTime (TD_ObsTime time)

Set the value of the on-board time that will be returned by method getTime and getCycle.

void setCycle (TD_ObsCycle cycle)

Set the value of the cycle that will be returned by method getCycle.

Constructor & Destructor Documentation

DC_DummyObsClock::DC_DummyObsClock ( void )

Reset the OBS Clock component and set the class identifier.

See also:
reset

Definition at line 16 of file DC_DummyObsClock.cpp.

Member Function Documentation

TD_ObsCycle DC_DummyObsClock::getCycle ( void ) [virtual]

Return the on-board cycle last set with setTime.

See also:
setTime

Returns:
the current on-board cycle

Implements ObsClock.
Definition at line 25 of file DC_DummyObsClock.cpp.

TD_ObsTime DC_DummyObsClock::getTime ( void ) [virtual]

Return the on-board time last set with setTime.

See also:
setTime

Returns:
the current on-board time

Implements ObsClock.
Definition at line 21 of file DC_DummyObsClock.cpp.

void DC_DummyObsClock::setCycle ( TD_ObsCycle cycle )

Set the value of the cycle that will be returned by method getCycle.
The cycle value must be zero or a positive numbers.
See also:
getCycle

Parameters:

time the on-board time

cycle the on-board cycle

Definition at line 34 of file DC_DummyObsClock.cpp.

void DC_DummyObsClock::setTime ( TD_ObsTime time )

Set the value of the on-board time that will be returned by method getTime and getCycle.
The on-board time value must be zero or a positive number.
See also:
getTime

Parameters:

time the on-board time

Definition at line 29 of file DC_DummyObsClock.cpp.

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


Public Member Functions
	DC_DummyObsClock (void)
	Reset the OBS Clock component and set the class identifier.
virtual TD_ObsTime	getTime (void)
	Return the on-board time last set with `setTime`.
virtual TD_ObsCycle	getCycle (void)
	Return the on-board cycle last set with `setTime`.
virtual void	synchronizeWithSystemTime (void)
	No synchronization service is implemented: method returns without taking any action.
virtual void	reset (void)
	Reset the OBS clock by resetting the on-board time and cycle to zero.
void	setTime (TD_ObsTime time)
	Set the value of the on-board time that will be returned by method `getTime` and `getCycle`.
void	setCycle (TD_ObsCycle cycle)
	Set the value of the cycle that will be returned by method `getCycle`.