Multi-clock aggregator and switch.

Summary

---

Exposes a single ~IClock(1,2) interface while internally hosting multiple subclocks. All IClock(1,2) operations (conversions, scheduling) are delegated to the *currently active* subclock selected by activeClockIndex. The active clock can be changed at runtime (e.g., to switch gPTP time domains).

Semantics

---

• Delegation: getClockTime(), scheduleClockEventAt/After(), cancel, and the conversion helpers are forwarded to clock[activeClockIndex] at the moment the call is made.
• Time continuity: switching may introduce a discontinuity in the exposed clock time if subclocks are not aligned. Client modules that assume a monotone clock should handle such discontinuities (e.g., via lower/upper bound handling or by listening for timeChanged).

Typical use

---

• Multi-domain gPTP: run one subclock per gPTP domain and switch the active one according to best-master selection or policy.

<b>See also:</b> ~MultiDomainGptp

Usage diagram

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram

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

Extends

Name	Type	Description
Module	compound module	Base module for all INET compound modules.

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	""	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
numClocks	int		Number of subclocks
activeClockIndex	int	0	Currently active subclock (0..numClocks-1)

Properties

Name	Value	Description
class	MultiClock
display	i=block/timer

Signals

Name	Type	Unit	Description
timeChanged	simtime_t

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode	Description
timeChanged	Clock time	localSignal(timeChanged)	vector	s	linear

Source code

//
// Multi-clock aggregator and switch.
//
// Summary
// -------
// Exposes a single ~IClock interface while internally hosting multiple
// subclocks. All IClock operations (conversions, scheduling) are delegated to
// the *currently active* subclock selected by `activeClockIndex`. The active
// clock can be changed at runtime (e.g., to switch gPTP time domains).
//
// Semantics
// ---------
// - Delegation: getClockTime(), scheduleClockEventAt/After(), cancel, and the
//   conversion helpers are forwarded to clock[activeClockIndex] at the moment
//   the call is made.
// - Time continuity: switching may introduce a discontinuity in the exposed
//   clock time if subclocks are not aligned. Client modules that assume a
//   monotone clock should handle such discontinuities (e.g., via lower/upper
//   bound handling or by listening for `timeChanged`).
//
// Typical use
// -----------
// - Multi-domain gPTP: run one subclock per gPTP domain and switch the active
//   one according to best-master selection or policy.
//
// @see ~MultiDomainGptp
//
module MultiClock extends Module like IClock
{
    parameters:
        int numClocks;                                // Number of subclocks
        int activeClockIndex @mutable = default(0);   // Currently active subclock (0..numClocks-1)
        @display("i=block/timer");
        @class(MultiClock);
        @signal[timeChanged](type=simtime_t);
        @statistic[timeChanged](title="Clock time"; source=localSignal(timeChanged); record=vector; interpolationmode=linear; unit=s);
    submodules:
        clock[numClocks]: <default("SettableClock")> like IClock {
            @display("p=200,200,row,200");
        }
}

File: src/inet/clock/model/MultiClock.ned

---

This documentation is released under the Creative Commons license