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

#include <Svc/ActivePhaser/ActivePhaserComponentAc.hpp>

Inheritance diagram for Svc::ActivePhaserComponentBase:

Public Member Functions
void	init (FwSizeType queueDepth, FwEnumStoreType instance=0)
	Initialize ActivePhaserComponentBase object. More...

Svc::InputCyclePort *	get_CycleIn_InputPort (FwIndexType portNum)

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_PhaserMemberOut_OutputPort (FwIndexType portNum, Svc::InputSchedPort *port)
	Connect port to PhaserMemberOut[portNum]. More...

Public Member Functions inherited from Fw::ActiveComponentBase
void	start (FwTaskPriorityType priority=Os::Task::TASK_PRIORITY_DEFAULT, FwSizeType stackSize=Os::Task::TASK_DEFAULT, FwSizeType cpuAffinity=Os::Task::TASK_DEFAULT, FwTaskIdType identifier=static_cast< FwTaskIdType >(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 FwIdType)
	Set the ID base. More...

FwIdType	getIdBase () const

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

enum	{ NUM_LOGOUT_OUTPUT_PORTS = 1, NUM_LOGTEXTOUT_OUTPUT_PORTS = 1, NUM_TIMECALLER_OUTPUT_PORTS = 1, NUM_TLMOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...

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

enum	{ EVENTID_MISSEDDEADLINE = 0x0 }
	Event IDs. More...

enum	{ EVENTID_MISSEDDEADLINE_THROTTLE = 5 }
	Event throttle values: sets initial value of countdown variables. More...

Protected Types inherited from Fw::ActiveComponentBase
enum	Lifecycle { CREATED, DISPATCHING, FINALIZING, DONE }
	Tracks the lifecycle of the component. More...

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

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

bool	isConnected_logOut_OutputPort (FwIndexType portNum)

bool	isConnected_timeCaller_OutputPort (FwIndexType portNum)

bool	isConnected_tlmOut_OutputPort (FwIndexType portNum)

bool	isConnected_PhaserMemberOut_OutputPort (FwIndexType portNum)

virtual void	CycleIn_handler (FwIndexType portNum, Os::RawTime &cycleStart)=0
	Handler for input port CycleIn. More...

void	CycleIn_handlerBase (FwIndexType portNum, Os::RawTime &cycleStart)
	Handler base-class function for input port CycleIn. More...

virtual void	CycleIn_preMsgHook (FwIndexType portNum, Os::RawTime &cycleStart)
	Pre-message hook for async input port CycleIn. More...

void	PhaserMemberOut_out (FwIndexType portNum, U32 context)
	Invoke output port PhaserMemberOut. More...

virtual void	Tick_internalInterfaceHandler ()=0
	Internal interface handler for Tick. More...

void	Tick_internalInterfaceInvoke ()
	Internal interface base-class function for Tick. More...

void	log_WARNING_HI_MissedDeadline (FwIndexType p, U32 start, U32 length, U32 ticks)

void	log_WARNING_HI_MissedDeadline_ThrottleClear ()
	Reset throttle value for MissedDeadline. More...

Fw::Time	getTime () const

Protected Member Functions inherited from Fw::ActiveComponentBase
	ActiveComponentBase (const char *name)
	Constructor. More...

virtual	~ActiveComponentBase ()
	Destructor. More...

void	init (FwEnumStoreType 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 (FwEnumStoreType instance)
	initialization function More...

Os::Queue::Status	createQueue (FwSizeType depth, FwSizeType msgSize)

FwSizeType	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 (FwEnumStoreType instance)
	Initialization function. More...

FwEnumStoreType	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...

Static Protected Member Functions
static constexpr FwIndexType	getNum_CycleIn_InputPorts ()

static constexpr FwIndexType	getNum_logOut_OutputPorts ()

static constexpr FwIndexType	getNum_timeCaller_OutputPorts ()

static constexpr FwIndexType	getNum_tlmOut_OutputPorts ()

static constexpr FwIndexType	getNum_PhaserMemberOut_OutputPorts ()

Friends
class	ActivePhaserTesterBase
	Friend class tester to support autocoded test harness. More...

class	ActivePhaserTester
	Friend class tester implementation to support 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 ActivePhaser component.

A rate group active component that schedules output port calls at pre-defined start times

Definition at line 34 of file ActivePhaserComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_CYCLEIN_INPUT_PORTS

Definition at line 54 of file ActivePhaserComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_LOGOUT_OUTPUT_PORTS
NUM_LOGTEXTOUT_OUTPUT_PORTS
NUM_TIMECALLER_OUTPUT_PORTS
NUM_TLMOUT_OUTPUT_PORTS

Definition at line 59 of file ActivePhaserComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_PHASERMEMBEROUT_OUTPUT_PORTS

Definition at line 67 of file ActivePhaserComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_MISSEDDEADLINE	Warning event that rate group has had a missed deadline.

Definition at line 72 of file ActivePhaserComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event throttle values: sets initial value of countdown variables.

Enumerator
EVENTID_MISSEDDEADLINE_THROTTLE	Throttle reset count for MissedDeadline.

Definition at line 77 of file ActivePhaserComponentAc.hpp.

Constructor & Destructor Documentation

◆ ActivePhaserComponentBase()

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

protected

Construct ActivePhaserComponentBase object.

Parameters

compName The component name

Definition at line 402 of file ActivePhaserComponentAc.cpp.

◆ ~ActivePhaserComponentBase()

Svc::ActivePhaserComponentBase::~ActivePhaserComponentBase ( )

protectedvirtual

Destroy ActivePhaserComponentBase object.

Definition at line 409 of file ActivePhaserComponentAc.cpp.

Member Function Documentation

◆ CycleIn_handler()

virtual void Svc::ActivePhaserComponentBase::CycleIn_handler	(	FwIndexType	portNum,
		Os::RawTime &	cycleStart
	)

protectedpure virtual

Handler for input port CycleIn.

Parameters

portNum	The port number
cycleStart	Cycle start timestamp

◆ CycleIn_handlerBase()

void Svc::ActivePhaserComponentBase::CycleIn_handlerBase	(	FwIndexType	portNum,
		Os::RawTime &	cycleStart
	)

protected

Handler base-class function for input port CycleIn.

Parameters

portNum	The port number
cycleStart	Cycle start timestamp

Definition at line 488 of file ActivePhaserComponentAc.cpp.

◆ CycleIn_preMsgHook()

void Svc::ActivePhaserComponentBase::CycleIn_preMsgHook	(	FwIndexType	portNum,
		Os::RawTime &	cycleStart
	)

protectedvirtual

Pre-message hook for async input port CycleIn.

Parameters

portNum	The port number
cycleStart	Cycle start timestamp

Definition at line 554 of file ActivePhaserComponentAc.cpp.

◆ get_CycleIn_InputPort()

Svc::InputCyclePort * Svc::ActivePhaserComponentBase::get_CycleIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: CycleIn[portNum]

Parameters

portNum The port number

Definition at line 215 of file ActivePhaserComponentAc.cpp.

◆ getNum_CycleIn_InputPorts()

static constexpr FwIndexType Svc::ActivePhaserComponentBase::getNum_CycleIn_InputPorts ( )

inlinestaticprotected

Get the number of CycleIn input ports

Returns: The number of CycleIn input ports

Definition at line 229 of file ActivePhaserComponentAc.hpp.

◆ getNum_logOut_OutputPorts()

static constexpr FwIndexType Svc::ActivePhaserComponentBase::getNum_logOut_OutputPorts ( )

inlinestaticprotected

Get the number of logOut output ports

Returns: The number of logOut output ports

Definition at line 242 of file ActivePhaserComponentAc.hpp.

◆ getNum_PhaserMemberOut_OutputPorts()

static constexpr FwIndexType Svc::ActivePhaserComponentBase::getNum_PhaserMemberOut_OutputPorts ( )

inlinestaticprotected

Get the number of PhaserMemberOut output ports

Returns: The number of PhaserMemberOut output ports

Definition at line 280 of file ActivePhaserComponentAc.hpp.

◆ getNum_timeCaller_OutputPorts()

static constexpr FwIndexType Svc::ActivePhaserComponentBase::getNum_timeCaller_OutputPorts ( )

inlinestaticprotected

Get the number of timeCaller output ports

Returns: The number of timeCaller output ports

Definition at line 260 of file ActivePhaserComponentAc.hpp.

◆ getNum_tlmOut_OutputPorts()

static constexpr FwIndexType Svc::ActivePhaserComponentBase::getNum_tlmOut_OutputPorts ( )

inlinestaticprotected

Get the number of tlmOut output ports

Returns: The number of tlmOut output ports

Definition at line 267 of file ActivePhaserComponentAc.hpp.

◆ getTime()

Fw::Time Svc::ActivePhaserComponentBase::getTime ( ) const

protected

Get the time

\return The current time

Definition at line 791 of file ActivePhaserComponentAc.cpp.

◆ init()

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

Initialize ActivePhaserComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 70 of file ActivePhaserComponentAc.cpp.

◆ isConnected_logOut_OutputPort()

bool Svc::ActivePhaserComponentBase::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 419 of file ActivePhaserComponentAc.cpp.

◆ isConnected_PhaserMemberOut_OutputPort()

bool Svc::ActivePhaserComponentBase::isConnected_PhaserMemberOut_OutputPort ( FwIndexType portNum )

protected

Check whether port PhaserMemberOut is connected

Returns: Whether port PhaserMemberOut is connected

Parameters

portNum The port number

Definition at line 471 of file ActivePhaserComponentAc.cpp.

◆ isConnected_timeCaller_OutputPort()

bool Svc::ActivePhaserComponentBase::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 445 of file ActivePhaserComponentAc.cpp.

◆ isConnected_tlmOut_OutputPort()

bool Svc::ActivePhaserComponentBase::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 456 of file ActivePhaserComponentAc.cpp.

◆ log_WARNING_HI_MissedDeadline()

void Svc::ActivePhaserComponentBase::log_WARNING_HI_MissedDeadline	(	FwIndexType	p,
		U32	start,
		U32	length,
		U32	ticks
	)

protected

Log event MissedDeadline

Warning event that rate group has had a missed deadline

Parameters

p	Port that is delayed
start	Start of execution window
length	Length of the execution window
ticks	Time in ticks the deadline was late

Definition at line 630 of file ActivePhaserComponentAc.cpp.

◆ log_WARNING_HI_MissedDeadline_ThrottleClear()

void Svc::ActivePhaserComponentBase::log_WARNING_HI_MissedDeadline_ThrottleClear ( )

protected

Reset throttle value for MissedDeadline.

Definition at line 780 of file ActivePhaserComponentAc.cpp.

◆ PhaserMemberOut_out()

void Svc::ActivePhaserComponentBase::PhaserMemberOut_out	(	FwIndexType	portNum,
		U32	context
	)

protected

Invoke output port PhaserMemberOut.

Parameters

portNum	The port number
context	The call order

Definition at line 567 of file ActivePhaserComponentAc.cpp.

◆ set_logOut_OutputPort()

void Svc::ActivePhaserComponentBase::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 230 of file ActivePhaserComponentAc.cpp.

◆ set_PhaserMemberOut_OutputPort()

void Svc::ActivePhaserComponentBase::set_PhaserMemberOut_OutputPort	(	FwIndexType	portNum,
		Svc::InputSchedPort *	port
	)

Connect port to PhaserMemberOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 294 of file ActivePhaserComponentAc.cpp.

◆ set_timeCaller_OutputPort()

void Svc::ActivePhaserComponentBase::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 262 of file ActivePhaserComponentAc.cpp.

◆ set_tlmOut_OutputPort()

void Svc::ActivePhaserComponentBase::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 276 of file ActivePhaserComponentAc.cpp.

◆ Tick_internalInterfaceHandler()

virtual void Svc::ActivePhaserComponentBase::Tick_internalInterfaceHandler ( )

protectedpure virtual

Internal interface handler for Tick.

◆ Tick_internalInterfaceInvoke()

void Svc::ActivePhaserComponentBase::Tick_internalInterfaceInvoke ( )

protected

Internal interface base-class function for Tick.

Definition at line 591 of file ActivePhaserComponentAc.cpp.

Friends And Related Function Documentation

◆ ActivePhaserTester

friend class ActivePhaserTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 45 of file ActivePhaserComponentAc.hpp.

◆ ActivePhaserTesterBase

friend class ActivePhaserTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 43 of file ActivePhaserComponentAc.hpp.

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

Svc/ActivePhaser/ActivePhaserComponentAc.hpp
Svc/ActivePhaser/ActivePhaserComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ ActivePhaserComponentBase()

◆ ~ActivePhaserComponentBase()

Member Function Documentation

◆ CycleIn_handler()

◆ CycleIn_handlerBase()

◆ CycleIn_preMsgHook()

◆ get_CycleIn_InputPort()

◆ getNum_CycleIn_InputPorts()

◆ getNum_logOut_OutputPorts()

◆ getNum_PhaserMemberOut_OutputPorts()

◆ getNum_timeCaller_OutputPorts()

◆ getNum_tlmOut_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_logOut_OutputPort()

◆ isConnected_PhaserMemberOut_OutputPort()

◆ isConnected_timeCaller_OutputPort()

◆ isConnected_tlmOut_OutputPort()

◆ log_WARNING_HI_MissedDeadline()

◆ log_WARNING_HI_MissedDeadline_ThrottleClear()

◆ PhaserMemberOut_out()

◆ set_logOut_OutputPort()

◆ set_PhaserMemberOut_OutputPort()

◆ set_timeCaller_OutputPort()

◆ set_tlmOut_OutputPort()

◆ Tick_internalInterfaceHandler()

◆ Tick_internalInterfaceInvoke()

Friends And Related Function Documentation

◆ ActivePhaserTester

◆ ActivePhaserTesterBase