ClockBase

compound module

This is a base module for clocks.

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Known subclasses

Name	Type	Description
IdealClock	compound module	Models a clock where the clock time is identical to the simulation time.
OscillatorBasedClock	compound module	(no description)

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	"%t"	determines the text that is written on top of the submodule
referenceClock	string	""	full path of reference clock
emitClockTimeInterval	double	0s	non-zero value means the clock time will be emitted periodically

Properties

Name	Value	Description
class	ClockBase
display	i=block/timer

Signals

Name	Type	Unit
timeChanged	simtime_t

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode
timeChanged	Clock time		vector		linear

Source code

//
// This is a base module for clocks.
//
module ClockBase
{
    parameters:
        string displayStringTextFormat = default("%t"); // determines the text that is written on top of the submodule
        string referenceClock = default("");			// full path of reference clock
        double emitClockTimeInterval @unit(s) = default(0s); // non-zero value means the clock time will be emitted periodically
        @class(ClockBase);
        @display("i=block/timer");
        @signal[timeChanged](type=simtime_t);
        @statistic[timeChanged](title="Clock time"; record=vector; interpolationmode=linear);
}

File: src/inet/clock/base/ClockBase.ned