Svc::TimeConverterComponentBase Class Reference

Auto-generated base for TimeConverter component. More...

#include <Svc/TimeConverter/TimeConverterComponentAc.hpp>

Inheritance diagram for Svc::TimeConverterComponentBase:

Public Member Functions
void	init (FwEnumStoreType instance=0)
	Initialize TimeConverterComponentBase object. More...
Fw::InputCmdPort *	get_cmdIn_InputPort (FwIndexType portNum)
Svc::InputConvertTimePort *	get_convertTime_InputPort (FwIndexType portNum)
Svc::InputTimeOffsetSendPort *	get_offsetUpdate_InputPort (FwIndexType portNum)
void	set_cmdRegOut_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port)
	Connect port to cmdRegOut[portNum]. More...
void	set_cmdResponseOut_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
	Connect port to cmdResponseOut[portNum]. More...
void	set_eventOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
	Connect port to eventOut[portNum]. More...
void	set_timeCaller_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
	Connect port to timeCaller[portNum]. More...
void	regCommands ()
	Register commands with the Command Dispatcher. More...
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const FwIdType)
	Set the ID base. More...
FwIdType	getIdBase () const
virtual void	deinit ()
	Deinitialization function. More...

Protected Types
enum	{ NUM_CMDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of special input ports. More...
enum	{ NUM_CONVERTTIME_INPUT_PORTS = 1, NUM_OFFSETUPDATE_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...
enum	{   NUM_CMDREGOUT_OUTPUT_PORTS = 1, NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1, NUM_EVENTOUT_OUTPUT_PORTS = 1, NUM_TEXTEVENTOUT_OUTPUT_PORTS = 1,   NUM_TIMECALLER_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...
enum	{ OPCODE_SET_OFFSET = 0x0, OPCODE_CLEAR_OFFSETS = 0x1, OPCODE_GET_OFFSET = 0x2, OPCODE_DUMP_OFFSETS = 0x3 }
	Command opcodes. More...
enum	{   EVENTID_NOCONVERSIONAVAILABLE = 0x0, EVENTID_INVALIDTIME = 0x1, EVENTID_OFFSETSET = 0x2, EVENTID_OFFSETTABLEFULL = 0x3,   EVENTID_OFFSETSCLEARED = 0x4, EVENTID_OFFSETREPORT = 0x5, EVENTID_NOOFFSETSTORED = 0x6, EVENTID_OFFSETTABLEEMPTY = 0x7,   EVENTID_IDENTICALTIMEBASES = 0x8, EVENTID_OFFSETOUTOFRANGE = 0x9, EVENTID_UNUSABLETIMEBASE = 0xa }
	Event IDs. More...
enum	{   EVENTID_NOCONVERSIONAVAILABLE_THROTTLE = 5, EVENTID_INVALIDTIME_THROTTLE = 5, EVENTID_OFFSETTABLEFULL_THROTTLE = 5, EVENTID_IDENTICALTIMEBASES_THROTTLE = 5,   EVENTID_OFFSETOUTOFRANGE_THROTTLE = 5, EVENTID_UNUSABLETIMEBASE_THROTTLE = 5 }
	Event throttle values: sets initial value of countdown variables. More...

Protected Member Functions
	TimeConverterComponentBase (const char *compName="")
	Construct TimeConverterComponentBase object. More...
virtual	~TimeConverterComponentBase ()
	Destroy TimeConverterComponentBase object. More...
bool	isConnected_cmdRegOut_OutputPort (FwIndexType portNum) const
bool	isConnected_cmdResponseOut_OutputPort (FwIndexType portNum) const
bool	isConnected_eventOut_OutputPort (FwIndexType portNum) const
bool	isConnected_timeCaller_OutputPort (FwIndexType portNum) const
void	cmdIn_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
	Handler base-class function for input port cmdIn. More...
virtual Svc::ConvertTimeStatus	convertTime_handler (FwIndexType portNum, const Fw::Time &in_time, Fw::Time &out_time)=0
	Handler for input port convertTime. More...
virtual void	offsetUpdate_handler (FwIndexType portNum, const Svc::TimeOffset &offset)=0
	Handler for input port offsetUpdate. More...
Svc::ConvertTimeStatus	convertTime_handlerBase (FwIndexType portNum, const Fw::Time &in_time, Fw::Time &out_time)
	Handler base-class function for input port convertTime. More...
void	offsetUpdate_handlerBase (FwIndexType portNum, const Svc::TimeOffset &offset)
	Handler base-class function for input port offsetUpdate. More...
void	cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
	Emit command response. More...
virtual void	SET_OFFSET_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const TimeBase &from, const TimeBase &to, I64 offset_us)=0
virtual void	CLEAR_OFFSETS_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
virtual void	GET_OFFSET_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const TimeBase &from, const TimeBase &to)=0
virtual void	DUMP_OFFSETS_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
void	SET_OFFSET_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	CLEAR_OFFSETS_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	GET_OFFSET_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	DUMP_OFFSETS_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	log_WARNING_LO_NoConversionAvailable (const TimeBase &in_tb, const TimeBase &out_tb)
void	log_WARNING_LO_InvalidTime (const TimeBase &in_tb, const TimeBase &out_tb, I64 offset_us, I64 in_time_us)
void	log_ACTIVITY_HI_OffsetSet (const TimeBase &from, const TimeBase &to, I64 offset_us) const
void	log_WARNING_HI_OffsetTableFull (const TimeBase &from, const TimeBase &to, U32 capacity)
void	log_ACTIVITY_HI_OffsetsCleared (U32 entries) const
void	log_ACTIVITY_HI_OffsetReport (const TimeBase &from, const TimeBase &to, I64 offset_us) const
void	log_WARNING_LO_NoOffsetStored (const TimeBase &from, const TimeBase &to) const
void	log_ACTIVITY_HI_OffsetTableEmpty () const
void	log_WARNING_LO_IdenticalTimeBases (const TimeBase &tb)
void	log_WARNING_HI_OffsetOutOfRange (const TimeBase &from, const TimeBase &to, I64 offset_us)
void	log_WARNING_HI_UnusableTimeBase (const TimeBase &tb)
void	log_WARNING_LO_NoConversionAvailable_ThrottleClear ()
	Reset throttle value for NoConversionAvailable. More...
void	log_WARNING_LO_InvalidTime_ThrottleClear ()
	Reset throttle value for InvalidTime. More...
void	log_WARNING_HI_OffsetTableFull_ThrottleClear ()
	Reset throttle value for OffsetTableFull. More...
void	log_WARNING_LO_IdenticalTimeBases_ThrottleClear ()
	Reset throttle value for IdenticalTimeBases. More...
void	log_WARNING_HI_OffsetOutOfRange_ThrottleClear ()
	Reset throttle value for OffsetOutOfRange. More...
void	log_WARNING_HI_UnusableTimeBase_ThrottleClear ()
	Reset throttle value for UnusableTimeBase. More...
Fw::Time	getTime () const
virtual void	lock ()
	Lock the guarded mutex. More...
virtual void	unLock ()
	Unlock the guarded mutex. More...
Protected Member Functions inherited from Fw::PassiveComponentBase
	PassiveComponentBase (const char *name)
	Named constructor. More...
virtual	~PassiveComponentBase ()
	Destructor. More...
void	init (FwEnumStoreType instance)
	Initialization function. More...
FwEnumStoreType	getInstance () const
Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor. More...
virtual	~ObjBase ()
	Destructor. More...
void	init ()
	Object initializer. More...

Static Protected Member Functions
static constexpr FwIndexType	getNum_cmdIn_InputPorts ()
static constexpr FwIndexType	getNum_convertTime_InputPorts ()
static constexpr FwIndexType	getNum_offsetUpdate_InputPorts ()
static constexpr FwIndexType	getNum_cmdRegOut_OutputPorts ()
static constexpr FwIndexType	getNum_cmdResponseOut_OutputPorts ()
static constexpr FwIndexType	getNum_eventOut_OutputPorts ()
static constexpr FwIndexType	getNum_timeCaller_OutputPorts ()

Friends
class	TimeConverterTesterBase
	Friend class tester to support autocoded test harness. More...
class	TimeConverterTester
	Friend class tester implementation to support white-box testing. More...

Detailed Description

Auto-generated base for TimeConverter component.

Converts Fw::Time objects between time bases using offsets supplied at runtime

Definition at line 39 of file TimeConverterComponentAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDIN_INPUT_PORTS

Definition at line 59 of file TimeConverterComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_CONVERTTIME_INPUT_PORTS
NUM_OFFSETUPDATE_INPUT_PORTS

Definition at line 64 of file TimeConverterComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_CMDREGOUT_OUTPUT_PORTS
NUM_CMDRESPONSEOUT_OUTPUT_PORTS
NUM_EVENTOUT_OUTPUT_PORTS
NUM_TEXTEVENTOUT_OUTPUT_PORTS
NUM_TIMECALLER_OUTPUT_PORTS

Definition at line 70 of file TimeConverterComponentAc.hpp.

anonymous enum

anonymous enum

protected

Command opcodes.

Enumerator
OPCODE_SET_OFFSET	Set the offset between a pair of time bases.
OPCODE_CLEAR_OFFSETS	Discard every stored offset.
OPCODE_GET_OFFSET	Report the offset stored for a pair of time bases as an event.
OPCODE_DUMP_OFFSETS	Report every stored offset as events.

Definition at line 79 of file TimeConverterComponentAc.hpp.

anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_NOCONVERSIONAVAILABLE	No offset is stored for the requested pair of time bases.
EVENTID_INVALIDTIME	Conversion result is not representable as an Fw::Time.
EVENTID_OFFSETSET	An offset was stored for a pair of time bases by command.
EVENTID_OFFSETTABLEFULL	An offset could not be stored because the offset table is full.
EVENTID_OFFSETSCLEARED	Every stored offset was discarded.
EVENTID_OFFSETREPORT	Report of a stored offset.
EVENTID_NOOFFSETSTORED	No offset is stored for the requested pair of time bases.
EVENTID_OFFSETTABLEEMPTY	The offset table holds no entries.
EVENTID_IDENTICALTIMEBASES	An offset was supplied for a single time base rather than a pair.
EVENTID_OFFSETOUTOFRANGE	An offset was rejected because no time can be shifted that far.
EVENTID_UNUSABLETIMEBASE	A time base that denotes no clock was supplied as an end of a pair.

Definition at line 87 of file TimeConverterComponentAc.hpp.

anonymous enum

anonymous enum

protected

Event throttle values: sets initial value of countdown variables.

Enumerator
EVENTID_NOCONVERSIONAVAILABLE_THROTTLE	Throttle reset count for NoConversionAvailable.
EVENTID_INVALIDTIME_THROTTLE	Throttle reset count for InvalidTime.
EVENTID_OFFSETTABLEFULL_THROTTLE	Throttle reset count for OffsetTableFull.
EVENTID_IDENTICALTIMEBASES_THROTTLE	Throttle reset count for IdenticalTimeBases.
EVENTID_OFFSETOUTOFRANGE_THROTTLE	Throttle reset count for OffsetOutOfRange.
EVENTID_UNUSABLETIMEBASE_THROTTLE	Throttle reset count for UnusableTimeBase.

Definition at line 102 of file TimeConverterComponentAc.hpp.

Constructor & Destructor Documentation

TimeConverterComponentBase()

Svc::TimeConverterComponentBase::TimeConverterComponentBase ( const char *  compName = "" )

protected

Construct TimeConverterComponentBase object.

Parameters

compName

The component name

Definition at line 458 of file TimeConverterComponentAc.cpp.

~TimeConverterComponentBase()

Svc::TimeConverterComponentBase::~TimeConverterComponentBase ( )

protectedvirtual

Destroy TimeConverterComponentBase object.

Definition at line 470 of file TimeConverterComponentAc.cpp.

Member Function Documentation

CLEAR_OFFSETS_cmdHandler()

virtual void Svc::TimeConverterComponentBase::CLEAR_OFFSETS_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedpure virtual

Handler for command CLEAR_OFFSETS

Discard every stored offset

Parameters

opCode	The opcode
cmdSeq	The command sequence number

CLEAR_OFFSETS_cmdHandlerBase()

void Svc::TimeConverterComponentBase::CLEAR_OFFSETS_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command CLEAR_OFFSETS

Discard every stored offset

Parameters

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 770 of file TimeConverterComponentAc.cpp.

cmdIn_handlerBase()

void Svc::TimeConverterComponentBase::cmdIn_handlerBase ( FwIndexType  portNum, FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Handler base-class function for input port cmdIn.

Parameters

portNum	The port number
opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 549 of file TimeConverterComponentAc.cpp.

cmdResponse_out()

void Svc::TimeConverterComponentBase::cmdResponse_out ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdResponse  response  )

protected

Emit command response.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
response	The command response

Definition at line 670 of file TimeConverterComponentAc.cpp.

convertTime_handler()

virtual Svc::ConvertTimeStatus Svc::TimeConverterComponentBase::convertTime_handler ( FwIndexType  portNum, const Fw::Time &  in_time, Fw::Time &  out_time  )

protectedpure virtual

Handler for input port convertTime.

Parameters

portNum	The port number
in_time	time to convert
out_time	carries the requested time base in; carries the converted time out

convertTime_handlerBase()

Svc::ConvertTimeStatus Svc::TimeConverterComponentBase::convertTime_handlerBase ( FwIndexType  portNum, const Fw::Time &  in_time, Fw::Time &  out_time  )

protected

Handler base-class function for input port convertTime.

Parameters

portNum	The port number
in_time	time to convert
out_time	carries the requested time base in; carries the converted time out

Definition at line 610 of file TimeConverterComponentAc.cpp.

DUMP_OFFSETS_cmdHandler()

virtual void Svc::TimeConverterComponentBase::DUMP_OFFSETS_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedpure virtual

Handler for command DUMP_OFFSETS

Report every stored offset as events

Parameters

opCode	The opcode
cmdSeq	The command sequence number

DUMP_OFFSETS_cmdHandlerBase()

void Svc::TimeConverterComponentBase::DUMP_OFFSETS_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command DUMP_OFFSETS

Report every stored offset as events

Parameters

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 868 of file TimeConverterComponentAc.cpp.

get_cmdIn_InputPort()

Fw::InputCmdPort * Svc::TimeConverterComponentBase::get_cmdIn_InputPort

(

FwIndexType

portNum

)

Get special input port at index

Returns

cmdIn[portNum]

Parameters

portNum

The port number

Definition at line 217 of file TimeConverterComponentAc.cpp.

get_convertTime_InputPort()

Svc::InputConvertTimePort * Svc::TimeConverterComponentBase::get_convertTime_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

convertTime[portNum]

Parameters

portNum

The port number

Definition at line 236 of file TimeConverterComponentAc.cpp.

GET_OFFSET_cmdHandler()

virtual void Svc::TimeConverterComponentBase::GET_OFFSET_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq, const TimeBase &  from, const TimeBase &  to  )

protectedpure virtual

Handler for command GET_OFFSET

Report the offset stored for a pair of time bases as an event

Parameters

opCode	The opcode
cmdSeq	The command sequence number
from	time base the offset converts from
to	time base the offset converts to

GET_OFFSET_cmdHandlerBase()

void Svc::TimeConverterComponentBase::GET_OFFSET_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command GET_OFFSET

Report the offset stored for a pair of time bases as an event

Parameters

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 800 of file TimeConverterComponentAc.cpp.

get_offsetUpdate_InputPort()

Svc::InputTimeOffsetSendPort * Svc::TimeConverterComponentBase::get_offsetUpdate_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

offsetUpdate[portNum]

Parameters

portNum

The port number

Definition at line 247 of file TimeConverterComponentAc.cpp.

getNum_cmdIn_InputPorts()

static constexpr FwIndexType Svc::TimeConverterComponentBase::getNum_cmdIn_InputPorts ( )

inlinestaticprotected

Get the number of cmdIn input ports

Returns

The number of cmdIn input ports

Definition at line 285 of file TimeConverterComponentAc.hpp.

getNum_cmdRegOut_OutputPorts()

static constexpr FwIndexType Svc::TimeConverterComponentBase::getNum_cmdRegOut_OutputPorts ( )

inlinestaticprotected

Get the number of cmdRegOut output ports

Returns

The number of cmdRegOut output ports

Definition at line 318 of file TimeConverterComponentAc.hpp.

getNum_cmdResponseOut_OutputPorts()

static constexpr FwIndexType Svc::TimeConverterComponentBase::getNum_cmdResponseOut_OutputPorts ( )

inlinestaticprotected

Get the number of cmdResponseOut output ports

Returns

The number of cmdResponseOut output ports

Definition at line 325 of file TimeConverterComponentAc.hpp.

getNum_convertTime_InputPorts()

static constexpr FwIndexType Svc::TimeConverterComponentBase::getNum_convertTime_InputPorts ( )

inlinestaticprotected

Get the number of convertTime input ports

Returns

The number of convertTime input ports

Definition at line 298 of file TimeConverterComponentAc.hpp.

getNum_eventOut_OutputPorts()

static constexpr FwIndexType Svc::TimeConverterComponentBase::getNum_eventOut_OutputPorts ( )

inlinestaticprotected

Get the number of eventOut output ports

Returns

The number of eventOut output ports

Definition at line 332 of file TimeConverterComponentAc.hpp.

getNum_offsetUpdate_InputPorts()

static constexpr FwIndexType Svc::TimeConverterComponentBase::getNum_offsetUpdate_InputPorts ( )

inlinestaticprotected

Get the number of offsetUpdate input ports

Returns

The number of offsetUpdate input ports

Definition at line 305 of file TimeConverterComponentAc.hpp.

getNum_timeCaller_OutputPorts()

static constexpr FwIndexType Svc::TimeConverterComponentBase::getNum_timeCaller_OutputPorts ( )

inlinestaticprotected

Get the number of timeCaller output ports

Returns

The number of timeCaller output ports

Definition at line 350 of file TimeConverterComponentAc.hpp.

getTime()

Fw::Time Svc::TimeConverterComponentBase::getTime ( ) const

protected

Get the time

\return The current time

Definition at line 2174 of file TimeConverterComponentAc.cpp.

init()

void Svc::TimeConverterComponentBase::init

(

FwEnumStoreType

instance = 0

)

Initialize TimeConverterComponentBase object.

Parameters

instance

The instance number

Definition at line 21 of file TimeConverterComponentAc.cpp.

isConnected_cmdRegOut_OutputPort()

bool Svc::TimeConverterComponentBase::isConnected_cmdRegOut_OutputPort ( FwIndexType  portNum ) const

protected

Check whether port cmdRegOut is connected

Returns

Whether port cmdRegOut is connected

Parameters

portNum

The port number

Definition at line 482 of file TimeConverterComponentAc.cpp.

isConnected_cmdResponseOut_OutputPort()

bool Svc::TimeConverterComponentBase::isConnected_cmdResponseOut_OutputPort ( FwIndexType  portNum ) const

protected

Check whether port cmdResponseOut is connected

Returns

Whether port cmdResponseOut is connected

Parameters

portNum

The port number

Definition at line 493 of file TimeConverterComponentAc.cpp.

isConnected_eventOut_OutputPort()

bool Svc::TimeConverterComponentBase::isConnected_eventOut_OutputPort ( FwIndexType  portNum ) const

protected

Check whether port eventOut is connected

Returns

Whether port eventOut is connected

Parameters

portNum

The port number

Definition at line 504 of file TimeConverterComponentAc.cpp.

isConnected_timeCaller_OutputPort()

bool Svc::TimeConverterComponentBase::isConnected_timeCaller_OutputPort ( FwIndexType  portNum ) const

protected

Check whether port timeCaller is connected

Returns

Whether port timeCaller is connected

Parameters

portNum

The port number

Definition at line 530 of file TimeConverterComponentAc.cpp.

lock()

void Svc::TimeConverterComponentBase::lock ( )

protectedvirtual

Lock the guarded mutex.

Definition at line 2194 of file TimeConverterComponentAc.cpp.

log_ACTIVITY_HI_OffsetReport()

void Svc::TimeConverterComponentBase::log_ACTIVITY_HI_OffsetReport ( const TimeBase &  from, const TimeBase &  to, I64  offset_us  ) const

protected

Log event OffsetReport

Report of a stored offset

Parameters

from	time base the offset converts from
to	time base the offset converts to
offset_us	offset stored

Definition at line 1508 of file TimeConverterComponentAc.cpp.

log_ACTIVITY_HI_OffsetsCleared()

void Svc::TimeConverterComponentBase::log_ACTIVITY_HI_OffsetsCleared ( U32  entries ) const

protected

Log event OffsetsCleared

Every stored offset was discarded

Parameters

entries

number of entries discarded

Definition at line 1426 of file TimeConverterComponentAc.cpp.

log_ACTIVITY_HI_OffsetSet()

void Svc::TimeConverterComponentBase::log_ACTIVITY_HI_OffsetSet ( const TimeBase &  from, const TimeBase &  to, I64  offset_us  ) const

protected

Log event OffsetSet

An offset was stored for a pair of time bases by command

Parameters

from	time base the offset converts from
to	time base the offset converts to
offset_us	offset stored

Definition at line 1168 of file TimeConverterComponentAc.cpp.

log_ACTIVITY_HI_OffsetTableEmpty()

void Svc::TimeConverterComponentBase::log_ACTIVITY_HI_OffsetTableEmpty ( ) const

protected

Log event OffsetTableEmpty

The offset table holds no entries

Definition at line 1740 of file TimeConverterComponentAc.cpp.

log_WARNING_HI_OffsetOutOfRange()

void Svc::TimeConverterComponentBase::log_WARNING_HI_OffsetOutOfRange ( const TimeBase &  from, const TimeBase &  to, I64  offset_us  )

protected

Log event OffsetOutOfRange

An offset was rejected because no time can be shifted that far

Parameters

from	time base the offset converts from
to	time base the offset converts to
offset_us	offset supplied

Definition at line 1898 of file TimeConverterComponentAc.cpp.

log_WARNING_HI_OffsetOutOfRange_ThrottleClear()

void Svc::TimeConverterComponentBase::log_WARNING_HI_OffsetOutOfRange_ThrottleClear ( )

protected

Reset throttle value for OffsetOutOfRange.

Definition at line 2156 of file TimeConverterComponentAc.cpp.

log_WARNING_HI_OffsetTableFull()

void Svc::TimeConverterComponentBase::log_WARNING_HI_OffsetTableFull ( const TimeBase &  from, const TimeBase &  to, U32  capacity  )

protected

Log event OffsetTableFull

An offset could not be stored because the offset table is full

Parameters

from	time base the offset converts from
to	time base the offset converts to
capacity	configured offset table capacity

Definition at line 1293 of file TimeConverterComponentAc.cpp.

log_WARNING_HI_OffsetTableFull_ThrottleClear()

void Svc::TimeConverterComponentBase::log_WARNING_HI_OffsetTableFull_ThrottleClear ( )

protected

Reset throttle value for OffsetTableFull.

Definition at line 2142 of file TimeConverterComponentAc.cpp.

log_WARNING_HI_UnusableTimeBase()

void Svc::TimeConverterComponentBase::log_WARNING_HI_UnusableTimeBase ( const TimeBase &  tb )

protected

Log event UnusableTimeBase

A time base that denotes no clock was supplied as an end of a pair

Parameters

tb	time base supplied

Definition at line 2031 of file TimeConverterComponentAc.cpp.

log_WARNING_HI_UnusableTimeBase_ThrottleClear()

void Svc::TimeConverterComponentBase::log_WARNING_HI_UnusableTimeBase_ThrottleClear ( )

protected

Reset throttle value for UnusableTimeBase.

Definition at line 2163 of file TimeConverterComponentAc.cpp.

log_WARNING_LO_IdenticalTimeBases()

void Svc::TimeConverterComponentBase::log_WARNING_LO_IdenticalTimeBases ( const TimeBase &  tb )

protected

Log event IdenticalTimeBases

An offset was supplied for a single time base rather than a pair

Parameters

tb	time base supplied as both ends of the pair

Definition at line 1805 of file TimeConverterComponentAc.cpp.

log_WARNING_LO_IdenticalTimeBases_ThrottleClear()

void Svc::TimeConverterComponentBase::log_WARNING_LO_IdenticalTimeBases_ThrottleClear ( )

protected

Reset throttle value for IdenticalTimeBases.

Definition at line 2149 of file TimeConverterComponentAc.cpp.

log_WARNING_LO_InvalidTime()

void Svc::TimeConverterComponentBase::log_WARNING_LO_InvalidTime ( const TimeBase &  in_tb, const TimeBase &  out_tb, I64  offset_us, I64  in_time_us  )

protected

Log event InvalidTime

Conversion result is not representable as an Fw::Time

Parameters

in_tb	time base converted from
out_tb	time base converted to
offset_us	offset applied
in_time_us	time converted, in microseconds

Definition at line 1017 of file TimeConverterComponentAc.cpp.

log_WARNING_LO_InvalidTime_ThrottleClear()

void Svc::TimeConverterComponentBase::log_WARNING_LO_InvalidTime_ThrottleClear ( )

protected

Reset throttle value for InvalidTime.

Definition at line 2135 of file TimeConverterComponentAc.cpp.

log_WARNING_LO_NoConversionAvailable()

void Svc::TimeConverterComponentBase::log_WARNING_LO_NoConversionAvailable ( const TimeBase &  in_tb, const TimeBase &  out_tb  )

protected

Log event NoConversionAvailable

No offset is stored for the requested pair of time bases

Parameters

in_tb	time base converted from
out_tb	time base converted to

Definition at line 902 of file TimeConverterComponentAc.cpp.

log_WARNING_LO_NoConversionAvailable_ThrottleClear()

void Svc::TimeConverterComponentBase::log_WARNING_LO_NoConversionAvailable_ThrottleClear ( )

protected

Reset throttle value for NoConversionAvailable.

Definition at line 2128 of file TimeConverterComponentAc.cpp.

log_WARNING_LO_NoOffsetStored()

void Svc::TimeConverterComponentBase::log_WARNING_LO_NoOffsetStored ( const TimeBase &  from, const TimeBase &  to  ) const

protected

Log event NoOffsetStored

No offset is stored for the requested pair of time bases

Parameters

from	time base the offset converts from
to	time base the offset converts to

Definition at line 1633 of file TimeConverterComponentAc.cpp.

offsetUpdate_handler()

virtual void Svc::TimeConverterComponentBase::offsetUpdate_handler ( FwIndexType  portNum, const Svc::TimeOffset &  offset  )

protectedpure virtual

Handler for input port offsetUpdate.

Parameters

portNum

The port number

offsetUpdate_handlerBase()

void Svc::TimeConverterComponentBase::offsetUpdate_handlerBase ( FwIndexType  portNum, const Svc::TimeOffset &  offset  )

protected

Handler base-class function for input port offsetUpdate.

Parameters

portNum

The port number

Definition at line 641 of file TimeConverterComponentAc.cpp.

regCommands()

void Svc::TimeConverterComponentBase::regCommands

(

)

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 428 of file TimeConverterComponentAc.cpp.

set_cmdRegOut_OutputPort()

void Svc::TimeConverterComponentBase::set_cmdRegOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputCmdRegPort *	port
	)

Connect port to cmdRegOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 266 of file TimeConverterComponentAc.cpp.

set_cmdResponseOut_OutputPort()

void Svc::TimeConverterComponentBase::set_cmdResponseOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputCmdResponsePort *	port
	)

Connect port to cmdResponseOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 280 of file TimeConverterComponentAc.cpp.

set_eventOut_OutputPort()

void Svc::TimeConverterComponentBase::set_eventOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputLogPort *	port
	)

Connect port to eventOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 294 of file TimeConverterComponentAc.cpp.

SET_OFFSET_cmdHandler()

virtual void Svc::TimeConverterComponentBase::SET_OFFSET_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq, const TimeBase &  from, const TimeBase &  to, I64  offset_us  )

protectedpure virtual

Handler for command SET_OFFSET

Set the offset between a pair of time bases

Parameters

opCode	The opcode
cmdSeq	The command sequence number
from	time base the offset converts from
to	time base the offset converts to
offset_us	microseconds added to a "from" time to produce a "to" time

SET_OFFSET_cmdHandlerBase()

void Svc::TimeConverterComponentBase::SET_OFFSET_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command SET_OFFSET

Set the offset between a pair of time bases

Parameters

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 687 of file TimeConverterComponentAc.cpp.

set_timeCaller_OutputPort()

void Svc::TimeConverterComponentBase::set_timeCaller_OutputPort	(	FwIndexType	portNum,
		Fw::InputTimePort *	port
	)

Connect port to timeCaller[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 326 of file TimeConverterComponentAc.cpp.

unLock()

void Svc::TimeConverterComponentBase::unLock ( )

protectedvirtual

Unlock the guarded mutex.

Definition at line 2200 of file TimeConverterComponentAc.cpp.

Friends And Related Function Documentation

TimeConverterTester

friend class TimeConverterTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 50 of file TimeConverterComponentAc.hpp.

TimeConverterTesterBase

friend class TimeConverterTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 48 of file TimeConverterComponentAc.hpp.

---

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

• Svc/TimeConverter/TimeConverterComponentAc.hpp
• Svc/TimeConverter/TimeConverterComponentAc.cpp