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. More...
void	set_CycleOut_OutputPort (FwIndexType portNum, Svc::InputCyclePort *port)
	Connect port to CycleOut[portNum]. More...
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const FwIdType)
	Set the ID base. More...
FwIdType	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. More...
virtual	~LinuxTimerComponentBase ()
	Destroy LinuxTimerComponentBase object. More...
FwIndexType	getNum_CycleOut_OutputPorts () const
bool	isConnected_CycleOut_OutputPort (FwIndexType portNum)
void	CycleOut_out (FwIndexType portNum, Os::RawTime &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 (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...

Friends
class	LinuxTimerTesterBase
	Friend class tester to support autocoded test harness. More...
class	LinuxTimerTester
	Friend class tester implementation to support white-box testing. More...

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 42 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 91 of file LinuxTimerComponentAc.cpp.

~LinuxTimerComponentBase()

Svc::LinuxTimerComponentBase::~LinuxTimerComponentBase ( )

protectedvirtual

Destroy LinuxTimerComponentBase object.

Definition at line 98 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 133 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 108 of file LinuxTimerComponentAc.cpp.

init()

void Svc::LinuxTimerComponentBase::init

(

FwEnumStoreType

instance = 0

)

Initialize LinuxTimerComponentBase object.

Parameters

instance

The instance number

Definition at line 21 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 118 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 51 of file LinuxTimerComponentAc.cpp.

Friends And Related Function Documentation

LinuxTimerTester

friend class LinuxTimerTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 33 of file LinuxTimerComponentAc.hpp.

LinuxTimerTesterBase

friend class LinuxTimerTesterBase

friend

Friend class tester to support autocoded test harness.

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