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

#include <Svc/Version/Version.hpp>

Inheritance diagram for Svc::Version:
Svc::VersionComponentBase Fw::PassiveComponentBase Fw::ObjBase

Public Member Functions

 Version (const char *const compName)
 Construct Version object. More...
 
 ~Version ()
 Destroy Version object. More...
 
void config (bool enable)
 configure version's verbosity and startup More...
 
- Public Member Functions inherited from Svc::VersionComponentBase
void init (FwEnumStoreType instance=0)
 Initialize VersionComponentBase object. More...
 
Fw::InputCmdPortget_cmdIn_InputPort (FwIndexType portNum)
 
Svc::InputVersionPortget_getVersion_InputPort (FwIndexType portNum)
 
Svc::InputVersionPortget_setVersion_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_logOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
 Connect port to logOut[portNum]. More...
 
void set_timeCaller_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
 Connect port to timeCaller[portNum]. More...
 
void set_tlmOut_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port)
 Connect port to tlmOut[portNum]. More...
 
void regCommands ()
 Register commands with the Command Dispatcher. More...
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base. More...
 
U32 getIdBase () const
 

Additional Inherited Members

- Protected Types inherited from Svc::VersionComponentBase
enum  { NUM_CMDIN_INPUT_PORTS = 1 }
 Enumerations for numbers of special input ports. More...
 
enum  { NUM_GETVERSION_INPUT_PORTS = 1 , NUM_SETVERSION_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  {
  NUM_CMDREGOUT_OUTPUT_PORTS = 1 , NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1 , NUM_LOGOUT_OUTPUT_PORTS = 1 , NUM_LOGTEXTOUT_OUTPUT_PORTS = 1 ,
  NUM_TIMECALLER_OUTPUT_PORTS = 1 , NUM_TLMOUT_OUTPUT_PORTS = 1
}
 Enumerations for numbers of special output ports. More...
 
enum  { OPCODE_ENABLE = 0x0 , OPCODE_VERSION = 0x1 }
 Command opcodes. More...
 
enum  { EVENTID_FRAMEWORKVERSION = 0x0 , EVENTID_PROJECTVERSION = 0x1 , EVENTID_LIBRARYVERSIONS = 0x2 , EVENTID_CUSTOMVERSIONS = 0x3 }
 Event IDs. More...
 
enum  {
  CHANNELID_FRAMEWORKVERSION = 0x0 , CHANNELID_PROJECTVERSION = 0x1 , CHANNELID_CUSTOMVERSION01 = 0x2 , CHANNELID_CUSTOMVERSION02 = 0x3 ,
  CHANNELID_CUSTOMVERSION03 = 0x4 , CHANNELID_CUSTOMVERSION04 = 0x5 , CHANNELID_CUSTOMVERSION05 = 0x6 , CHANNELID_CUSTOMVERSION06 = 0x7 ,
  CHANNELID_CUSTOMVERSION07 = 0x8 , CHANNELID_CUSTOMVERSION08 = 0x9 , CHANNELID_CUSTOMVERSION09 = 0xa , CHANNELID_CUSTOMVERSION10 = 0xb ,
  CHANNELID_LIBRARYVERSION01 = 0xc , CHANNELID_LIBRARYVERSION02 = 0xd , CHANNELID_LIBRARYVERSION03 = 0xe , CHANNELID_LIBRARYVERSION04 = 0xf ,
  CHANNELID_LIBRARYVERSION05 = 0x10 , CHANNELID_LIBRARYVERSION06 = 0x11 , CHANNELID_LIBRARYVERSION07 = 0x12 , CHANNELID_LIBRARYVERSION08 = 0x13 ,
  CHANNELID_LIBRARYVERSION09 = 0x14 , CHANNELID_LIBRARYVERSION10 = 0x15
}
 Channel IDs. More...
 
- Protected Member Functions inherited from Svc::VersionComponentBase
 VersionComponentBase (const char *compName="")
 Construct VersionComponentBase object. More...
 
virtual ~VersionComponentBase ()
 Destroy VersionComponentBase object. More...
 
FwIndexType getNum_cmdIn_InputPorts () const
 
FwIndexType getNum_getVersion_InputPorts () const
 
FwIndexType getNum_setVersion_InputPorts () const
 
FwIndexType getNum_cmdRegOut_OutputPorts () const
 
FwIndexType getNum_cmdResponseOut_OutputPorts () const
 
FwIndexType getNum_logOut_OutputPorts () const
 
FwIndexType getNum_timeCaller_OutputPorts () const
 
FwIndexType getNum_tlmOut_OutputPorts () const
 
bool isConnected_cmdRegOut_OutputPort (FwIndexType portNum)
 
bool isConnected_cmdResponseOut_OutputPort (FwIndexType portNum)
 
bool isConnected_logOut_OutputPort (FwIndexType portNum)
 
bool isConnected_timeCaller_OutputPort (FwIndexType portNum)
 
bool isConnected_tlmOut_OutputPort (FwIndexType portNum)
 
void getVersion_handlerBase (FwIndexType portNum, const Svc::VersionCfg::VersionEnum &version_id, Fw::StringBase &version_string, Svc::VersionStatus &status)
 Handler base-class function for input port getVersion. More...
 
void setVersion_handlerBase (FwIndexType portNum, const Svc::VersionCfg::VersionEnum &version_id, Fw::StringBase &version_string, Svc::VersionStatus &status)
 Handler base-class function for input port setVersion. More...
 
void cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
 Emit command response. More...
 
void ENABLE_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
void VERSION_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
void log_ACTIVITY_LO_FrameworkVersion (const Fw::StringBase &version)
 
void log_ACTIVITY_LO_ProjectVersion (const Fw::StringBase &version)
 
void log_ACTIVITY_LO_LibraryVersions (const Fw::StringBase &version)
 
void log_ACTIVITY_LO_CustomVersions (Svc::VersionCfg::VersionEnum version_enum, const Fw::StringBase &version_value)
 
void tlmWrite_FrameworkVersion (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_ProjectVersion (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CustomVersion01 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CustomVersion02 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel CustomVersion02. More...
 
void tlmWrite_CustomVersion03 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel CustomVersion03. More...
 
void tlmWrite_CustomVersion04 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel CustomVersion04. More...
 
void tlmWrite_CustomVersion05 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel CustomVersion05. More...
 
void tlmWrite_CustomVersion06 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel CustomVersion06. More...
 
void tlmWrite_CustomVersion07 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel CustomVersion07. More...
 
void tlmWrite_CustomVersion08 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel CustomVersion08. More...
 
void tlmWrite_CustomVersion09 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel CustomVersion09. More...
 
void tlmWrite_CustomVersion10 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel CustomVersion10. More...
 
void tlmWrite_LibraryVersion01 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_LibraryVersion02 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel LibraryVersion02. More...
 
void tlmWrite_LibraryVersion03 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel LibraryVersion03. More...
 
void tlmWrite_LibraryVersion04 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel LibraryVersion04. More...
 
void tlmWrite_LibraryVersion05 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel LibraryVersion05. More...
 
void tlmWrite_LibraryVersion06 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel LibraryVersion06. More...
 
void tlmWrite_LibraryVersion07 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel LibraryVersion07. More...
 
void tlmWrite_LibraryVersion08 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel LibraryVersion08. More...
 
void tlmWrite_LibraryVersion09 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel LibraryVersion09. More...
 
void tlmWrite_LibraryVersion10 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time())
 Write telemetry channel LibraryVersion10. More...
 
Fw::Time getTime ()
 
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 (NATIVE_INT_TYPE instance)
 Initialization function. More...
 
NATIVE_INT_TYPE 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 14 of file Version.hpp.

Constructor & Destructor Documentation

◆ Version()

Svc::Version::Version ( const char *const  compName)
explicit

Construct Version object.

Parameters
compNameThe component name

Definition at line 18 of file Version.cpp.

◆ ~Version()

Svc::Version::~Version ( )

Destroy Version object.

Definition at line 29 of file Version.cpp.

Member Function Documentation

◆ config()

void Svc::Version::config ( bool  enable)

configure version's verbosity and startup

Definition at line 31 of file Version.cpp.


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