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

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

#include <Svc/Version/VersionComponentAc.hpp>

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

Public Member Functions

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
 

Protected Types

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

 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)
 
virtual void getVersion_handler (FwIndexType portNum, const Svc::VersionCfg::VersionEnum &version_id, Fw::StringBase &version_string, Svc::VersionStatus &status)=0
 Handler for input port getVersion. More...
 
virtual void setVersion_handler (FwIndexType portNum, const Svc::VersionCfg::VersionEnum &version_id, Fw::StringBase &version_string, Svc::VersionStatus &status)=0
 Handler for input port setVersion. More...
 
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...
 
virtual void ENABLE_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, Svc::VersionEnabled enable)=0
 
virtual void VERSION_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, Svc::VersionType version_type)=0
 
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) const
 
void log_ACTIVITY_LO_ProjectVersion (const Fw::StringBase &version) const
 
void log_ACTIVITY_LO_LibraryVersions (const Fw::StringBase &version) const
 
void log_ACTIVITY_LO_CustomVersions (Svc::VersionCfg::VersionEnum version_enum, const Fw::StringBase &version_value) const
 
void tlmWrite_FrameworkVersion (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
 
void tlmWrite_ProjectVersion (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
 
void tlmWrite_CustomVersion01 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
 
void tlmWrite_CustomVersion02 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
 Write telemetry channel CustomVersion02. More...
 
void tlmWrite_CustomVersion03 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
 Write telemetry channel CustomVersion03. More...
 
void tlmWrite_CustomVersion04 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
 Write telemetry channel CustomVersion04. More...
 
void tlmWrite_CustomVersion05 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
 Write telemetry channel CustomVersion05. More...
 
void tlmWrite_CustomVersion06 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
 Write telemetry channel CustomVersion06. More...
 
void tlmWrite_CustomVersion07 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
 Write telemetry channel CustomVersion07. More...
 
void tlmWrite_CustomVersion08 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
 Write telemetry channel CustomVersion08. More...
 
void tlmWrite_CustomVersion09 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
 Write telemetry channel CustomVersion09. More...
 
void tlmWrite_CustomVersion10 (const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
 Write telemetry channel CustomVersion10. More...
 
void tlmWrite_LibraryVersion01 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
 
void tlmWrite_LibraryVersion02 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
 Write telemetry channel LibraryVersion02. More...
 
void tlmWrite_LibraryVersion03 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
 Write telemetry channel LibraryVersion03. More...
 
void tlmWrite_LibraryVersion04 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
 Write telemetry channel LibraryVersion04. More...
 
void tlmWrite_LibraryVersion05 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
 Write telemetry channel LibraryVersion05. More...
 
void tlmWrite_LibraryVersion06 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
 Write telemetry channel LibraryVersion06. More...
 
void tlmWrite_LibraryVersion07 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
 Write telemetry channel LibraryVersion07. More...
 
void tlmWrite_LibraryVersion08 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
 Write telemetry channel LibraryVersion08. More...
 
void tlmWrite_LibraryVersion09 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
 Write telemetry channel LibraryVersion09. More...
 
void tlmWrite_LibraryVersion10 (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
 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...
 

Friends

class VersionComponentBaseFriend
 Friend class for white-box testing. More...
 

Detailed Description

Auto-generated base for Version component.

Definition at line 37 of file VersionComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDIN_INPUT_PORTS 

Definition at line 55 of file VersionComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_GETVERSION_INPUT_PORTS 
NUM_SETVERSION_INPUT_PORTS 

Definition at line 60 of file VersionComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of special output ports.

Enumerator
NUM_CMDREGOUT_OUTPUT_PORTS 
NUM_CMDRESPONSEOUT_OUTPUT_PORTS 
NUM_LOGOUT_OUTPUT_PORTS 
NUM_LOGTEXTOUT_OUTPUT_PORTS 
NUM_TIMECALLER_OUTPUT_PORTS 
NUM_TLMOUT_OUTPUT_PORTS 

Definition at line 66 of file VersionComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Command opcodes.

Enumerator
OPCODE_ENABLE 

A command to enable or disable Event verbosity and Telemetry.

OPCODE_VERSION 

Report version as Event.

Definition at line 76 of file VersionComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Event IDs.

Enumerator
EVENTID_FRAMEWORKVERSION 

Version of the git repository.

EVENTID_PROJECTVERSION 

Version of the git repository.

EVENTID_LIBRARYVERSIONS 

Version of the git repository.

EVENTID_CUSTOMVERSIONS 

Version of the git repository.

Definition at line 82 of file VersionComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Channel IDs.

Enumerator
CHANNELID_FRAMEWORKVERSION 

Channel ID for FrameworkVersion.

CHANNELID_PROJECTVERSION 

Channel ID for ProjectVersion.

CHANNELID_CUSTOMVERSION01 

Channel ID for CustomVersion01.

CHANNELID_CUSTOMVERSION02 

Channel ID for CustomVersion02.

CHANNELID_CUSTOMVERSION03 

Channel ID for CustomVersion03.

CHANNELID_CUSTOMVERSION04 

Channel ID for CustomVersion04.

CHANNELID_CUSTOMVERSION05 

Channel ID for CustomVersion05.

CHANNELID_CUSTOMVERSION06 

Channel ID for CustomVersion06.

CHANNELID_CUSTOMVERSION07 

Channel ID for CustomVersion07.

CHANNELID_CUSTOMVERSION08 

Channel ID for CustomVersion08.

CHANNELID_CUSTOMVERSION09 

Channel ID for CustomVersion09.

CHANNELID_CUSTOMVERSION10 

Channel ID for CustomVersion10.

CHANNELID_LIBRARYVERSION01 

Channel ID for LibraryVersion01.

CHANNELID_LIBRARYVERSION02 

Channel ID for LibraryVersion02.

CHANNELID_LIBRARYVERSION03 

Channel ID for LibraryVersion03.

CHANNELID_LIBRARYVERSION04 

Channel ID for LibraryVersion04.

CHANNELID_LIBRARYVERSION05 

Channel ID for LibraryVersion05.

CHANNELID_LIBRARYVERSION06 

Channel ID for LibraryVersion06.

CHANNELID_LIBRARYVERSION07 

Channel ID for LibraryVersion07.

CHANNELID_LIBRARYVERSION08 

Channel ID for LibraryVersion08.

CHANNELID_LIBRARYVERSION09 

Channel ID for LibraryVersion09.

CHANNELID_LIBRARYVERSION10 

Channel ID for LibraryVersion10.

Definition at line 90 of file VersionComponentAc.hpp.

Constructor & Destructor Documentation

◆ VersionComponentBase()

Svc::VersionComponentBase::VersionComponentBase ( const char *  compName = "")
protected

Construct VersionComponentBase object.

Parameters
compNameThe component name

Definition at line 467 of file VersionComponentAc.cpp.

◆ ~VersionComponentBase()

Svc::VersionComponentBase::~VersionComponentBase ( )
protectedvirtual

Destroy VersionComponentBase object.

Definition at line 474 of file VersionComponentAc.cpp.

Member Function Documentation

◆ cmdResponse_out()

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

Emit command response.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
responseThe command response

Definition at line 692 of file VersionComponentAc.cpp.

◆ ENABLE_cmdHandler()

virtual void Svc::VersionComponentBase::ENABLE_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq,
Svc::VersionEnabled  enable 
)
protectedpure virtual

Handler for command ENABLE

A command to enable or disable Event verbosity and Telemetry

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
enablewhether or not Version telemetry is enabled

◆ ENABLE_cmdHandlerBase()

void Svc::VersionComponentBase::ENABLE_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command ENABLE

A command to enable or disable Event verbosity and Telemetry

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 709 of file VersionComponentAc.cpp.

◆ get_cmdIn_InputPort()

Fw::InputCmdPort * Svc::VersionComponentBase::get_cmdIn_InputPort ( FwIndexType  portNum)

Get special input port at index

Returns
cmdIn[portNum]
Parameters
portNumThe port number

Definition at line 220 of file VersionComponentAc.cpp.

◆ get_getVersion_InputPort()

Svc::InputVersionPort * Svc::VersionComponentBase::get_getVersion_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
getVersion[portNum]
Parameters
portNumThe port number

Definition at line 235 of file VersionComponentAc.cpp.

◆ get_setVersion_InputPort()

Svc::InputVersionPort * Svc::VersionComponentBase::get_setVersion_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
setVersion[portNum]
Parameters
portNumThe port number

Definition at line 246 of file VersionComponentAc.cpp.

◆ getNum_cmdIn_InputPorts()

FwIndexType Svc::VersionComponentBase::getNum_cmdIn_InputPorts ( ) const
protected

Get the number of cmdIn input ports

Returns
The number of cmdIn input ports

Definition at line 484 of file VersionComponentAc.cpp.

◆ getNum_cmdRegOut_OutputPorts()

FwIndexType Svc::VersionComponentBase::getNum_cmdRegOut_OutputPorts ( ) const
protected

Get the number of cmdRegOut output ports

Returns
The number of cmdRegOut output ports

Definition at line 510 of file VersionComponentAc.cpp.

◆ getNum_cmdResponseOut_OutputPorts()

FwIndexType Svc::VersionComponentBase::getNum_cmdResponseOut_OutputPorts ( ) const
protected

Get the number of cmdResponseOut output ports

Returns
The number of cmdResponseOut output ports

Definition at line 516 of file VersionComponentAc.cpp.

◆ getNum_getVersion_InputPorts()

FwIndexType Svc::VersionComponentBase::getNum_getVersion_InputPorts ( ) const
protected

Get the number of getVersion input ports

Returns
The number of getVersion input ports

Definition at line 494 of file VersionComponentAc.cpp.

◆ getNum_logOut_OutputPorts()

FwIndexType Svc::VersionComponentBase::getNum_logOut_OutputPorts ( ) const
protected

Get the number of logOut output ports

Returns
The number of logOut output ports

Definition at line 522 of file VersionComponentAc.cpp.

◆ getNum_setVersion_InputPorts()

FwIndexType Svc::VersionComponentBase::getNum_setVersion_InputPorts ( ) const
protected

Get the number of setVersion input ports

Returns
The number of setVersion input ports

Definition at line 500 of file VersionComponentAc.cpp.

◆ getNum_timeCaller_OutputPorts()

FwIndexType Svc::VersionComponentBase::getNum_timeCaller_OutputPorts ( ) const
protected

Get the number of timeCaller output ports

Returns
The number of timeCaller output ports

Definition at line 538 of file VersionComponentAc.cpp.

◆ getNum_tlmOut_OutputPorts()

FwIndexType Svc::VersionComponentBase::getNum_tlmOut_OutputPorts ( ) const
protected

Get the number of tlmOut output ports

Returns
The number of tlmOut output ports

Definition at line 544 of file VersionComponentAc.cpp.

◆ getTime()

Fw::Time Svc::VersionComponentBase::getTime ( )
protected

Get the time

\return The current time

Definition at line 1860 of file VersionComponentAc.cpp.

◆ getVersion_handler()

virtual void Svc::VersionComponentBase::getVersion_handler ( FwIndexType  portNum,
const Svc::VersionCfg::VersionEnum version_id,
Fw::StringBase version_string,
Svc::VersionStatus status 
)
protectedpure virtual

Handler for input port getVersion.

Parameters
portNumThe port number
version_idThe entry to access
version_stringThe value to be passed
statusThe command response argument

◆ getVersion_handlerBase()

void Svc::VersionComponentBase::getVersion_handlerBase ( FwIndexType  portNum,
const Svc::VersionCfg::VersionEnum version_id,
Fw::StringBase version_string,
Svc::VersionStatus status 
)
protected

Handler base-class function for input port getVersion.

Parameters
portNumThe port number
version_idThe entry to access
version_stringThe value to be passed
statusThe command response argument

Definition at line 630 of file VersionComponentAc.cpp.

◆ init()

void Svc::VersionComponentBase::init ( FwEnumStoreType  instance = 0)

Initialize VersionComponentBase object.

Parameters
instanceThe instance number

Definition at line 21 of file VersionComponentAc.cpp.

◆ isConnected_cmdRegOut_OutputPort()

bool Svc::VersionComponentBase::isConnected_cmdRegOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port cmdRegOut is connected

Returns
Whether port cmdRegOut is connected
Parameters
portNumThe port number

Definition at line 554 of file VersionComponentAc.cpp.

◆ isConnected_cmdResponseOut_OutputPort()

bool Svc::VersionComponentBase::isConnected_cmdResponseOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port cmdResponseOut is connected

Returns
Whether port cmdResponseOut is connected
Parameters
portNumThe port number

Definition at line 565 of file VersionComponentAc.cpp.

◆ isConnected_logOut_OutputPort()

bool Svc::VersionComponentBase::isConnected_logOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port logOut is connected

Returns
Whether port logOut is connected
Parameters
portNumThe port number

Definition at line 576 of file VersionComponentAc.cpp.

◆ isConnected_timeCaller_OutputPort()

bool Svc::VersionComponentBase::isConnected_timeCaller_OutputPort ( FwIndexType  portNum)
protected

Check whether port timeCaller is connected

Returns
Whether port timeCaller is connected
Parameters
portNumThe port number

Definition at line 602 of file VersionComponentAc.cpp.

◆ isConnected_tlmOut_OutputPort()

bool Svc::VersionComponentBase::isConnected_tlmOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port tlmOut is connected

Returns
Whether port tlmOut is connected
Parameters
portNumThe port number

Definition at line 613 of file VersionComponentAc.cpp.

◆ lock()

void Svc::VersionComponentBase::lock ( )
protectedvirtual

Lock the guarded mutex.

Definition at line 1880 of file VersionComponentAc.cpp.

◆ log_ACTIVITY_LO_CustomVersions()

void Svc::VersionComponentBase::log_ACTIVITY_LO_CustomVersions ( Svc::VersionCfg::VersionEnum  version_enum,
const Fw::StringBase version_value 
) const
protected

Log event CustomVersions

Version of the git repository.

Parameters
version_enumThe enum to access
version_valueversion

Definition at line 1031 of file VersionComponentAc.cpp.

◆ log_ACTIVITY_LO_FrameworkVersion()

void Svc::VersionComponentBase::log_ACTIVITY_LO_FrameworkVersion ( const Fw::StringBase version) const
protected

Log event FrameworkVersion

Version of the git repository.

Parameters
versionversion string

Definition at line 815 of file VersionComponentAc.cpp.

◆ log_ACTIVITY_LO_LibraryVersions()

void Svc::VersionComponentBase::log_ACTIVITY_LO_LibraryVersions ( const Fw::StringBase version) const
protected

Log event LibraryVersions

Version of the git repository.

Parameters
versionversion string

Definition at line 959 of file VersionComponentAc.cpp.

◆ log_ACTIVITY_LO_ProjectVersion()

void Svc::VersionComponentBase::log_ACTIVITY_LO_ProjectVersion ( const Fw::StringBase version) const
protected

Log event ProjectVersion

Version of the git repository.

Parameters
versionversion string

Definition at line 887 of file VersionComponentAc.cpp.

◆ regCommands()

void Svc::VersionComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 449 of file VersionComponentAc.cpp.

◆ set_cmdRegOut_OutputPort()

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

Connect port to cmdRegOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 261 of file VersionComponentAc.cpp.

◆ set_cmdResponseOut_OutputPort()

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

Connect port to cmdResponseOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 275 of file VersionComponentAc.cpp.

◆ set_logOut_OutputPort()

void Svc::VersionComponentBase::set_logOut_OutputPort ( FwIndexType  portNum,
Fw::InputLogPort port 
)

Connect port to logOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 289 of file VersionComponentAc.cpp.

◆ set_timeCaller_OutputPort()

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

Connect port to timeCaller[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 321 of file VersionComponentAc.cpp.

◆ set_tlmOut_OutputPort()

void Svc::VersionComponentBase::set_tlmOut_OutputPort ( FwIndexType  portNum,
Fw::InputTlmPort port 
)

Connect port to tlmOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 335 of file VersionComponentAc.cpp.

◆ setVersion_handler()

virtual void Svc::VersionComponentBase::setVersion_handler ( FwIndexType  portNum,
const Svc::VersionCfg::VersionEnum version_id,
Fw::StringBase version_string,
Svc::VersionStatus status 
)
protectedpure virtual

Handler for input port setVersion.

Parameters
portNumThe port number
version_idThe entry to access
version_stringThe value to be passed
statusThe command response argument

◆ setVersion_handlerBase()

void Svc::VersionComponentBase::setVersion_handlerBase ( FwIndexType  portNum,
const Svc::VersionCfg::VersionEnum version_id,
Fw::StringBase version_string,
Svc::VersionStatus status 
)
protected

Handler base-class function for input port setVersion.

Parameters
portNumThe port number
version_idThe entry to access
version_stringThe value to be passed
statusThe command response argument

Definition at line 659 of file VersionComponentAc.cpp.

◆ tlmWrite_CustomVersion01()

void Svc::VersionComponentBase::tlmWrite_CustomVersion01 ( const Svc::CustomVersionDb arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel CustomVersion01

Custom Versions

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1196 of file VersionComponentAc.cpp.

◆ tlmWrite_CustomVersion02()

void Svc::VersionComponentBase::tlmWrite_CustomVersion02 ( const Svc::CustomVersionDb arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel CustomVersion02.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1229 of file VersionComponentAc.cpp.

◆ tlmWrite_CustomVersion03()

void Svc::VersionComponentBase::tlmWrite_CustomVersion03 ( const Svc::CustomVersionDb arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel CustomVersion03.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1262 of file VersionComponentAc.cpp.

◆ tlmWrite_CustomVersion04()

void Svc::VersionComponentBase::tlmWrite_CustomVersion04 ( const Svc::CustomVersionDb arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel CustomVersion04.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1295 of file VersionComponentAc.cpp.

◆ tlmWrite_CustomVersion05()

void Svc::VersionComponentBase::tlmWrite_CustomVersion05 ( const Svc::CustomVersionDb arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel CustomVersion05.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1328 of file VersionComponentAc.cpp.

◆ tlmWrite_CustomVersion06()

void Svc::VersionComponentBase::tlmWrite_CustomVersion06 ( const Svc::CustomVersionDb arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel CustomVersion06.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1361 of file VersionComponentAc.cpp.

◆ tlmWrite_CustomVersion07()

void Svc::VersionComponentBase::tlmWrite_CustomVersion07 ( const Svc::CustomVersionDb arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel CustomVersion07.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1394 of file VersionComponentAc.cpp.

◆ tlmWrite_CustomVersion08()

void Svc::VersionComponentBase::tlmWrite_CustomVersion08 ( const Svc::CustomVersionDb arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel CustomVersion08.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1427 of file VersionComponentAc.cpp.

◆ tlmWrite_CustomVersion09()

void Svc::VersionComponentBase::tlmWrite_CustomVersion09 ( const Svc::CustomVersionDb arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel CustomVersion09.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1460 of file VersionComponentAc.cpp.

◆ tlmWrite_CustomVersion10()

void Svc::VersionComponentBase::tlmWrite_CustomVersion10 ( const Svc::CustomVersionDb arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel CustomVersion10.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1493 of file VersionComponentAc.cpp.

◆ tlmWrite_FrameworkVersion()

void Svc::VersionComponentBase::tlmWrite_FrameworkVersion ( const Fw::StringBase arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel FrameworkVersion

Software framework version

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1130 of file VersionComponentAc.cpp.

◆ tlmWrite_LibraryVersion01()

void Svc::VersionComponentBase::tlmWrite_LibraryVersion01 ( const Fw::StringBase arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel LibraryVersion01

Library Versions

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1526 of file VersionComponentAc.cpp.

◆ tlmWrite_LibraryVersion02()

void Svc::VersionComponentBase::tlmWrite_LibraryVersion02 ( const Fw::StringBase arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel LibraryVersion02.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1559 of file VersionComponentAc.cpp.

◆ tlmWrite_LibraryVersion03()

void Svc::VersionComponentBase::tlmWrite_LibraryVersion03 ( const Fw::StringBase arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel LibraryVersion03.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1592 of file VersionComponentAc.cpp.

◆ tlmWrite_LibraryVersion04()

void Svc::VersionComponentBase::tlmWrite_LibraryVersion04 ( const Fw::StringBase arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel LibraryVersion04.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1625 of file VersionComponentAc.cpp.

◆ tlmWrite_LibraryVersion05()

void Svc::VersionComponentBase::tlmWrite_LibraryVersion05 ( const Fw::StringBase arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel LibraryVersion05.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1658 of file VersionComponentAc.cpp.

◆ tlmWrite_LibraryVersion06()

void Svc::VersionComponentBase::tlmWrite_LibraryVersion06 ( const Fw::StringBase arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel LibraryVersion06.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1691 of file VersionComponentAc.cpp.

◆ tlmWrite_LibraryVersion07()

void Svc::VersionComponentBase::tlmWrite_LibraryVersion07 ( const Fw::StringBase arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel LibraryVersion07.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1724 of file VersionComponentAc.cpp.

◆ tlmWrite_LibraryVersion08()

void Svc::VersionComponentBase::tlmWrite_LibraryVersion08 ( const Fw::StringBase arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel LibraryVersion08.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1757 of file VersionComponentAc.cpp.

◆ tlmWrite_LibraryVersion09()

void Svc::VersionComponentBase::tlmWrite_LibraryVersion09 ( const Fw::StringBase arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel LibraryVersion09.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1790 of file VersionComponentAc.cpp.

◆ tlmWrite_LibraryVersion10()

void Svc::VersionComponentBase::tlmWrite_LibraryVersion10 ( const Fw::StringBase arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel LibraryVersion10.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1823 of file VersionComponentAc.cpp.

◆ tlmWrite_ProjectVersion()

void Svc::VersionComponentBase::tlmWrite_ProjectVersion ( const Fw::StringBase arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel ProjectVersion

Software project version

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1163 of file VersionComponentAc.cpp.

◆ unLock()

void Svc::VersionComponentBase::unLock ( )
protectedvirtual

Unlock the guarded mutex.

Definition at line 1886 of file VersionComponentAc.cpp.

◆ VERSION_cmdHandler()

virtual void Svc::VersionComponentBase::VERSION_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq,
Svc::VersionType  version_type 
)
protectedpure virtual

Handler for command VERSION

Report version as Event

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
version_typewhich version type Event is requested

◆ VERSION_cmdHandlerBase()

void Svc::VersionComponentBase::VERSION_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command VERSION

Report version as Event

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 760 of file VersionComponentAc.cpp.

Friends And Related Function Documentation

◆ VersionComponentBaseFriend

friend class VersionComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 46 of file VersionComponentAc.hpp.


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