inet::SimpleClockSynchronizer Class Reference

#include <SimpleClockSynchronizer.h>

Inheritance diagram for inet::SimpleClockSynchronizer:

Public Member Functions
virtual	~SimpleClockSynchronizer ()
Public Member Functions inherited from inet::ApplicationBase
	ApplicationBase ()
Public Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual	~OperationalMixin ()
	}@ More...
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Member Functions
virtual void	initialize (int stage) override
virtual void	handleMessageWhenUp (cMessage *msg) override
virtual void	handleStartOperation (LifecycleOperation *operation) override
virtual void	handleStopOperation (LifecycleOperation *operation) override
virtual void	handleCrashOperation (LifecycleOperation *operation) override
virtual void	synchronizeSlaveClock ()
virtual void	scheduleSynchronizationTimer ()
Protected Member Functions inherited from inet::ApplicationBase
virtual bool	isInitializeStage (int stage) const override
virtual bool	isModuleStartStage (int stage) const override
virtual bool	isModuleStopStage (int stage) const override
Protected Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual int	numInitStages () const override
virtual void	refreshDisplay () const override
virtual void	handleMessage (cMessage *msg) override
virtual void	handleMessageWhenDown (cMessage *msg)
virtual bool	handleOperationStage (LifecycleOperation *operation, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...
virtual State	getInitialOperationalState () const
	Returns initial operational state: OPERATING or NOT_OPERATING. More...
virtual void	handleActiveOperationTimeout (cMessage *message)
virtual bool	isUp () const
	utility functions More...
virtual bool	isDown () const
virtual void	setOperationalState (State newState)
virtual void	scheduleOperationTimeout (simtime_t timeout)
virtual void	setupActiveOperation (LifecycleOperation *operation, IDoneCallback *doneCallback, State)
virtual void	delayActiveOperationFinish (simtime_t timeout)
virtual void	startActiveOperationExtraTime (simtime_t delay=SIMTIME_ZERO)
virtual void	startActiveOperationExtraTimeOrFinish (simtime_t extraTime)
virtual void	finishActiveOperation ()

Protected Attributes
cMessage *	synhronizationTimer = nullptr
ModuleRefByPar< IClock >	masterClock
ModuleRefByPar< SettableClock >	slaveClock
cPar *	synchronizationIntervalParameter = nullptr
cPar *	synchronizationAccuracyParameter = nullptr
Protected Attributes inherited from inet::OperationalMixin< cSimpleModule >
State	operationalState
simtime_t	lastChange
Operation	activeOperation
cMessage *	activeOperationTimeout
cMessage *	activeOperationExtraTimer

Additional Inherited Members
Protected Types inherited from inet::OperationalMixin< cSimpleModule >
enum	State

Constructor & Destructor Documentation

~SimpleClockSynchronizer()

virtual inet::SimpleClockSynchronizer::~SimpleClockSynchronizer ( )

inlinevirtual

{ cancelAndDelete(synhronizationTimer); }

Member Function Documentation

handleCrashOperation()

virtual void inet::SimpleClockSynchronizer::handleCrashOperation ( LifecycleOperation *  operation )

inlineoverrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{ }

handleMessageWhenUp()

void inet::SimpleClockSynchronizer::handleMessageWhenUp ( cMessage *  msg )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    if (msg == synhronizationTimer) {
        synchronizeSlaveClock();
        scheduleSynchronizationTimer();
    }
    else
        throw cRuntimeError("Unknown message");
}

handleStartOperation()

void inet::SimpleClockSynchronizer::handleStartOperation ( LifecycleOperation *  operation )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    scheduleSynchronizationTimer();
}

handleStopOperation()

virtual void inet::SimpleClockSynchronizer::handleStopOperation ( LifecycleOperation *  operation )

inlineoverrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{ }

initialize()

void inet::SimpleClockSynchronizer::initialize ( int  stage )

overrideprotectedvirtual

Reimplemented from inet::OperationalMixin< cSimpleModule >.

{
    ApplicationBase::initialize(stage);
    if (stage == INITSTAGE_LOCAL) {
        synhronizationTimer = new cMessage("SynchronizationTimer");
        masterClock.reference(this, "masterClockModule", true);
        slaveClock.reference(this, "slaveClockModule", true);
        synchronizationIntervalParameter = &par("synchronizationInterval");
        synchronizationAccuracyParameter = &par("synchronizationAccuracy");
    }
}

scheduleSynchronizationTimer()

void inet::SimpleClockSynchronizer::scheduleSynchronizationTimer ( )

protectedvirtual

{
    scheduleAfter(synchronizationIntervalParameter->doubleValue(), synhronizationTimer);
}

Referenced by handleMessageWhenUp(), and handleStartOperation().

synchronizeSlaveClock()

void inet::SimpleClockSynchronizer::synchronizeSlaveClock ( )

protectedvirtual

{
    slaveClock->setClockTime(masterClock->getClockTime() + synchronizationAccuracyParameter->doubleValue(), true);
}

Referenced by handleMessageWhenUp().

Member Data Documentation

masterClock

ModuleRefByPar<IClock> inet::SimpleClockSynchronizer::masterClock

protected

Referenced by initialize(), and synchronizeSlaveClock().

slaveClock

ModuleRefByPar<SettableClock> inet::SimpleClockSynchronizer::slaveClock

protected

Referenced by initialize(), and synchronizeSlaveClock().

synchronizationAccuracyParameter

cPar* inet::SimpleClockSynchronizer::synchronizationAccuracyParameter = nullptr

protected

Referenced by initialize(), and synchronizeSlaveClock().

synchronizationIntervalParameter

cPar* inet::SimpleClockSynchronizer::synchronizationIntervalParameter = nullptr

protected

Referenced by initialize(), and scheduleSynchronizationTimer().

synhronizationTimer

cMessage* inet::SimpleClockSynchronizer::synhronizationTimer = nullptr

protected

Referenced by handleMessageWhenUp(), initialize(), and scheduleSynchronizationTimer().

---

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

• SimpleClockSynchronizer.h
• SimpleClockSynchronizer.cc