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

#include <Svc/PassiveRateGroup/PassiveRateGroupComponentAc.hpp>

Inheritance diagram for Svc::PassiveRateGroupComponentBase:

Public Member Functions
void	init (NATIVE_INT_TYPE instance=0)
	Initialize PassiveRateGroupComponentBase object. More...

Svc::InputCyclePort *	get_CycleIn_InputPort (NATIVE_INT_TYPE portNum)

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_RateGroupMemberOut_OutputPort (NATIVE_INT_TYPE portNum, Svc::InputSchedPort *port)
	Connect port to RateGroupMemberOut[portNum]. More...

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

U32	getIdBase () const

Protected Types
enum	{ NUM_CYCLEIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

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

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

enum	{ CHANNELID_MAXCYCLETIME = 0x0 , CHANNELID_CYCLETIME = 0x1 , CHANNELID_CYCLECOUNT = 0x2 }
	Channel IDs. More...

Protected Member Functions
	PassiveRateGroupComponentBase (const char *compName="")
	Construct PassiveRateGroupComponentBase object. More...

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

NATIVE_INT_TYPE	getNum_CycleIn_InputPorts () const

NATIVE_INT_TYPE	getNum_Time_OutputPorts () const

NATIVE_INT_TYPE	getNum_Tlm_OutputPorts () const

NATIVE_INT_TYPE	getNum_RateGroupMemberOut_OutputPorts () const

bool	isConnected_Time_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_Tlm_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_RateGroupMemberOut_OutputPort (NATIVE_INT_TYPE portNum)

virtual void	CycleIn_handler (NATIVE_INT_TYPE portNum, Svc::TimerVal &cycleStart)=0
	Handler for input port CycleIn. More...

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

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

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

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

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

Fw::Time	getTime ()

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	PassiveRateGroupComponentBaseFriend
	Friend class for white-box testing. More...

Detailed Description

Auto-generated base for PassiveRateGroup component.

A rate group passive component with input and output scheduler ports

Definition at line 26 of file PassiveRateGroupComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_CYCLEIN_INPUT_PORTS

Definition at line 44 of file PassiveRateGroupComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_TIME_OUTPUT_PORTS
NUM_TLM_OUTPUT_PORTS

Definition at line 49 of file PassiveRateGroupComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_RATEGROUPMEMBEROUT_OUTPUT_PORTS

Definition at line 55 of file PassiveRateGroupComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_MAXCYCLETIME	Channel ID for MaxCycleTime.
CHANNELID_CYCLETIME	Channel ID for CycleTime.
CHANNELID_CYCLECOUNT	Channel ID for CycleCount.

Definition at line 60 of file PassiveRateGroupComponentAc.hpp.

Constructor & Destructor Documentation

◆ PassiveRateGroupComponentBase()

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

protected

Construct PassiveRateGroupComponentBase object.

Parameters

compName The component name

Definition at line 268 of file PassiveRateGroupComponentAc.cpp.

◆ ~PassiveRateGroupComponentBase()

Svc::PassiveRateGroupComponentBase::~PassiveRateGroupComponentBase ( )

protectedvirtual

Destroy PassiveRateGroupComponentBase object.

Definition at line 277 of file PassiveRateGroupComponentAc.cpp.

Member Function Documentation

◆ CycleIn_handler()

virtual void Svc::PassiveRateGroupComponentBase::CycleIn_handler	(	NATIVE_INT_TYPE	portNum,
		Svc::TimerVal &	cycleStart
	)

protectedpure virtual

Handler for input port CycleIn.

Parameters

portNum	The port number
cycleStart	Cycle start timer value

◆ CycleIn_handlerBase()

void Svc::PassiveRateGroupComponentBase::CycleIn_handlerBase	(	NATIVE_INT_TYPE	portNum,
		Svc::TimerVal &	cycleStart
	)

protected

Handler base-class function for input port CycleIn.

Parameters

portNum	The port number
cycleStart	Cycle start timer value

Definition at line 366 of file PassiveRateGroupComponentAc.cpp.

◆ get_CycleIn_InputPort()

Svc::InputCyclePort * Svc::PassiveRateGroupComponentBase::get_CycleIn_InputPort ( NATIVE_INT_TYPE portNum )

Get typed input port at index

Returns: CycleIn[portNum]

Parameters

portNum The port number

Definition at line 145 of file PassiveRateGroupComponentAc.cpp.

◆ getNum_CycleIn_InputPorts()

NATIVE_INT_TYPE Svc::PassiveRateGroupComponentBase::getNum_CycleIn_InputPorts ( ) const

protected

Get the number of CycleIn input ports

Returns: The number of CycleIn input ports

Definition at line 287 of file PassiveRateGroupComponentAc.cpp.

◆ getNum_RateGroupMemberOut_OutputPorts()

NATIVE_INT_TYPE Svc::PassiveRateGroupComponentBase::getNum_RateGroupMemberOut_OutputPorts ( ) const

protected

Get the number of RateGroupMemberOut output ports

Returns: The number of RateGroupMemberOut output ports

Definition at line 313 of file PassiveRateGroupComponentAc.cpp.

◆ getNum_Time_OutputPorts()

NATIVE_INT_TYPE Svc::PassiveRateGroupComponentBase::getNum_Time_OutputPorts ( ) const

protected

Get the number of Time output ports

Returns: The number of Time output ports

Definition at line 297 of file PassiveRateGroupComponentAc.cpp.

◆ getNum_Tlm_OutputPorts()

NATIVE_INT_TYPE Svc::PassiveRateGroupComponentBase::getNum_Tlm_OutputPorts ( ) const

protected

Get the number of Tlm output ports

Returns: The number of Tlm output ports

Definition at line 303 of file PassiveRateGroupComponentAc.cpp.

◆ getTime()

Fw::Time Svc::PassiveRateGroupComponentBase::getTime ( )

protected

Get the time

\return The current time

Definition at line 526 of file PassiveRateGroupComponentAc.cpp.

◆ init()

void Svc::PassiveRateGroupComponentBase::init ( NATIVE_INT_TYPE instance = 0 )

Initialize PassiveRateGroupComponentBase object.

Parameters

instance The instance number

Definition at line 21 of file PassiveRateGroupComponentAc.cpp.

◆ isConnected_RateGroupMemberOut_OutputPort()

bool Svc::PassiveRateGroupComponentBase::isConnected_RateGroupMemberOut_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port RateGroupMemberOut is connected

Returns: Whether port RateGroupMemberOut is connected

Parameters

portNum The port number

Definition at line 349 of file PassiveRateGroupComponentAc.cpp.

◆ isConnected_Time_OutputPort()

bool Svc::PassiveRateGroupComponentBase::isConnected_Time_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port Time is connected

Returns: Whether port Time is connected

Parameters

portNum The port number

Definition at line 323 of file PassiveRateGroupComponentAc.cpp.

◆ isConnected_Tlm_OutputPort()

bool Svc::PassiveRateGroupComponentBase::isConnected_Tlm_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port Tlm is connected

Returns: Whether port Tlm is connected

Parameters

portNum The port number

Definition at line 334 of file PassiveRateGroupComponentAc.cpp.

◆ RateGroupMemberOut_out()

void Svc::PassiveRateGroupComponentBase::RateGroupMemberOut_out	(	NATIVE_INT_TYPE	portNum,
		NATIVE_UINT_TYPE	context
	)

protected

Invoke output port RateGroupMemberOut.

Parameters

portNum	The port number
context	The call order

Definition at line 389 of file PassiveRateGroupComponentAc.cpp.

◆ set_RateGroupMemberOut_OutputPort()

void Svc::PassiveRateGroupComponentBase::set_RateGroupMemberOut_OutputPort	(	NATIVE_INT_TYPE	portNum,
		Svc::InputSchedPort *	port
	)

Connect port to RateGroupMemberOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 192 of file PassiveRateGroupComponentAc.cpp.

◆ set_Time_OutputPort()

void Svc::PassiveRateGroupComponentBase::set_Time_OutputPort	(	NATIVE_INT_TYPE	portNum,
		Fw::InputTimePort *	port
	)

Connect port to Time[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 160 of file PassiveRateGroupComponentAc.cpp.

◆ set_Tlm_OutputPort()

void Svc::PassiveRateGroupComponentBase::set_Tlm_OutputPort	(	NATIVE_INT_TYPE	portNum,
		Fw::InputTlmPort *	port
	)

Connect port to Tlm[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 174 of file PassiveRateGroupComponentAc.cpp.

◆ tlmWrite_CycleCount()

void Svc::PassiveRateGroupComponentBase::tlmWrite_CycleCount	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)

protected

Write telemetry channel CycleCount

Count of number of cycles

Parameters

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

Definition at line 489 of file PassiveRateGroupComponentAc.cpp.

◆ tlmWrite_CycleTime()

void Svc::PassiveRateGroupComponentBase::tlmWrite_CycleTime	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)

protected

Write telemetry channel CycleTime

Execution time of current cycle

Parameters

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

Definition at line 456 of file PassiveRateGroupComponentAc.cpp.

◆ tlmWrite_MaxCycleTime()

void Svc::PassiveRateGroupComponentBase::tlmWrite_MaxCycleTime	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)

protected

Write telemetry channel MaxCycleTime

Max execution time of rate group cycle

Parameters

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

Definition at line 408 of file PassiveRateGroupComponentAc.cpp.

Friends And Related Function Documentation

◆ PassiveRateGroupComponentBaseFriend

friend class PassiveRateGroupComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 35 of file PassiveRateGroupComponentAc.hpp.

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

Svc/PassiveRateGroup/PassiveRateGroupComponentAc.hpp
Svc/PassiveRateGroup/PassiveRateGroupComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ PassiveRateGroupComponentBase()

◆ ~PassiveRateGroupComponentBase()

Member Function Documentation

◆ CycleIn_handler()

◆ CycleIn_handlerBase()

◆ get_CycleIn_InputPort()

◆ getNum_CycleIn_InputPorts()

◆ getNum_RateGroupMemberOut_OutputPorts()

◆ getNum_Time_OutputPorts()

◆ getNum_Tlm_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_RateGroupMemberOut_OutputPort()

◆ isConnected_Time_OutputPort()

◆ isConnected_Tlm_OutputPort()

◆ RateGroupMemberOut_out()

◆ set_RateGroupMemberOut_OutputPort()

◆ set_Time_OutputPort()

◆ set_Tlm_OutputPort()

◆ tlmWrite_CycleCount()

◆ tlmWrite_CycleTime()

◆ tlmWrite_MaxCycleTime()

Friends And Related Function Documentation

◆ PassiveRateGroupComponentBaseFriend