Executes a set of components as part of a rate group. More...

#include <Svc/ActiveRateGroup/ActiveRateGroup.hpp>

Inheritance diagram for Svc::ActiveRateGroup:

Public Member Functions
	ActiveRateGroup (const char *compName)
	ActiveRateGroup constructor. More...

void	init (NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instance)
	ActiveRateGroup initialization function. More...

void	configure (NATIVE_INT_TYPE contexts[], NATIVE_INT_TYPE numContexts)
	ActiveRateGroup configuration function. More...

	~ActiveRateGroup ()
	ActiveRateGroup destructor. More...

Public Member Functions inherited from Svc::ActiveRateGroupComponentBase
void	init (NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instance=0)
	Initialize ActiveRateGroupComponentBase object. More...

Svc::InputCyclePort *	get_CycleIn_InputPort (NATIVE_INT_TYPE portNum)

Svc::InputPingPort *	get_PingIn_InputPort (NATIVE_INT_TYPE portNum)

void	set_Log_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputLogPort *port)
	Connect port to Log[portNum]. More...

void	set_Time_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTimePort *port)
	Connect port to Time[portNum]. More...

void	set_Tlm_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTlmPort *port)
	Connect port to Tlm[portNum]. More...

void	set_PingOut_OutputPort (NATIVE_INT_TYPE portNum, Svc::InputPingPort *port)
	Connect port to PingOut[portNum]. More...

void	set_RateGroupMemberOut_OutputPort (NATIVE_INT_TYPE portNum, Svc::InputSchedPort *port)
	Connect port to RateGroupMemberOut[portNum]. More...

Public Member Functions inherited from Fw::ActiveComponentBase
void	start (NATIVE_UINT_TYPE priority=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE stackSize=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE cpuAffinity=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE identifier=Os::Task::TASK_DEFAULT)
	called by instantiator when task is to be started More...

	DEPRECATED (void start(NATIVE_INT_TYPE identifier, NATIVE_INT_TYPE priority, NATIVE_INT_TYPE stackSize, NATIVE_INT_TYPE cpuAffinity=-1), "Please switch to start(NATIVE_UINT_TYPE priority, NATIVE_UINT_TYPE stackSize, NATIVE_UINT_TYPE cpuAffinity, NATIVE_UINT_TYPE identifier)")
	called by instantiator when task is to be started More...

void	exit ()
	exit task in active component More...

Os::Task::TaskStatus	join (void **value_ptr)
	provide return value of thread if value_ptr is not NULL More...

Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base. More...

U32	getIdBase () const

Static Public Attributes
static constexpr NATIVE_INT_TYPE	CONNECTION_COUNT_MAX = NUM_RATEGROUPMEMBEROUT_OUTPUT_PORTS

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 Types inherited from Svc::ActiveRateGroupComponentBase
enum	{ NUM_CYCLEIN_INPUT_PORTS = 1 , NUM_PINGIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_LOG_OUTPUT_PORTS = 1 , NUM_LOGTEXT_OUTPUT_PORTS = 1 , NUM_TIME_OUTPUT_PORTS = 1 , NUM_TLM_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...

enum	{ NUM_PINGOUT_OUTPUT_PORTS = 1 , NUM_RATEGROUPMEMBEROUT_OUTPUT_PORTS = 10 }
	Enumerations for numbers of typed output ports. More...

enum	{ EVENTID_RATEGROUPSTARTED = 0x0 , EVENTID_RATEGROUPCYCLESLIP = 0x1 }
	Event IDs. More...

enum	{ CHANNELID_RGMAXTIME = 0x0 , CHANNELID_RGCYCLESLIPS = 0x1 }
	Channel IDs. More...

Protected Member Functions inherited from Svc::ActiveRateGroupComponentBase
	ActiveRateGroupComponentBase (const char *compName="")
	Construct ActiveRateGroupComponentBase object. More...

virtual	~ActiveRateGroupComponentBase ()
	Destroy ActiveRateGroupComponentBase object. More...

NATIVE_INT_TYPE	getNum_CycleIn_InputPorts () const

NATIVE_INT_TYPE	getNum_PingIn_InputPorts () const

NATIVE_INT_TYPE	getNum_Log_OutputPorts () const

NATIVE_INT_TYPE	getNum_Time_OutputPorts () const

NATIVE_INT_TYPE	getNum_Tlm_OutputPorts () const

NATIVE_INT_TYPE	getNum_PingOut_OutputPorts () const

NATIVE_INT_TYPE	getNum_RateGroupMemberOut_OutputPorts () const

bool	isConnected_Log_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_Time_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_Tlm_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_PingOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_RateGroupMemberOut_OutputPort (NATIVE_INT_TYPE portNum)

void	CycleIn_handlerBase (NATIVE_INT_TYPE portNum, Svc::TimerVal &cycleStart)
	Handler base-class function for input port CycleIn. More...

void	PingIn_handlerBase (NATIVE_INT_TYPE portNum, U32 key)
	Handler base-class function for input port PingIn. More...

virtual void	PingIn_preMsgHook (NATIVE_INT_TYPE portNum, U32 key)
	Pre-message hook for async input port PingIn. More...

void	PingOut_out (NATIVE_INT_TYPE portNum, U32 key)
	Invoke output port PingOut. More...

void	RateGroupMemberOut_out (NATIVE_INT_TYPE portNum, NATIVE_UINT_TYPE context)
	Invoke output port RateGroupMemberOut. More...

void	log_DIAGNOSTIC_RateGroupStarted ()

void	log_WARNING_HI_RateGroupCycleSlip (U32 cycle)

void	tlmWrite_RgMaxTime (U32 arg, Fw::Time _tlmTime=Fw::Time())

void	tlmWrite_RgCycleSlips (U32 arg, Fw::Time _tlmTime=Fw::Time())

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	loop ()
	The function that will loop 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::QueueStatus	createQueue (NATIVE_INT_TYPE depth, NATIVE_INT_TYPE 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...

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

Executes a set of components as part of a rate group.

ActiveRateGroup takes an input cycle call to begin the rate group cycle. It calls each output port in succession and passes the value in the context array at the index corresponding to the output port number. It keeps track of the execution time of the rate group and detects overruns.

Definition at line 31 of file ActiveRateGroup.hpp.

Constructor & Destructor Documentation

◆ ActiveRateGroup()

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

ActiveRateGroup constructor.

The constructor of the class clears all the flags and copies the contents of the context array to private storage.

Parameters

compName Name of the component

Definition at line 23 of file ActiveRateGroup.cpp.

◆ ~ActiveRateGroup()

Svc::ActiveRateGroup::~ActiveRateGroup ( )

ActiveRateGroup destructor.

The destructor of the class is empty

Definition at line 51 of file ActiveRateGroup.cpp.

Member Function Documentation

◆ configure()

void Svc::ActiveRateGroup::configure	(	NATIVE_INT_TYPE	contexts[],
		NATIVE_INT_TYPE	numContexts
	)

ActiveRateGroup configuration function.

The configuration function takes an array of context values to pass to members of the rate group.

Parameters

contexts	Array of integers that contain the context values that will be sent to each member component. The index of the array corresponds to the output port number.
numContexts	The number of elements in the context array.

Definition at line 33 of file ActiveRateGroup.cpp.

◆ init()

void Svc::ActiveRateGroup::init	(	NATIVE_INT_TYPE	queueDepth,
		NATIVE_INT_TYPE	instance
	)

ActiveRateGroup initialization function.

The initialization function of the class initializes the member ports and the component base class

Parameters

queueDepth	Depth of the active component message queue
instance	Identifies the instance of the rate group component

Definition at line 47 of file ActiveRateGroup.cpp.

Member Data Documentation

◆ CONNECTION_COUNT_MAX

constexpr NATIVE_INT_TYPE Svc::ActiveRateGroup::CONNECTION_COUNT_MAX = NUM_RATEGROUPMEMBEROUT_OUTPUT_PORTS

staticconstexpr

Definition at line 33 of file ActiveRateGroup.hpp.

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

Svc/ActiveRateGroup/ActiveRateGroup.hpp
Svc/ActiveRateGroup/ActiveRateGroup.cpp

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ActiveRateGroup()

◆ ~ActiveRateGroup()

Member Function Documentation

◆ configure()

◆ init()

Member Data Documentation

◆ CONNECTION_COUNT_MAX