Svc::RateGroupDriverComponentBase Class Reference

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

#include <Svc/RateGroupDriver/RateGroupDriverComponentAc.hpp>

Inheritance diagram for Svc::RateGroupDriverComponentBase:

Public Member Functions
void	init (NATIVE_INT_TYPE instance=0)
	Initialize RateGroupDriverComponentBase object. More...
Svc::InputCyclePort *	get_CycleIn_InputPort (NATIVE_INT_TYPE portNum)
void	set_CycleOut_OutputPort (NATIVE_INT_TYPE portNum, Svc::InputCyclePort *port)
	Connect port to CycleOut[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_CYCLEOUT_OUTPUT_PORTS = 3 }
	Enumerations for numbers of typed output ports. More...

Protected Member Functions
	RateGroupDriverComponentBase (const char *compName="")
	Construct RateGroupDriverComponentBase object. More...
virtual	~RateGroupDriverComponentBase ()
	Destroy RateGroupDriverComponentBase object. More...
NATIVE_INT_TYPE	getNum_CycleIn_InputPorts () const
NATIVE_INT_TYPE	getNum_CycleOut_OutputPorts () const
bool	isConnected_CycleOut_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	CycleOut_out (NATIVE_INT_TYPE portNum, Svc::TimerVal &cycleStart)
	Invoke output port CycleOut. 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	RateGroupDriverComponentBaseFriend
	Friend class for white-box testing. More...

Detailed Description

Auto-generated base for RateGroupDriver component.

A rate group driver component with input and output cycle ports

Definition at line 22 of file RateGroupDriverComponentAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_CYCLEIN_INPUT_PORTS

Definition at line 40 of file RateGroupDriverComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_CYCLEOUT_OUTPUT_PORTS

Definition at line 45 of file RateGroupDriverComponentAc.hpp.

Constructor & Destructor Documentation

RateGroupDriverComponentBase()

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

protected

Construct RateGroupDriverComponentBase object.

Parameters

compName

The component name

Definition at line 146 of file RateGroupDriverComponentAc.cpp.

~RateGroupDriverComponentBase()

Svc::RateGroupDriverComponentBase::~RateGroupDriverComponentBase ( )

protectedvirtual

Destroy RateGroupDriverComponentBase object.

Definition at line 153 of file RateGroupDriverComponentAc.cpp.

Member Function Documentation

CycleIn_handler()

virtual void Svc::RateGroupDriverComponentBase::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::RateGroupDriverComponentBase::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 200 of file RateGroupDriverComponentAc.cpp.

CycleOut_out()

void Svc::RateGroupDriverComponentBase::CycleOut_out ( NATIVE_INT_TYPE  portNum, Svc::TimerVal &  cycleStart  )

protected

Invoke output port CycleOut.

Parameters

portNum	The port number
cycleStart	Cycle start timer value

Definition at line 223 of file RateGroupDriverComponentAc.cpp.

get_CycleIn_InputPort()

Svc::InputCyclePort * Svc::RateGroupDriverComponentBase::get_CycleIn_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get typed input port at index

Returns

CycleIn[portNum]

Parameters

portNum

The port number

Definition at line 91 of file RateGroupDriverComponentAc.cpp.

getNum_CycleIn_InputPorts()

NATIVE_INT_TYPE Svc::RateGroupDriverComponentBase::getNum_CycleIn_InputPorts ( ) const

protected

Get the number of CycleIn input ports

Returns

The number of CycleIn input ports

Definition at line 163 of file RateGroupDriverComponentAc.cpp.

getNum_CycleOut_OutputPorts()

NATIVE_INT_TYPE Svc::RateGroupDriverComponentBase::getNum_CycleOut_OutputPorts ( ) const

protected

Get the number of CycleOut output ports

Returns

The number of CycleOut output ports

Definition at line 173 of file RateGroupDriverComponentAc.cpp.

init()

void Svc::RateGroupDriverComponentBase::init

(

NATIVE_INT_TYPE

instance = 0

)

Initialize RateGroupDriverComponentBase object.

Parameters

instance

The instance number

Definition at line 21 of file RateGroupDriverComponentAc.cpp.

isConnected_CycleOut_OutputPort()

bool Svc::RateGroupDriverComponentBase::isConnected_CycleOut_OutputPort ( NATIVE_INT_TYPE  portNum )

protected

Check whether port CycleOut is connected

Returns

Whether port CycleOut is connected

Parameters

portNum

The port number

Definition at line 183 of file RateGroupDriverComponentAc.cpp.

set_CycleOut_OutputPort()

void Svc::RateGroupDriverComponentBase::set_CycleOut_OutputPort	(	NATIVE_INT_TYPE	portNum,
		Svc::InputCyclePort *	port
	)

Connect port to CycleOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 106 of file RateGroupDriverComponentAc.cpp.

Friends And Related Function Documentation

RateGroupDriverComponentBaseFriend

friend class RateGroupDriverComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 31 of file RateGroupDriverComponentAc.hpp.

---

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

• Svc/RateGroupDriver/RateGroupDriverComponentAc.hpp
• Svc/RateGroupDriver/RateGroupDriverComponentAc.cpp