Svc::CmdSequencerComponentBase Class Reference

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

#include <Svc/CmdSequencer/CmdSequencerComponentAc.hpp>

Inheritance diagram for Svc::CmdSequencerComponentBase:

Public Member Functions
void	init (FwSizeType queueDepth, FwEnumStoreType instance=0)
	Initialize CmdSequencerComponentBase object. More...
Fw::InputCmdPort *	get_cmdIn_InputPort (FwIndexType portNum)
Fw::InputCmdResponsePort *	get_cmdResponseIn_InputPort (FwIndexType portNum)
Svc::InputPingPort *	get_pingIn_InputPort (FwIndexType portNum)
Svc::InputSchedPort *	get_schedIn_InputPort (FwIndexType portNum)
Svc::InputCmdSeqCancelPort *	get_seqCancelIn_InputPort (FwIndexType portNum)
Svc::InputCmdSeqInPort *	get_seqRunIn_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	set_comCmdOut_OutputPort (FwIndexType portNum, Fw::InputComPort *port)
	Connect port to comCmdOut[portNum]. More...
void	set_pingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port)
	Connect port to pingOut[portNum]. More...
void	set_seqDone_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
	Connect port to seqDone[portNum]. More...
void	set_seqStartOut_OutputPort (FwIndexType portNum, Svc::InputCmdSeqInPort *port)
	Connect port to seqStartOut[portNum]. More...
void	regCommands ()
	Register commands with the Command Dispatcher. More...
Public Member Functions inherited from Fw::ActiveComponentBase
void	start (Os::Task::ParamType priority=Os::Task::TASK_DEFAULT, Os::Task::ParamType stackSize=Os::Task::TASK_DEFAULT, Os::Task::ParamType cpuAffinity=Os::Task::TASK_DEFAULT, Os::Task::ParamType identifier=Os::Task::TASK_DEFAULT)
	called by instantiator when task is to be started More...
void	exit ()
	exit task in active component More...
Os::Task::Status	join ()
	Join the thread. More...
	DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()")
	Join to thread with discarded value_ptr. 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_CMDRESPONSEIN_INPUT_PORTS = 1, NUM_PINGIN_INPUT_PORTS = 1, NUM_SCHEDIN_INPUT_PORTS = 1, NUM_SEQCANCELIN_INPUT_PORTS = 1,   NUM_SEQRUNIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...
enum	{   NUM_LOGTEXT_OUTPUT_PORTS = 1, NUM_CMDREGOUT_OUTPUT_PORTS = 1, NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1, NUM_LOGOUT_OUTPUT_PORTS = 1,   NUM_TIMECALLER_OUTPUT_PORTS = 1, NUM_TLMOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...
enum	{ NUM_COMCMDOUT_OUTPUT_PORTS = 1, NUM_PINGOUT_OUTPUT_PORTS = 1, NUM_SEQDONE_OUTPUT_PORTS = 1, NUM_SEQSTARTOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...
enum	{   OPCODE_CS_RUN = 0x0, OPCODE_CS_VALIDATE = 0x1, OPCODE_CS_CANCEL = 0x2, OPCODE_CS_START = 0x3,   OPCODE_CS_STEP = 0x4, OPCODE_CS_AUTO = 0x5, OPCODE_CS_MANUAL = 0x6, OPCODE_CS_JOIN_WAIT = 0x7 }
	Command opcodes. More...
enum	{   EVENTID_CS_SEQUENCELOADED = 0x0, EVENTID_CS_SEQUENCECANCELED = 0x1, EVENTID_CS_FILEREADERROR = 0x2, EVENTID_CS_FILEINVALID = 0x3,   EVENTID_CS_RECORDINVALID = 0x4, EVENTID_CS_FILESIZEERROR = 0x5, EVENTID_CS_FILENOTFOUND = 0x6, EVENTID_CS_FILECRCFAILURE = 0x7,   EVENTID_CS_COMMANDCOMPLETE = 0x8, EVENTID_CS_SEQUENCECOMPLETE = 0x9, EVENTID_CS_COMMANDERROR = 0xa, EVENTID_CS_INVALIDMODE = 0xb,   EVENTID_CS_RECORDMISMATCH = 0xc, EVENTID_CS_TIMEBASEMISMATCH = 0xd, EVENTID_CS_TIMECONTEXTMISMATCH = 0xe, EVENTID_CS_PORTSEQUENCESTARTED = 0xf,   EVENTID_CS_UNEXPECTEDCOMPLETION = 0x10, EVENTID_CS_MODESWITCHED = 0x11, EVENTID_CS_NOSEQUENCEACTIVE = 0x12, EVENTID_CS_SEQUENCEVALID = 0x13,   EVENTID_CS_SEQUENCETIMEOUT = 0x14, EVENTID_CS_CMDSTEPPED = 0x15, EVENTID_CS_CMDSTARTED = 0x16, EVENTID_CS_JOINWAITING = 0x17,   EVENTID_CS_JOINWAITINGNOTCOMPLETE = 0x18, EVENTID_CS_NORECORDS = 0x19 }
	Event IDs. More...
enum	{   CHANNELID_CS_LOADCOMMANDS = 0x0, CHANNELID_CS_CANCELCOMMANDS = 0x1, CHANNELID_CS_ERRORS = 0x2, CHANNELID_CS_COMMANDSEXECUTED = 0x3,   CHANNELID_CS_SEQUENCESCOMPLETED = 0x4 }
	Channel IDs. More...
Protected Types inherited from Fw::ActiveComponentBase
enum	Lifecycle { CREATED, DISPATCHING, FINALIZING, DONE }
	Tracks the lifecycle of the component. More...

Protected Member Functions
	CmdSequencerComponentBase (const char *compName="")
	Construct CmdSequencerComponentBase object. More...
virtual	~CmdSequencerComponentBase ()
	Destroy CmdSequencerComponentBase object. More...
FwIndexType	getNum_cmdIn_InputPorts () const
FwIndexType	getNum_cmdResponseIn_InputPorts () const
FwIndexType	getNum_pingIn_InputPorts () const
FwIndexType	getNum_schedIn_InputPorts () const
FwIndexType	getNum_seqCancelIn_InputPorts () const
FwIndexType	getNum_seqRunIn_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
FwIndexType	getNum_comCmdOut_OutputPorts () const
FwIndexType	getNum_pingOut_OutputPorts () const
FwIndexType	getNum_seqDone_OutputPorts () const
FwIndexType	getNum_seqStartOut_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)
bool	isConnected_comCmdOut_OutputPort (FwIndexType portNum)
bool	isConnected_pingOut_OutputPort (FwIndexType portNum)
bool	isConnected_seqDone_OutputPort (FwIndexType portNum)
bool	isConnected_seqStartOut_OutputPort (FwIndexType portNum)
virtual void	cmdResponseIn_handler (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)=0
	Handler for input port cmdResponseIn. More...
virtual void	pingIn_handler (FwIndexType portNum, U32 key)=0
	Handler for input port pingIn. More...
virtual void	schedIn_handler (FwIndexType portNum, U32 context)=0
	Handler for input port schedIn. More...
virtual void	seqCancelIn_handler (FwIndexType portNum)=0
	Handler for input port seqCancelIn. More...
virtual void	seqRunIn_handler (FwIndexType portNum, const Fw::StringBase &filename)=0
	Handler for input port seqRunIn. More...
void	cmdResponseIn_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)
	Handler base-class function for input port cmdResponseIn. More...
void	pingIn_handlerBase (FwIndexType portNum, U32 key)
	Handler base-class function for input port pingIn. More...
void	schedIn_handlerBase (FwIndexType portNum, U32 context)
	Handler base-class function for input port schedIn. More...
void	seqCancelIn_handlerBase (FwIndexType portNum)
	Handler base-class function for input port seqCancelIn. More...
void	seqRunIn_handlerBase (FwIndexType portNum, const Fw::StringBase &filename)
	Handler base-class function for input port seqRunIn. More...
virtual void	cmdResponseIn_preMsgHook (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)
	Pre-message hook for async input port cmdResponseIn. More...
virtual void	pingIn_preMsgHook (FwIndexType portNum, U32 key)
	Pre-message hook for async input port pingIn. More...
virtual void	schedIn_preMsgHook (FwIndexType portNum, U32 context)
	Pre-message hook for async input port schedIn. More...
virtual void	seqCancelIn_preMsgHook (FwIndexType portNum)
	Pre-message hook for async input port seqCancelIn. More...
virtual void	seqRunIn_preMsgHook (FwIndexType portNum, const Fw::StringBase &filename)
	Pre-message hook for async input port seqRunIn. More...
void	comCmdOut_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
	Invoke output port comCmdOut. More...
void	pingOut_out (FwIndexType portNum, U32 key)
	Invoke output port pingOut. More...
void	seqDone_out (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)
	Invoke output port seqDone. More...
void	seqStartOut_out (FwIndexType portNum, const Fw::StringBase &filename)
	Invoke output port seqStartOut. More...
void	cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
	Emit command response. More...
virtual void	CS_RUN_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &fileName, Svc::CmdSequencer_BlockState block)=0
virtual void	CS_VALIDATE_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &fileName)=0
virtual void	CS_CANCEL_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
virtual void	CS_START_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
virtual void	CS_STEP_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
virtual void	CS_AUTO_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
virtual void	CS_MANUAL_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
virtual void	CS_JOIN_WAIT_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
void	CS_RUN_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	CS_VALIDATE_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	CS_CANCEL_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	CS_START_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	CS_STEP_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	CS_AUTO_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	CS_MANUAL_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	CS_JOIN_WAIT_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
virtual void	CS_RUN_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command CS_RUN. More...
virtual void	CS_VALIDATE_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command CS_VALIDATE. More...
virtual void	CS_CANCEL_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command CS_CANCEL. More...
virtual void	CS_START_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command CS_START. More...
virtual void	CS_STEP_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command CS_STEP. More...
virtual void	CS_AUTO_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command CS_AUTO. More...
virtual void	CS_MANUAL_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command CS_MANUAL. More...
virtual void	CS_JOIN_WAIT_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command CS_JOIN_WAIT. More...
void	log_ACTIVITY_LO_CS_SequenceLoaded (const Fw::StringBase &fileName) const
void	log_ACTIVITY_HI_CS_SequenceCanceled (const Fw::StringBase &fileName) const
void	log_WARNING_HI_CS_FileReadError (const Fw::StringBase &fileName) const
void	log_WARNING_HI_CS_FileInvalid (const Fw::StringBase &fileName, Svc::CmdSequencer_FileReadStage stage, I32 error) const
void	log_WARNING_HI_CS_RecordInvalid (const Fw::StringBase &fileName, U32 recordNumber, I32 error) const
void	log_WARNING_HI_CS_FileSizeError (const Fw::StringBase &fileName, U32 size) const
void	log_WARNING_HI_CS_FileNotFound (const Fw::StringBase &fileName) const
void	log_WARNING_HI_CS_FileCrcFailure (const Fw::StringBase &fileName, U32 storedCRC, U32 computedCRC) const
void	log_ACTIVITY_LO_CS_CommandComplete (const Fw::StringBase &fileName, U32 recordNumber, U32 opCode) const
void	log_ACTIVITY_HI_CS_SequenceComplete (const Fw::StringBase &fileName) const
void	log_WARNING_HI_CS_CommandError (const Fw::StringBase &fileName, U32 recordNumber, U32 opCode, U32 errorStatus) const
void	log_WARNING_HI_CS_InvalidMode () const
void	log_WARNING_HI_CS_RecordMismatch (const Fw::StringBase &fileName, U32 header_records, U32 extra_bytes) const
void	log_WARNING_HI_CS_TimeBaseMismatch (const Fw::StringBase &fileName, U16 time_base, U16 seq_time_base) const
void	log_WARNING_HI_CS_TimeContextMismatch (const Fw::StringBase &fileName, U8 currTimeBase, U8 seqTimeBase) const
void	log_ACTIVITY_HI_CS_PortSequenceStarted (const Fw::StringBase &filename) const
void	log_WARNING_HI_CS_UnexpectedCompletion (U32 opcode) const
void	log_ACTIVITY_HI_CS_ModeSwitched (Svc::CmdSequencer_SeqMode mode) const
void	log_WARNING_LO_CS_NoSequenceActive () const
void	log_ACTIVITY_HI_CS_SequenceValid (const Fw::StringBase &filename) const
void	log_WARNING_HI_CS_SequenceTimeout (const Fw::StringBase &filename, U32 command) const
void	log_ACTIVITY_HI_CS_CmdStepped (const Fw::StringBase &filename, U32 command) const
void	log_ACTIVITY_HI_CS_CmdStarted (const Fw::StringBase &filename) const
void	log_ACTIVITY_HI_CS_JoinWaiting (const Fw::StringBase &filename, U32 recordNumber, U32 opCode) const
void	log_WARNING_HI_CS_JoinWaitingNotComplete () const
void	log_WARNING_LO_CS_NoRecords (const Fw::StringBase &fileName) const
	Log event CS_NoRecords. More...
void	tlmWrite_CS_LoadCommands (U32 arg, Fw::Time _tlmTime=Fw::Time()) const
void	tlmWrite_CS_CancelCommands (U32 arg, Fw::Time _tlmTime=Fw::Time()) const
void	tlmWrite_CS_Errors (U32 arg, Fw::Time _tlmTime=Fw::Time()) const
void	tlmWrite_CS_CommandsExecuted (U32 arg, Fw::Time _tlmTime=Fw::Time()) const
void	tlmWrite_CS_SequencesCompleted (U32 arg, Fw::Time _tlmTime=Fw::Time()) const
Fw::Time	getTime ()
Protected Member Functions inherited from Fw::ActiveComponentBase
	ActiveComponentBase (const char *name)
	Constructor. More...
virtual	~ActiveComponentBase ()
	Destructor. More...
void	init (NATIVE_INT_TYPE instance)
	initialization code More...
virtual void	preamble ()
	A function that will be called before the event loop is entered. More...
MsgDispatchStatus	dispatch ()
	The function that will dispatching messages. More...
virtual void	finalizer ()
	A function that will be called after exiting the loop. More...
Protected Member Functions inherited from Fw::QueuedComponentBase
	QueuedComponentBase (const char *name)
	Constructor. More...
virtual	~QueuedComponentBase ()
	Destructor. More...
void	init (NATIVE_INT_TYPE instance)
	initialization function More...
Os::Queue::Status	createQueue (FwSizeType depth, FwSizeType msgSize)
NATIVE_INT_TYPE	getNumMsgsDropped ()
	return number of messages dropped More...
void	incNumMsgDropped ()
	increment the number of messages dropped 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	CmdSequencerComponentBaseFriend
	Friend class for white-box testing. More...

Additional Inherited Members
Public Types inherited from Fw::ActiveComponentBase
enum	{ ACTIVE_COMPONENT_EXIT }
Public Types inherited from Fw::QueuedComponentBase
enum	MsgDispatchStatus { MSG_DISPATCH_OK, MSG_DISPATCH_EMPTY, MSG_DISPATCH_ERROR, MSG_DISPATCH_EXIT }
Protected Attributes inherited from Fw::ActiveComponentBase
Os::Task	m_task
	task object for active component More...
Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue	m_queue
	queue object for active component More...

Detailed Description

Auto-generated base for CmdSequencer component.

A component for running command sequences

Definition at line 41 of file CmdSequencerComponentAc.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 CmdSequencerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_CMDRESPONSEIN_INPUT_PORTS
NUM_PINGIN_INPUT_PORTS
NUM_SCHEDIN_INPUT_PORTS
NUM_SEQCANCELIN_INPUT_PORTS
NUM_SEQRUNIN_INPUT_PORTS

Definition at line 64 of file CmdSequencerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_LOGTEXT_OUTPUT_PORTS
NUM_CMDREGOUT_OUTPUT_PORTS
NUM_CMDRESPONSEOUT_OUTPUT_PORTS
NUM_LOGOUT_OUTPUT_PORTS
NUM_TIMECALLER_OUTPUT_PORTS
NUM_TLMOUT_OUTPUT_PORTS

Definition at line 73 of file CmdSequencerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_COMCMDOUT_OUTPUT_PORTS
NUM_PINGOUT_OUTPUT_PORTS
NUM_SEQDONE_OUTPUT_PORTS
NUM_SEQSTARTOUT_OUTPUT_PORTS

Definition at line 83 of file CmdSequencerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Command opcodes.

Enumerator
OPCODE_CS_RUN	Run a command sequence file.
OPCODE_CS_VALIDATE	Validate a command sequence file.
OPCODE_CS_CANCEL	Cancel a command sequence.
OPCODE_CS_START	Start running a command sequence.
OPCODE_CS_STEP	Perform one step in a command sequence. Valid only if CmdSequencer is in MANUAL run mode.
OPCODE_CS_AUTO	Set the run mode to AUTO.
OPCODE_CS_MANUAL	Set the run mode to MANUAL.
OPCODE_CS_JOIN_WAIT	Wait for sequences that are running to finish. Allow user to run multiple seq files in SEQ_NO_BLOCK mode then wait for them to finish before allowing more seq run request.

Definition at line 91 of file CmdSequencerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_CS_SEQUENCELOADED	Sequence file was successfully loaded.
EVENTID_CS_SEQUENCECANCELED	A command sequence was successfully canceled.
EVENTID_CS_FILEREADERROR	The Sequence File Loader could not read the sequence file.
EVENTID_CS_FILEINVALID	The sequence file format was invalid.
EVENTID_CS_RECORDINVALID	The format of a command record was invalid.
EVENTID_CS_FILESIZEERROR	The sequence file was too large.
EVENTID_CS_FILENOTFOUND	The sequence file was not found.
EVENTID_CS_FILECRCFAILURE	The sequence file validation failed.
EVENTID_CS_COMMANDCOMPLETE	The Command Sequencer issued a command and received a success status in return.
EVENTID_CS_SEQUENCECOMPLETE	A command sequence successfully completed.
EVENTID_CS_COMMANDERROR	The Command Sequencer issued a command and received an error status in return.
EVENTID_CS_INVALIDMODE	The Command Sequencer received a command that was invalid for its current mode.
EVENTID_CS_RECORDMISMATCH	Number of records in header doesn't match number in file.
EVENTID_CS_TIMEBASEMISMATCH	The running time base doesn't match the time base in the sequence files.
EVENTID_CS_TIMECONTEXTMISMATCH	The running time base doesn't match the time base in the sequence files.
EVENTID_CS_PORTSEQUENCESTARTED	A local port request to run a sequence was started.
EVENTID_CS_UNEXPECTEDCOMPLETION	A command status came back when no sequence was running.
EVENTID_CS_MODESWITCHED	Switched step mode.
EVENTID_CS_NOSEQUENCEACTIVE	A sequence related command came with no active sequence.
EVENTID_CS_SEQUENCEVALID	A sequence passed validation.
EVENTID_CS_SEQUENCETIMEOUT	A sequence passed validation.
EVENTID_CS_CMDSTEPPED	A command in a sequence was stepped through.
EVENTID_CS_CMDSTARTED	A manual sequence was started.
EVENTID_CS_JOINWAITING	Wait for the current running sequence file complete.
EVENTID_CS_JOINWAITINGNOTCOMPLETE	Cannot run new sequence when current sequence file is still running.
EVENTID_CS_NORECORDS

Definition at line 103 of file CmdSequencerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_CS_LOADCOMMANDS	Channel ID for CS_LoadCommands.
CHANNELID_CS_CANCELCOMMANDS	Channel ID for CS_CancelCommands.
CHANNELID_CS_ERRORS	Channel ID for CS_Errors.
CHANNELID_CS_COMMANDSEXECUTED	Channel ID for CS_CommandsExecuted.
CHANNELID_CS_SEQUENCESCOMPLETED	Channel ID for CS_SequencesCompleted.

Definition at line 133 of file CmdSequencerComponentAc.hpp.

Constructor & Destructor Documentation

CmdSequencerComponentBase()

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

protected

Construct CmdSequencerComponentBase object.

Parameters

compName

The component name

Definition at line 873 of file CmdSequencerComponentAc.cpp.

~CmdSequencerComponentBase()

Svc::CmdSequencerComponentBase::~CmdSequencerComponentBase ( )

protectedvirtual

Destroy CmdSequencerComponentBase object.

Definition at line 880 of file CmdSequencerComponentAc.cpp.

Member Function Documentation

cmdResponse_out()

void Svc::CmdSequencerComponentBase::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 1526 of file CmdSequencerComponentAc.cpp.

cmdResponseIn_handler()

virtual void Svc::CmdSequencerComponentBase::cmdResponseIn_handler ( FwIndexType  portNum, FwOpcodeType  opCode, U32  cmdSeq, const Fw::CmdResponse &  response  )

protectedpure virtual

Handler for input port cmdResponseIn.

Parameters

portNum	The port number
opCode	Command Op Code
cmdSeq	Command Sequence
response	The command response argument

cmdResponseIn_handlerBase()

void Svc::CmdSequencerComponentBase::cmdResponseIn_handlerBase ( FwIndexType  portNum, FwOpcodeType  opCode, U32  cmdSeq, const Fw::CmdResponse &  response  )

protected

Handler base-class function for input port cmdResponseIn.

Parameters

portNum	The port number
opCode	Command Op Code
cmdSeq	Command Sequence
response	The command response argument

Definition at line 1130 of file CmdSequencerComponentAc.cpp.

cmdResponseIn_preMsgHook()

void Svc::CmdSequencerComponentBase::cmdResponseIn_preMsgHook ( FwIndexType  portNum, FwOpcodeType  opCode, U32  cmdSeq, const Fw::CmdResponse &  response  )

protectedvirtual

Pre-message hook for async input port cmdResponseIn.

Parameters

portNum	The port number
opCode	Command Op Code
cmdSeq	Command Sequence
response	The command response argument

Definition at line 1408 of file CmdSequencerComponentAc.cpp.

comCmdOut_out()

void Svc::CmdSequencerComponentBase::comCmdOut_out ( FwIndexType  portNum, Fw::ComBuffer &  data, U32  context  )

protected

Invoke output port comCmdOut.

Parameters

portNum	The port number
data	Buffer containing packet data
context	Call context value; meaning chosen by user

Definition at line 1456 of file CmdSequencerComponentAc.cpp.

CS_AUTO_cmdHandler()

virtual void Svc::CmdSequencerComponentBase::CS_AUTO_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedpure virtual

Handler for command CS_AUTO

Set the run mode to AUTO.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

CS_AUTO_cmdHandlerBase()

void Svc::CmdSequencerComponentBase::CS_AUTO_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command CS_AUTO

Set the run mode to AUTO.

Parameters

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

Definition at line 1838 of file CmdSequencerComponentAc.cpp.

CS_AUTO_preMsgHook()

void Svc::CmdSequencerComponentBase::CS_AUTO_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command CS_AUTO.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 2078 of file CmdSequencerComponentAc.cpp.

CS_CANCEL_cmdHandler()

virtual void Svc::CmdSequencerComponentBase::CS_CANCEL_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedpure virtual

Handler for command CS_CANCEL

Cancel a command sequence

Parameters

opCode	The opcode
cmdSeq	The command sequence number

CS_CANCEL_cmdHandlerBase()

void Svc::CmdSequencerComponentBase::CS_CANCEL_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command CS_CANCEL

Cancel a command sequence

Parameters

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

Definition at line 1661 of file CmdSequencerComponentAc.cpp.

CS_CANCEL_preMsgHook()

void Svc::CmdSequencerComponentBase::CS_CANCEL_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command CS_CANCEL.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 2045 of file CmdSequencerComponentAc.cpp.

CS_JOIN_WAIT_cmdHandler()

virtual void Svc::CmdSequencerComponentBase::CS_JOIN_WAIT_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedpure virtual

Handler for command CS_JOIN_WAIT

Wait for sequences that are running to finish. Allow user to run multiple seq files in SEQ_NO_BLOCK mode then wait for them to finish before allowing more seq run request.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

CS_JOIN_WAIT_cmdHandlerBase()

void Svc::CmdSequencerComponentBase::CS_JOIN_WAIT_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command CS_JOIN_WAIT

Wait for sequences that are running to finish. Allow user to run multiple seq files in SEQ_NO_BLOCK mode then wait for them to finish before allowing more seq run request.

Parameters

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

Definition at line 1956 of file CmdSequencerComponentAc.cpp.

CS_JOIN_WAIT_preMsgHook()

void Svc::CmdSequencerComponentBase::CS_JOIN_WAIT_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command CS_JOIN_WAIT.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 2100 of file CmdSequencerComponentAc.cpp.

CS_MANUAL_cmdHandler()

virtual void Svc::CmdSequencerComponentBase::CS_MANUAL_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedpure virtual

Handler for command CS_MANUAL

Set the run mode to MANUAL.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

CS_MANUAL_cmdHandlerBase()

void Svc::CmdSequencerComponentBase::CS_MANUAL_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command CS_MANUAL

Set the run mode to MANUAL.

Parameters

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

Definition at line 1897 of file CmdSequencerComponentAc.cpp.

CS_MANUAL_preMsgHook()

void Svc::CmdSequencerComponentBase::CS_MANUAL_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command CS_MANUAL.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 2089 of file CmdSequencerComponentAc.cpp.

CS_RUN_cmdHandler()

virtual void Svc::CmdSequencerComponentBase::CS_RUN_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq, const Fw::CmdStringArg &  fileName, Svc::CmdSequencer_BlockState  block  )

protectedpure virtual

Handler for command CS_RUN

Run a command sequence file

Parameters

opCode	The opcode
cmdSeq	The command sequence number
fileName	The name of the sequence file
block	Return command status when complete or not

CS_RUN_cmdHandlerBase()

void Svc::CmdSequencerComponentBase::CS_RUN_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command CS_RUN

Run a command sequence file

Parameters

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

Definition at line 1543 of file CmdSequencerComponentAc.cpp.

CS_RUN_preMsgHook()

void Svc::CmdSequencerComponentBase::CS_RUN_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command CS_RUN.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 2023 of file CmdSequencerComponentAc.cpp.

CS_START_cmdHandler()

virtual void Svc::CmdSequencerComponentBase::CS_START_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedpure virtual

Handler for command CS_START

Start running a command sequence

Parameters

opCode	The opcode
cmdSeq	The command sequence number

CS_START_cmdHandlerBase()

void Svc::CmdSequencerComponentBase::CS_START_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command CS_START

Start running a command sequence

Parameters

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

Definition at line 1720 of file CmdSequencerComponentAc.cpp.

CS_START_preMsgHook()

void Svc::CmdSequencerComponentBase::CS_START_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command CS_START.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 2056 of file CmdSequencerComponentAc.cpp.

CS_STEP_cmdHandler()

virtual void Svc::CmdSequencerComponentBase::CS_STEP_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedpure virtual

Handler for command CS_STEP

Perform one step in a command sequence. Valid only if CmdSequencer is in MANUAL run mode.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

CS_STEP_cmdHandlerBase()

void Svc::CmdSequencerComponentBase::CS_STEP_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command CS_STEP

Perform one step in a command sequence. Valid only if CmdSequencer is in MANUAL run mode.

Parameters

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

Definition at line 1779 of file CmdSequencerComponentAc.cpp.

CS_STEP_preMsgHook()

void Svc::CmdSequencerComponentBase::CS_STEP_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command CS_STEP.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 2067 of file CmdSequencerComponentAc.cpp.

CS_VALIDATE_cmdHandler()

virtual void Svc::CmdSequencerComponentBase::CS_VALIDATE_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq, const Fw::CmdStringArg &  fileName  )

protectedpure virtual

Handler for command CS_VALIDATE

Validate a command sequence file

Parameters

opCode	The opcode
cmdSeq	The command sequence number
fileName	The name of the sequence file

CS_VALIDATE_cmdHandlerBase()

void Svc::CmdSequencerComponentBase::CS_VALIDATE_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command CS_VALIDATE

Validate a command sequence file

Parameters

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

Definition at line 1602 of file CmdSequencerComponentAc.cpp.

CS_VALIDATE_preMsgHook()

void Svc::CmdSequencerComponentBase::CS_VALIDATE_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command CS_VALIDATE.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 2034 of file CmdSequencerComponentAc.cpp.

get_cmdIn_InputPort()

Fw::InputCmdPort * Svc::CmdSequencerComponentBase::get_cmdIn_InputPort

(

FwIndexType

portNum

)

Get special input port at index

Returns

cmdIn[portNum]

Parameters

portNum

The port number

Definition at line 445 of file CmdSequencerComponentAc.cpp.

get_cmdResponseIn_InputPort()

Fw::InputCmdResponsePort * Svc::CmdSequencerComponentBase::get_cmdResponseIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

cmdResponseIn[portNum]

Parameters

portNum

The port number

Definition at line 460 of file CmdSequencerComponentAc.cpp.

get_pingIn_InputPort()

Svc::InputPingPort * Svc::CmdSequencerComponentBase::get_pingIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

pingIn[portNum]

Parameters

portNum

The port number

Definition at line 471 of file CmdSequencerComponentAc.cpp.

get_schedIn_InputPort()

Svc::InputSchedPort * Svc::CmdSequencerComponentBase::get_schedIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

schedIn[portNum]

Parameters

portNum

The port number

Definition at line 482 of file CmdSequencerComponentAc.cpp.

get_seqCancelIn_InputPort()

Svc::InputCmdSeqCancelPort * Svc::CmdSequencerComponentBase::get_seqCancelIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

seqCancelIn[portNum]

Parameters

portNum

The port number

Definition at line 493 of file CmdSequencerComponentAc.cpp.

get_seqRunIn_InputPort()

Svc::InputCmdSeqInPort * Svc::CmdSequencerComponentBase::get_seqRunIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

seqRunIn[portNum]

Parameters

portNum

The port number

Definition at line 504 of file CmdSequencerComponentAc.cpp.

getNum_cmdIn_InputPorts()

FwIndexType Svc::CmdSequencerComponentBase::getNum_cmdIn_InputPorts ( ) const

protected

Get the number of cmdIn input ports

Returns

The number of cmdIn input ports

Definition at line 890 of file CmdSequencerComponentAc.cpp.

getNum_cmdRegOut_OutputPorts()

FwIndexType Svc::CmdSequencerComponentBase::getNum_cmdRegOut_OutputPorts ( ) const

protected

Get the number of cmdRegOut output ports

Returns

The number of cmdRegOut output ports

Definition at line 944 of file CmdSequencerComponentAc.cpp.

getNum_cmdResponseIn_InputPorts()

FwIndexType Svc::CmdSequencerComponentBase::getNum_cmdResponseIn_InputPorts ( ) const

protected

Get the number of cmdResponseIn input ports

Returns

The number of cmdResponseIn input ports

Definition at line 900 of file CmdSequencerComponentAc.cpp.

getNum_cmdResponseOut_OutputPorts()

FwIndexType Svc::CmdSequencerComponentBase::getNum_cmdResponseOut_OutputPorts ( ) const

protected

Get the number of cmdResponseOut output ports

Returns

The number of cmdResponseOut output ports

Definition at line 950 of file CmdSequencerComponentAc.cpp.

getNum_comCmdOut_OutputPorts()

FwIndexType Svc::CmdSequencerComponentBase::getNum_comCmdOut_OutputPorts ( ) const

protected

Get the number of comCmdOut output ports

Returns

The number of comCmdOut output ports

Definition at line 978 of file CmdSequencerComponentAc.cpp.

getNum_logOut_OutputPorts()

FwIndexType Svc::CmdSequencerComponentBase::getNum_logOut_OutputPorts ( ) const

protected

Get the number of logOut output ports

Returns

The number of logOut output ports

Definition at line 956 of file CmdSequencerComponentAc.cpp.

getNum_pingIn_InputPorts()

FwIndexType Svc::CmdSequencerComponentBase::getNum_pingIn_InputPorts ( ) const

protected

Get the number of pingIn input ports

Returns

The number of pingIn input ports

Definition at line 906 of file CmdSequencerComponentAc.cpp.

getNum_pingOut_OutputPorts()

FwIndexType Svc::CmdSequencerComponentBase::getNum_pingOut_OutputPorts ( ) const

protected

Get the number of pingOut output ports

Returns

The number of pingOut output ports

Definition at line 984 of file CmdSequencerComponentAc.cpp.

getNum_schedIn_InputPorts()

FwIndexType Svc::CmdSequencerComponentBase::getNum_schedIn_InputPorts ( ) const

protected

Get the number of schedIn input ports

Returns

The number of schedIn input ports

Definition at line 912 of file CmdSequencerComponentAc.cpp.

getNum_seqCancelIn_InputPorts()

FwIndexType Svc::CmdSequencerComponentBase::getNum_seqCancelIn_InputPorts ( ) const

protected

Get the number of seqCancelIn input ports

Returns

The number of seqCancelIn input ports

Definition at line 918 of file CmdSequencerComponentAc.cpp.

getNum_seqDone_OutputPorts()

FwIndexType Svc::CmdSequencerComponentBase::getNum_seqDone_OutputPorts ( ) const

protected

Get the number of seqDone output ports

Returns

The number of seqDone output ports

Definition at line 990 of file CmdSequencerComponentAc.cpp.

getNum_seqRunIn_InputPorts()

FwIndexType Svc::CmdSequencerComponentBase::getNum_seqRunIn_InputPorts ( ) const

protected

Get the number of seqRunIn input ports

Returns

The number of seqRunIn input ports

Definition at line 924 of file CmdSequencerComponentAc.cpp.

getNum_seqStartOut_OutputPorts()

FwIndexType Svc::CmdSequencerComponentBase::getNum_seqStartOut_OutputPorts ( ) const

protected

Get the number of seqStartOut output ports

Returns

The number of seqStartOut output ports

Definition at line 996 of file CmdSequencerComponentAc.cpp.

getNum_timeCaller_OutputPorts()

FwIndexType Svc::CmdSequencerComponentBase::getNum_timeCaller_OutputPorts ( ) const

protected

Get the number of timeCaller output ports

Returns

The number of timeCaller output ports

Definition at line 962 of file CmdSequencerComponentAc.cpp.

getNum_tlmOut_OutputPorts()

FwIndexType Svc::CmdSequencerComponentBase::getNum_tlmOut_OutputPorts ( ) const

protected

Get the number of tlmOut output ports

Returns

The number of tlmOut output ports

Definition at line 968 of file CmdSequencerComponentAc.cpp.

getTime()

Fw::Time Svc::CmdSequencerComponentBase::getTime ( )

protected

Get the time

\return The current time

Definition at line 4585 of file CmdSequencerComponentAc.cpp.

init()

void Svc::CmdSequencerComponentBase::init	(	FwSizeType	queueDepth,
		FwEnumStoreType	instance = 0
	)

Initialize CmdSequencerComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 85 of file CmdSequencerComponentAc.cpp.

isConnected_cmdRegOut_OutputPort()

bool Svc::CmdSequencerComponentBase::isConnected_cmdRegOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port cmdRegOut is connected

Returns

Whether port cmdRegOut is connected

Parameters

portNum

The port number

Definition at line 1021 of file CmdSequencerComponentAc.cpp.

isConnected_cmdResponseOut_OutputPort()

bool Svc::CmdSequencerComponentBase::isConnected_cmdResponseOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port cmdResponseOut is connected

Returns

Whether port cmdResponseOut is connected

Parameters

portNum

The port number

Definition at line 1032 of file CmdSequencerComponentAc.cpp.

isConnected_comCmdOut_OutputPort()

bool Svc::CmdSequencerComponentBase::isConnected_comCmdOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port comCmdOut is connected

Returns

Whether port comCmdOut is connected

Parameters

portNum

The port number

Definition at line 1080 of file CmdSequencerComponentAc.cpp.

isConnected_logOut_OutputPort()

bool Svc::CmdSequencerComponentBase::isConnected_logOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port logOut is connected

Returns

Whether port logOut is connected

Parameters

portNum

The port number

Definition at line 1043 of file CmdSequencerComponentAc.cpp.

isConnected_pingOut_OutputPort()

bool Svc::CmdSequencerComponentBase::isConnected_pingOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port pingOut is connected

Returns

Whether port pingOut is connected

Parameters

portNum

The port number

Definition at line 1091 of file CmdSequencerComponentAc.cpp.

isConnected_seqDone_OutputPort()

bool Svc::CmdSequencerComponentBase::isConnected_seqDone_OutputPort ( FwIndexType  portNum )

protected

Check whether port seqDone is connected

Returns

Whether port seqDone is connected

Parameters

portNum

The port number

Definition at line 1102 of file CmdSequencerComponentAc.cpp.

isConnected_seqStartOut_OutputPort()

bool Svc::CmdSequencerComponentBase::isConnected_seqStartOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port seqStartOut is connected

Returns

Whether port seqStartOut is connected

Parameters

portNum

The port number

Definition at line 1113 of file CmdSequencerComponentAc.cpp.

isConnected_timeCaller_OutputPort()

bool Svc::CmdSequencerComponentBase::isConnected_timeCaller_OutputPort ( FwIndexType  portNum )

protected

Check whether port timeCaller is connected

Returns

Whether port timeCaller is connected

Parameters

portNum

The port number

Definition at line 1054 of file CmdSequencerComponentAc.cpp.

isConnected_tlmOut_OutputPort()

bool Svc::CmdSequencerComponentBase::isConnected_tlmOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port tlmOut is connected

Returns

Whether port tlmOut is connected

Parameters

portNum

The port number

Definition at line 1065 of file CmdSequencerComponentAc.cpp.

log_ACTIVITY_HI_CS_CmdStarted()

void Svc::CmdSequencerComponentBase::log_ACTIVITY_HI_CS_CmdStarted ( const Fw::StringBase &  filename ) const

protected

Log event CS_CmdStarted

A manual sequence was started

Parameters

filename

The sequence file

Definition at line 4093 of file CmdSequencerComponentAc.cpp.

log_ACTIVITY_HI_CS_CmdStepped()

void Svc::CmdSequencerComponentBase::log_ACTIVITY_HI_CS_CmdStepped ( const Fw::StringBase &  filename, U32  command  ) const

protected

Log event CS_CmdStepped

A command in a sequence was stepped through

Parameters

filename	The sequence file
command	The command that was stepped

Definition at line 4001 of file CmdSequencerComponentAc.cpp.

log_ACTIVITY_HI_CS_JoinWaiting()

void Svc::CmdSequencerComponentBase::log_ACTIVITY_HI_CS_JoinWaiting ( const Fw::StringBase &  filename, U32  recordNumber, U32  opCode  ) const

protected

Log event CS_JoinWaiting

Wait for the current running sequence file complete

Parameters

filename	The sequence file
recordNumber	The record number
opCode	The opcode

Definition at line 4165 of file CmdSequencerComponentAc.cpp.

log_ACTIVITY_HI_CS_ModeSwitched()

void Svc::CmdSequencerComponentBase::log_ACTIVITY_HI_CS_ModeSwitched ( Svc::CmdSequencer_SeqMode  mode ) const

protected

Log event CS_ModeSwitched

Switched step mode

Parameters

mode	The new mode

Definition at line 3687 of file CmdSequencerComponentAc.cpp.

log_ACTIVITY_HI_CS_PortSequenceStarted()

void Svc::CmdSequencerComponentBase::log_ACTIVITY_HI_CS_PortSequenceStarted ( const Fw::StringBase &  filename ) const

protected

Log event CS_PortSequenceStarted

A local port request to run a sequence was started

Parameters

filename

The sequence file

Definition at line 3533 of file CmdSequencerComponentAc.cpp.

log_ACTIVITY_HI_CS_SequenceCanceled()

void Svc::CmdSequencerComponentBase::log_ACTIVITY_HI_CS_SequenceCanceled ( const Fw::StringBase &  fileName ) const

protected

Log event CS_SequenceCanceled

A command sequence was successfully canceled.

Parameters

fileName

The name of the sequence file

Definition at line 2187 of file CmdSequencerComponentAc.cpp.

log_ACTIVITY_HI_CS_SequenceComplete()

void Svc::CmdSequencerComponentBase::log_ACTIVITY_HI_CS_SequenceComplete ( const Fw::StringBase &  fileName ) const

protected

Log event CS_SequenceComplete

A command sequence successfully completed.

Parameters

fileName

The name of the sequence file

Definition at line 2938 of file CmdSequencerComponentAc.cpp.

log_ACTIVITY_HI_CS_SequenceValid()

void Svc::CmdSequencerComponentBase::log_ACTIVITY_HI_CS_SequenceValid ( const Fw::StringBase &  filename ) const

protected

Log event CS_SequenceValid

A sequence passed validation

Parameters

filename

The sequence file

Definition at line 3837 of file CmdSequencerComponentAc.cpp.

log_ACTIVITY_LO_CS_CommandComplete()

void Svc::CmdSequencerComponentBase::log_ACTIVITY_LO_CS_CommandComplete ( const Fw::StringBase &  fileName, U32  recordNumber, U32  opCode  ) const

protected

Log event CS_CommandComplete

The Command Sequencer issued a command and received a success status in return.

Parameters

fileName	The name of the sequence file
recordNumber	The record number of the command
opCode	The command opcode

Definition at line 2828 of file CmdSequencerComponentAc.cpp.

log_ACTIVITY_LO_CS_SequenceLoaded()

void Svc::CmdSequencerComponentBase::log_ACTIVITY_LO_CS_SequenceLoaded ( const Fw::StringBase &  fileName ) const

protected

Log event CS_SequenceLoaded

Sequence file was successfully loaded.

Parameters

fileName

The name of the sequence file

Definition at line 2115 of file CmdSequencerComponentAc.cpp.

log_WARNING_HI_CS_CommandError()

void Svc::CmdSequencerComponentBase::log_WARNING_HI_CS_CommandError ( const Fw::StringBase &  fileName, U32  recordNumber, U32  opCode, U32  errorStatus  ) const

protected

Log event CS_CommandError

The Command Sequencer issued a command and received an error status in return.

Parameters

fileName	The name of the sequence file
recordNumber	The record number
opCode	The opcode
errorStatus	The error status

Definition at line 3010 of file CmdSequencerComponentAc.cpp.

log_WARNING_HI_CS_FileCrcFailure()

void Svc::CmdSequencerComponentBase::log_WARNING_HI_CS_FileCrcFailure ( const Fw::StringBase &  fileName, U32  storedCRC, U32  computedCRC  ) const

protected

Log event CS_FileCrcFailure

The sequence file validation failed

Parameters

fileName	The sequence file
storedCRC	The CRC stored in the file
computedCRC	The CRC computed over the file

Definition at line 2718 of file CmdSequencerComponentAc.cpp.

log_WARNING_HI_CS_FileInvalid()

void Svc::CmdSequencerComponentBase::log_WARNING_HI_CS_FileInvalid ( const Fw::StringBase &  fileName, Svc::CmdSequencer_FileReadStage  stage, I32  error  ) const

protected

Log event CS_FileInvalid

The sequence file format was invalid.

Parameters

fileName	The name of the sequence file
stage	The read stage
error	The error code

Definition at line 2331 of file CmdSequencerComponentAc.cpp.

log_WARNING_HI_CS_FileNotFound()

void Svc::CmdSequencerComponentBase::log_WARNING_HI_CS_FileNotFound ( const Fw::StringBase &  fileName ) const

protected

Log event CS_FileNotFound

The sequence file was not found

Parameters

fileName

The sequence file

Definition at line 2646 of file CmdSequencerComponentAc.cpp.

log_WARNING_HI_CS_FileReadError()

void Svc::CmdSequencerComponentBase::log_WARNING_HI_CS_FileReadError ( const Fw::StringBase &  fileName ) const

protected

Log event CS_FileReadError

The Sequence File Loader could not read the sequence file.

Parameters

fileName

The name of the sequence file

Definition at line 2259 of file CmdSequencerComponentAc.cpp.

log_WARNING_HI_CS_FileSizeError()

void Svc::CmdSequencerComponentBase::log_WARNING_HI_CS_FileSizeError ( const Fw::StringBase &  fileName, U32  size  ) const

protected

Log event CS_FileSizeError

The sequence file was too large.

Parameters

fileName	The name of the sequence file
size	Invalid size

Definition at line 2554 of file CmdSequencerComponentAc.cpp.

log_WARNING_HI_CS_InvalidMode()

void Svc::CmdSequencerComponentBase::log_WARNING_HI_CS_InvalidMode ( ) const

protected

Log event CS_InvalidMode

The Command Sequencer received a command that was invalid for its current mode.

Definition at line 3138 of file CmdSequencerComponentAc.cpp.

log_WARNING_HI_CS_JoinWaitingNotComplete()

void Svc::CmdSequencerComponentBase::log_WARNING_HI_CS_JoinWaitingNotComplete ( ) const

protected

Log event CS_JoinWaitingNotComplete

Cannot run new sequence when current sequence file is still running.

Definition at line 4275 of file CmdSequencerComponentAc.cpp.

log_WARNING_HI_CS_RecordInvalid()

void Svc::CmdSequencerComponentBase::log_WARNING_HI_CS_RecordInvalid ( const Fw::StringBase &  fileName, U32  recordNumber, I32  error  ) const

protected

Log event CS_RecordInvalid

The format of a command record was invalid.

Parameters

fileName	The name of the sequence file
recordNumber	The record number
error	The error code

Definition at line 2444 of file CmdSequencerComponentAc.cpp.

log_WARNING_HI_CS_RecordMismatch()

void Svc::CmdSequencerComponentBase::log_WARNING_HI_CS_RecordMismatch ( const Fw::StringBase &  fileName, U32  header_records, U32  extra_bytes  ) const

protected

Log event CS_RecordMismatch

Number of records in header doesn't match number in file

Parameters

fileName	The name of the sequence file
header_records	The number of records in the header
extra_bytes	The number of bytes beyond last record

Definition at line 3203 of file CmdSequencerComponentAc.cpp.

log_WARNING_HI_CS_SequenceTimeout()

void Svc::CmdSequencerComponentBase::log_WARNING_HI_CS_SequenceTimeout ( const Fw::StringBase &  filename, U32  command  ) const

protected

Log event CS_SequenceTimeout

A sequence passed validation

Parameters

filename	The sequence file
command	The command that timed out

Definition at line 3909 of file CmdSequencerComponentAc.cpp.

log_WARNING_HI_CS_TimeBaseMismatch()

void Svc::CmdSequencerComponentBase::log_WARNING_HI_CS_TimeBaseMismatch ( const Fw::StringBase &  fileName, U16  time_base, U16  seq_time_base  ) const

protected

Log event CS_TimeBaseMismatch

The running time base doesn't match the time base in the sequence files

Parameters

fileName	The name of the sequence file
time_base	The current time
seq_time_base	The sequence time base

Definition at line 3313 of file CmdSequencerComponentAc.cpp.

log_WARNING_HI_CS_TimeContextMismatch()

void Svc::CmdSequencerComponentBase::log_WARNING_HI_CS_TimeContextMismatch ( const Fw::StringBase &  fileName, U8  currTimeBase, U8  seqTimeBase  ) const

protected

Log event CS_TimeContextMismatch

The running time base doesn't match the time base in the sequence files

Parameters

fileName	The name of the sequence file
currTimeBase	The current time base
seqTimeBase	The sequence time base

Definition at line 3423 of file CmdSequencerComponentAc.cpp.

log_WARNING_HI_CS_UnexpectedCompletion()

void Svc::CmdSequencerComponentBase::log_WARNING_HI_CS_UnexpectedCompletion ( U32  opcode ) const

protected

Log event CS_UnexpectedCompletion

A command status came back when no sequence was running

Parameters

opcode

The reported opcode

Definition at line 3605 of file CmdSequencerComponentAc.cpp.

log_WARNING_LO_CS_NoRecords()

void Svc::CmdSequencerComponentBase::log_WARNING_LO_CS_NoRecords ( const Fw::StringBase &  fileName ) const

protected

Log event CS_NoRecords.

Parameters

fileName

The name of the sequence file

Definition at line 4340 of file CmdSequencerComponentAc.cpp.

log_WARNING_LO_CS_NoSequenceActive()

void Svc::CmdSequencerComponentBase::log_WARNING_LO_CS_NoSequenceActive ( ) const

protected

Log event CS_NoSequenceActive

A sequence related command came with no active sequence

Definition at line 3772 of file CmdSequencerComponentAc.cpp.

pingIn_handler()

virtual void Svc::CmdSequencerComponentBase::pingIn_handler ( FwIndexType  portNum, U32  key  )

protectedpure virtual

Handler for input port pingIn.

Parameters

portNum	The port number
key	Value to return to pinger

pingIn_handlerBase()

void Svc::CmdSequencerComponentBase::pingIn_handlerBase ( FwIndexType  portNum, U32  key  )

protected

Handler base-class function for input port pingIn.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 1201 of file CmdSequencerComponentAc.cpp.

pingIn_preMsgHook()

void Svc::CmdSequencerComponentBase::pingIn_preMsgHook ( FwIndexType  portNum, U32  key  )

protectedvirtual

Pre-message hook for async input port pingIn.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 1419 of file CmdSequencerComponentAc.cpp.

pingOut_out()

void Svc::CmdSequencerComponentBase::pingOut_out ( FwIndexType  portNum, U32  key  )

protected

Invoke output port pingOut.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 1473 of file CmdSequencerComponentAc.cpp.

regCommands()

void Svc::CmdSequencerComponentBase::regCommands

(

)

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 831 of file CmdSequencerComponentAc.cpp.

schedIn_handler()

virtual void Svc::CmdSequencerComponentBase::schedIn_handler ( FwIndexType  portNum, U32  context  )

protectedpure virtual

Handler for input port schedIn.

Parameters

portNum	The port number
context	The call order

schedIn_handlerBase()

void Svc::CmdSequencerComponentBase::schedIn_handlerBase ( FwIndexType  portNum, U32  context  )

protected

Handler base-class function for input port schedIn.

Parameters

portNum	The port number
context	The call order

Definition at line 1254 of file CmdSequencerComponentAc.cpp.

schedIn_preMsgHook()

void Svc::CmdSequencerComponentBase::schedIn_preMsgHook ( FwIndexType  portNum, U32  context  )

protectedvirtual

Pre-message hook for async input port schedIn.

Parameters

portNum	The port number
context	The call order

Definition at line 1428 of file CmdSequencerComponentAc.cpp.

seqCancelIn_handler()

virtual void Svc::CmdSequencerComponentBase::seqCancelIn_handler ( FwIndexType  portNum )

protectedpure virtual

Handler for input port seqCancelIn.

Parameters

portNum

The port number

seqCancelIn_handlerBase()

void Svc::CmdSequencerComponentBase::seqCancelIn_handlerBase ( FwIndexType  portNum )

protected

Handler base-class function for input port seqCancelIn.

Parameters

portNum

The port number

Definition at line 1307 of file CmdSequencerComponentAc.cpp.

seqCancelIn_preMsgHook()

void Svc::CmdSequencerComponentBase::seqCancelIn_preMsgHook ( FwIndexType  portNum )

protectedvirtual

Pre-message hook for async input port seqCancelIn.

Parameters

portNum

The port number

Definition at line 1437 of file CmdSequencerComponentAc.cpp.

seqDone_out()

void Svc::CmdSequencerComponentBase::seqDone_out ( FwIndexType  portNum, FwOpcodeType  opCode, U32  cmdSeq, const Fw::CmdResponse &  response  )

protected

Invoke output port seqDone.

Parameters

portNum	The port number
opCode	Command Op Code
cmdSeq	Command Sequence
response	The command response argument

Definition at line 1488 of file CmdSequencerComponentAc.cpp.

seqRunIn_handler()

virtual void Svc::CmdSequencerComponentBase::seqRunIn_handler ( FwIndexType  portNum, const Fw::StringBase &  filename  )

protectedpure virtual

Handler for input port seqRunIn.

Parameters

portNum	The port number
filename	The sequence file

seqRunIn_handlerBase()

void Svc::CmdSequencerComponentBase::seqRunIn_handlerBase ( FwIndexType  portNum, const Fw::StringBase &  filename  )

protected

Handler base-class function for input port seqRunIn.

Parameters

portNum	The port number
filename	The sequence file

Definition at line 1347 of file CmdSequencerComponentAc.cpp.

seqRunIn_preMsgHook()

void Svc::CmdSequencerComponentBase::seqRunIn_preMsgHook ( FwIndexType  portNum, const Fw::StringBase &  filename  )

protectedvirtual

Pre-message hook for async input port seqRunIn.

Parameters

portNum	The port number
filename	The sequence file

Definition at line 1443 of file CmdSequencerComponentAc.cpp.

seqStartOut_out()

void Svc::CmdSequencerComponentBase::seqStartOut_out ( FwIndexType  portNum, const Fw::StringBase &  filename  )

protected

Invoke output port seqStartOut.

Parameters

portNum	The port number
filename	The sequence file

Definition at line 1507 of file CmdSequencerComponentAc.cpp.

set_cmdRegOut_OutputPort()

void Svc::CmdSequencerComponentBase::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 537 of file CmdSequencerComponentAc.cpp.

set_cmdResponseOut_OutputPort()

void Svc::CmdSequencerComponentBase::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 551 of file CmdSequencerComponentAc.cpp.

set_comCmdOut_OutputPort()

void Svc::CmdSequencerComponentBase::set_comCmdOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputComPort *	port
	)

Connect port to comCmdOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 611 of file CmdSequencerComponentAc.cpp.

set_logOut_OutputPort()

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

Connect port to logOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 565 of file CmdSequencerComponentAc.cpp.

set_pingOut_OutputPort()

void Svc::CmdSequencerComponentBase::set_pingOut_OutputPort	(	FwIndexType	portNum,
		Svc::InputPingPort *	port
	)

Connect port to pingOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 625 of file CmdSequencerComponentAc.cpp.

set_seqDone_OutputPort()

void Svc::CmdSequencerComponentBase::set_seqDone_OutputPort	(	FwIndexType	portNum,
		Fw::InputCmdResponsePort *	port
	)

Connect port to seqDone[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 639 of file CmdSequencerComponentAc.cpp.

set_seqStartOut_OutputPort()

void Svc::CmdSequencerComponentBase::set_seqStartOut_OutputPort	(	FwIndexType	portNum,
		Svc::InputCmdSeqInPort *	port
	)

Connect port to seqStartOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 653 of file CmdSequencerComponentAc.cpp.

set_timeCaller_OutputPort()

void Svc::CmdSequencerComponentBase::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 579 of file CmdSequencerComponentAc.cpp.

set_tlmOut_OutputPort()

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

Connect port to tlmOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 593 of file CmdSequencerComponentAc.cpp.

tlmWrite_CS_CancelCommands()

void Svc::CmdSequencerComponentBase::tlmWrite_CS_CancelCommands ( U32  arg, Fw::Time  _tlmTime = Fw::Time()  ) const

protected

Write telemetry channel CS_CancelCommands

The number of Cancel commands executed

Parameters

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 4449 of file CmdSequencerComponentAc.cpp.

tlmWrite_CS_CommandsExecuted()

void Svc::CmdSequencerComponentBase::tlmWrite_CS_CommandsExecuted ( U32  arg, Fw::Time  _tlmTime = Fw::Time()  ) const

protected

Write telemetry channel CS_CommandsExecuted

The number of commands executed across all sequences.

Parameters

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 4515 of file CmdSequencerComponentAc.cpp.

tlmWrite_CS_Errors()

void Svc::CmdSequencerComponentBase::tlmWrite_CS_Errors ( U32  arg, Fw::Time  _tlmTime = Fw::Time()  ) const

protected

Write telemetry channel CS_Errors

The number of errors that have occurred

Parameters

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 4482 of file CmdSequencerComponentAc.cpp.

tlmWrite_CS_LoadCommands()

void Svc::CmdSequencerComponentBase::tlmWrite_CS_LoadCommands ( U32  arg, Fw::Time  _tlmTime = Fw::Time()  ) const

protected

Write telemetry channel CS_LoadCommands

The number of Load commands executed

Parameters

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 4416 of file CmdSequencerComponentAc.cpp.

tlmWrite_CS_SequencesCompleted()

void Svc::CmdSequencerComponentBase::tlmWrite_CS_SequencesCompleted ( U32  arg, Fw::Time  _tlmTime = Fw::Time()  ) const

protected

Write telemetry channel CS_SequencesCompleted

The number of sequences completed.

Parameters

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 4548 of file CmdSequencerComponentAc.cpp.

Friends And Related Function Documentation

CmdSequencerComponentBaseFriend

friend class CmdSequencerComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 50 of file CmdSequencerComponentAc.hpp.

---

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

• Svc/CmdSequencer/CmdSequencerComponentAc.hpp
• Svc/CmdSequencer/CmdSequencerComponentAc.cpp