F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Svc::OsTime Class Referencefinal

#include <Svc/OsTime/OsTime.hpp>

Inheritance diagram for Svc::OsTime:
Svc::OsTimeComponentBase Fw::PassiveComponentBase Fw::ObjBase

Public Member Functions

 OsTime (const char *const compName)
 Construct OsTime object. More...
 
 ~OsTime ()
 Destroy OsTime object. More...
 
void set_epoch (const Fw::Time &fw_time, const Os::RawTime &os_time)
 
- Public Member Functions inherited from Svc::OsTimeComponentBase
void init (FwEnumStoreType instance=0)
 Initialize OsTimeComponentBase object. More...
 
Fw::InputCmdPortget_CmdDisp_InputPort (FwIndexType portNum)
 
Svc::InputOsTimeEpochPortget_setEpoch_InputPort (FwIndexType portNum)
 
Fw::InputTimePortget_timeGetPort_InputPort (FwIndexType portNum)
 
void set_CmdReg_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port)
 Connect port to CmdReg[portNum]. More...
 
void set_CmdStatus_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
 Connect port to CmdStatus[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
 

Additional Inherited Members

- Protected Types inherited from Svc::OsTimeComponentBase
enum  { NUM_CMDDISP_INPUT_PORTS = 1 }
 Enumerations for numbers of special input ports. More...
 
enum  { NUM_SETEPOCH_INPUT_PORTS = 1, NUM_TIMEGETPORT_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  {
  NUM_CMDREG_OUTPUT_PORTS = 1, NUM_CMDSTATUS_OUTPUT_PORTS = 1, NUM_EVENTOUT_OUTPUT_PORTS = 1, NUM_LOGTEXT_OUTPUT_PORTS = 1,
  NUM_TIMECALLER_OUTPUT_PORTS = 1
}
 Enumerations for numbers of special output ports. More...
 
enum  { OPCODE_SETCURRENTTIME = 0x0 }
 Command opcodes. More...
 
enum  { EVENTID_SETCURRENTTIMEERROR = 0x0 }
 Event IDs. More...
 
- Protected Member Functions inherited from Svc::OsTimeComponentBase
 OsTimeComponentBase (const char *compName="")
 Construct OsTimeComponentBase object. More...
 
virtual ~OsTimeComponentBase ()
 Destroy OsTimeComponentBase object. More...
 
FwIndexType getNum_CmdDisp_InputPorts () const
 
FwIndexType getNum_setEpoch_InputPorts () const
 
FwIndexType getNum_timeGetPort_InputPorts () const
 
FwIndexType getNum_CmdReg_OutputPorts () const
 
FwIndexType getNum_CmdStatus_OutputPorts () const
 
FwIndexType getNum_EventOut_OutputPorts () const
 
FwIndexType getNum_timeCaller_OutputPorts () const
 
bool isConnected_CmdReg_OutputPort (FwIndexType portNum)
 
bool isConnected_CmdStatus_OutputPort (FwIndexType portNum)
 
bool isConnected_EventOut_OutputPort (FwIndexType portNum)
 
bool isConnected_timeCaller_OutputPort (FwIndexType portNum)
 
void setEpoch_handlerBase (FwIndexType portNum, const Fw::Time &fw_time, const Os::RawTime &os_time)
 Handler base-class function for input port setEpoch. More...
 
void timeGetPort_handlerBase (FwIndexType portNum, Fw::Time &time)
 Handler base-class function for input port timeGetPort. More...
 
void cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
 Emit command response. More...
 
void SetCurrentTime_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 Base-class handler function for command SetCurrentTime. More...
 
void log_WARNING_HI_SetCurrentTimeError (U32 status) const
 
Fw::Time getTime () const
 
- 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...
 

Detailed Description

Definition at line 18 of file OsTime.hpp.

Constructor & Destructor Documentation

◆ OsTime()

Svc::OsTime::OsTime ( const char *const  compName)

Construct OsTime object.

Parameters
compNameThe component name

Definition at line 18 of file OsTime.cpp.

◆ ~OsTime()

Svc::OsTime::~OsTime ( )

Destroy OsTime object.

Definition at line 26 of file OsTime.cpp.

Member Function Documentation

◆ set_epoch()

void Svc::OsTime::set_epoch ( const Fw::Time fw_time,
const Os::RawTime os_time 
)

Set an epoch time that is used to offset future Os::RawTime readings

Definition at line 29 of file OsTime.cpp.


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