Svc::LinuxTimerComponentBase Class Reference

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

#include <Svc/LinuxTimer/LinuxTimerComponentAc.hpp>

Inheritance diagram for Svc::LinuxTimerComponentBase:

Public Member Functions
void	init (FwEnumStoreType instance=0)
	Initialize LinuxTimerComponentBase object.
void	set_CycleOut_OutputPort (FwIndexType portNum, Svc::InputCyclePort *port)
	Connect port to CycleOut[portNum].
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base.
U32	getIdBase () const

Protected Types
enum	{ NUM_CYCLEOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...

Protected Member Functions
	LinuxTimerComponentBase (const char *compName="")
	Construct LinuxTimerComponentBase object.
virtual	~LinuxTimerComponentBase ()
	Destroy LinuxTimerComponentBase object.
FwIndexType	getNum_CycleOut_OutputPorts () const
bool	isConnected_CycleOut_OutputPort (FwIndexType portNum)
void	CycleOut_out (FwIndexType portNum, Os::RawTime &cycleStart)
	Invoke output port CycleOut.
Protected Member Functions inherited from Fw::PassiveComponentBase
	PassiveComponentBase (const char *name)
	Named constructor.
virtual	~PassiveComponentBase ()
	Destructor.
void	init (NATIVE_INT_TYPE instance)
	Initialization function.
NATIVE_INT_TYPE	getInstance () const
Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor.
virtual	~ObjBase ()
	Destructor.
void	init ()
	Object initializer.

Friends
class	LinuxTimerComponentBaseFriend
	Friend class for white-box testing.

Detailed Description

Auto-generated base for LinuxTimer component.

A Linux interval timer

Definition at line 22 of file LinuxTimerComponentAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_CYCLEOUT_OUTPUT_PORTS

Definition at line 40 of file LinuxTimerComponentAc.hpp.

Constructor & Destructor Documentation

LinuxTimerComponentBase()

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

protected

Construct LinuxTimerComponentBase object.

Parameters

compName

The component name

Definition at line 90 of file LinuxTimerComponentAc.cpp.

~LinuxTimerComponentBase()

Svc::LinuxTimerComponentBase::~LinuxTimerComponentBase ( )

protectedvirtual

Destroy LinuxTimerComponentBase object.

Definition at line 97 of file LinuxTimerComponentAc.cpp.

Member Function Documentation

CycleOut_out()

void Svc::LinuxTimerComponentBase::CycleOut_out ( FwIndexType  portNum, Os::RawTime &  cycleStart  )

protected

Invoke output port CycleOut.

Parameters

portNum	The port number
cycleStart	Cycle start timestamp

Definition at line 132 of file LinuxTimerComponentAc.cpp.

getNum_CycleOut_OutputPorts()

FwIndexType Svc::LinuxTimerComponentBase::getNum_CycleOut_OutputPorts ( ) const

protected

Get the number of CycleOut output ports

Returns

The number of CycleOut output ports

Definition at line 107 of file LinuxTimerComponentAc.cpp.

init()

void Svc::LinuxTimerComponentBase::init

(

FwEnumStoreType

instance = 0

)

Initialize LinuxTimerComponentBase object.

Parameters

instance

The instance number

Definition at line 20 of file LinuxTimerComponentAc.cpp.

isConnected_CycleOut_OutputPort()

bool Svc::LinuxTimerComponentBase::isConnected_CycleOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port CycleOut is connected

Returns

Whether port CycleOut is connected

Parameters

portNum

The port number

Definition at line 117 of file LinuxTimerComponentAc.cpp.

set_CycleOut_OutputPort()

void Svc::LinuxTimerComponentBase::set_CycleOut_OutputPort	(	FwIndexType	portNum,
		Svc::InputCyclePort *	port
	)

Connect port to CycleOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 50 of file LinuxTimerComponentAc.cpp.

Friends And Related Symbol Documentation

LinuxTimerComponentBaseFriend

friend class LinuxTimerComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 31 of file LinuxTimerComponentAc.hpp.

---

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

• Svc/LinuxTimer/LinuxTimerComponentAc.hpp
• Svc/LinuxTimer/LinuxTimerComponentAc.cpp