![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for Version component. More...
#include <Svc/Version/VersionComponentAc.hpp>
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... | |
![]() | |
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 |
![]() | |
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... | |
Auto-generated base for Version component.
Definition at line 37 of file VersionComponentAc.hpp.
|
protected |
Enumerations for numbers of special input ports.
Enumerator | |
---|---|
NUM_CMDIN_INPUT_PORTS |
Definition at line 55 of file VersionComponentAc.hpp.
|
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.
|
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.
|
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.
|
protected |
|
protected |
Channel IDs.
Definition at line 90 of file VersionComponentAc.hpp.
|
protected |
Construct VersionComponentBase object.
compName | The component name |
Definition at line 467 of file VersionComponentAc.cpp.
|
protectedvirtual |
Destroy VersionComponentBase object.
Definition at line 474 of file VersionComponentAc.cpp.
|
protected |
Emit command response.
opCode | The opcode |
cmdSeq | The command sequence number |
response | The command response |
Definition at line 692 of file VersionComponentAc.cpp.
|
protectedpure virtual |
Handler for command ENABLE
A command to enable or disable Event verbosity and Telemetry
opCode | The opcode |
cmdSeq | The command sequence number |
enable | whether or not Version telemetry is enabled |
|
protected |
Base-class handler function for command ENABLE
A command to enable or disable Event verbosity and Telemetry
opCode | The opcode |
cmdSeq | The command sequence number |
args | The command argument buffer |
Definition at line 709 of file VersionComponentAc.cpp.
Fw::InputCmdPort * Svc::VersionComponentBase::get_cmdIn_InputPort | ( | FwIndexType | portNum | ) |
Get special input port at index
portNum | The port number |
Definition at line 220 of file VersionComponentAc.cpp.
Svc::InputVersionPort * Svc::VersionComponentBase::get_getVersion_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 235 of file VersionComponentAc.cpp.
Svc::InputVersionPort * Svc::VersionComponentBase::get_setVersion_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 246 of file VersionComponentAc.cpp.
|
protected |
Get the number of cmdIn input ports
Definition at line 484 of file VersionComponentAc.cpp.
|
protected |
Get the number of cmdRegOut output ports
Definition at line 510 of file VersionComponentAc.cpp.
|
protected |
Get the number of cmdResponseOut output ports
Definition at line 516 of file VersionComponentAc.cpp.
|
protected |
Get the number of getVersion input ports
Definition at line 494 of file VersionComponentAc.cpp.
|
protected |
Get the number of logOut output ports
Definition at line 522 of file VersionComponentAc.cpp.
|
protected |
Get the number of setVersion input ports
Definition at line 500 of file VersionComponentAc.cpp.
|
protected |
Get the number of timeCaller output ports
Definition at line 538 of file VersionComponentAc.cpp.
|
protected |
Get the number of tlmOut output ports
Definition at line 544 of file VersionComponentAc.cpp.
|
protected |
|
protectedpure virtual |
Handler for input port getVersion.
portNum | The port number |
version_id | The entry to access |
version_string | The value to be passed |
status | The command response argument |
|
protected |
Handler base-class function for input port getVersion.
portNum | The port number |
version_id | The entry to access |
version_string | The value to be passed |
status | The command response argument |
Definition at line 630 of file VersionComponentAc.cpp.
void Svc::VersionComponentBase::init | ( | FwEnumStoreType | instance = 0 | ) |
Initialize VersionComponentBase object.
instance | The instance number |
Definition at line 21 of file VersionComponentAc.cpp.
|
protected |
Check whether port cmdRegOut is connected
portNum | The port number |
Definition at line 554 of file VersionComponentAc.cpp.
|
protected |
Check whether port cmdResponseOut is connected
portNum | The port number |
Definition at line 565 of file VersionComponentAc.cpp.
|
protected |
Check whether port logOut is connected
portNum | The port number |
Definition at line 576 of file VersionComponentAc.cpp.
|
protected |
Check whether port timeCaller is connected
portNum | The port number |
Definition at line 602 of file VersionComponentAc.cpp.
|
protected |
Check whether port tlmOut is connected
portNum | The port number |
Definition at line 613 of file VersionComponentAc.cpp.
|
protectedvirtual |
Lock the guarded mutex.
Definition at line 1880 of file VersionComponentAc.cpp.
|
protected |
Log event CustomVersions
Version of the git repository.
version_enum | The enum to access |
version_value | version |
Definition at line 1031 of file VersionComponentAc.cpp.
|
protected |
Log event FrameworkVersion
Version of the git repository.
version | version string |
Definition at line 815 of file VersionComponentAc.cpp.
|
protected |
Log event LibraryVersions
Version of the git repository.
version | version string |
Definition at line 959 of file VersionComponentAc.cpp.
|
protected |
Log event ProjectVersion
Version of the git repository.
version | version string |
Definition at line 887 of file VersionComponentAc.cpp.
void Svc::VersionComponentBase::regCommands | ( | ) |
Register commands with the Command Dispatcher.
Connect the dispatcher first
Definition at line 449 of file VersionComponentAc.cpp.
void Svc::VersionComponentBase::set_cmdRegOut_OutputPort | ( | FwIndexType | portNum, |
Fw::InputCmdRegPort * | port | ||
) |
Connect port to cmdRegOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 261 of file VersionComponentAc.cpp.
void Svc::VersionComponentBase::set_cmdResponseOut_OutputPort | ( | FwIndexType | portNum, |
Fw::InputCmdResponsePort * | port | ||
) |
Connect port to cmdResponseOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 275 of file VersionComponentAc.cpp.
void Svc::VersionComponentBase::set_logOut_OutputPort | ( | FwIndexType | portNum, |
Fw::InputLogPort * | port | ||
) |
Connect port to logOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 289 of file VersionComponentAc.cpp.
void Svc::VersionComponentBase::set_timeCaller_OutputPort | ( | FwIndexType | portNum, |
Fw::InputTimePort * | port | ||
) |
Connect port to timeCaller[portNum].
portNum | The port number |
port | The input port |
Definition at line 321 of file VersionComponentAc.cpp.
void Svc::VersionComponentBase::set_tlmOut_OutputPort | ( | FwIndexType | portNum, |
Fw::InputTlmPort * | port | ||
) |
Connect port to tlmOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 335 of file VersionComponentAc.cpp.
|
protectedpure virtual |
Handler for input port setVersion.
portNum | The port number |
version_id | The entry to access |
version_string | The value to be passed |
status | The command response argument |
|
protected |
Handler base-class function for input port setVersion.
portNum | The port number |
version_id | The entry to access |
version_string | The value to be passed |
status | The command response argument |
Definition at line 659 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel CustomVersion01
Custom Versions
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1196 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel CustomVersion02.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1229 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel CustomVersion03.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1262 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel CustomVersion04.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1295 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel CustomVersion05.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1328 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel CustomVersion06.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1361 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel CustomVersion07.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1394 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel CustomVersion08.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1427 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel CustomVersion09.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1460 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel CustomVersion10.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1493 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel FrameworkVersion
Software framework version
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1130 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel LibraryVersion01
Library Versions
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1526 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel LibraryVersion02.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1559 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel LibraryVersion03.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1592 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel LibraryVersion04.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1625 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel LibraryVersion05.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1658 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel LibraryVersion06.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1691 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel LibraryVersion07.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1724 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel LibraryVersion08.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1757 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel LibraryVersion09.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1790 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel LibraryVersion10.
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1823 of file VersionComponentAc.cpp.
|
protected |
Write telemetry channel ProjectVersion
Software project version
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1163 of file VersionComponentAc.cpp.
|
protectedvirtual |
Unlock the guarded mutex.
Definition at line 1886 of file VersionComponentAc.cpp.
|
protectedpure virtual |
Handler for command VERSION
Report version as Event
opCode | The opcode |
cmdSeq | The command sequence number |
version_type | which version type Event is requested |
|
protected |
Base-class handler function for command VERSION
Report version as Event
opCode | The opcode |
cmdSeq | The command sequence number |
args | The command argument buffer |
Definition at line 760 of file VersionComponentAc.cpp.
|
friend |
Friend class for white-box testing.
Definition at line 46 of file VersionComponentAc.hpp.