Svc::OsTimeComponentBase Class Reference

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

#include <Svc/OsTime/OsTimeComponentAc.hpp>

Inheritance diagram for Svc::OsTimeComponentBase:

Public Member Functions
void	init (FwEnumStoreType instance=0)
	Initialize OsTimeComponentBase object. More...
Svc::InputOsTimeEpochPort *	get_setEpoch_InputPort (FwIndexType portNum)
Fw::InputTimePort *	get_timeGetPort_InputPort (FwIndexType portNum)
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base. More...
U32	getIdBase () const

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

Protected Member Functions
	OsTimeComponentBase (const char *compName="")
	Construct OsTimeComponentBase object. More...
virtual	~OsTimeComponentBase ()
	Destroy OsTimeComponentBase object. More...
FwIndexType	getNum_setEpoch_InputPorts () const
FwIndexType	getNum_timeGetPort_InputPorts () const
virtual void	setEpoch_handler (FwIndexType portNum, const Fw::Time &fw_time, const Os::RawTime &os_time)=0
	Handler for input port setEpoch. More...
virtual void	timeGetPort_handler (FwIndexType portNum, Fw::Time &time)=0
	Handler for input port timeGetPort. More...
void	setEpoch_handlerBase (FwIndexType portNum, const Fw::Time &fw_time, const Os::RawTime &os_time)
	Handler base-class function for input port setEpoch. More...
void	timeGetPort_handlerBase (FwIndexType portNum, Fw::Time &time)
	Handler base-class function for input port timeGetPort. 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	OsTimeComponentBaseFriend
	Friend class for white-box testing. More...
class	OsTimeTesterBase
	Friend class tester to support autocoded test harness. More...

Detailed Description

Auto-generated base for OsTime component.

A time component using OSAL RawTime abstractions

Definition at line 23 of file OsTimeComponentAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_SETEPOCH_INPUT_PORTS
NUM_TIMEGETPORT_INPUT_PORTS

Definition at line 43 of file OsTimeComponentAc.hpp.

Constructor & Destructor Documentation

OsTimeComponentBase()

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

protected

Construct OsTimeComponentBase object.

Parameters

compName

The component name

Definition at line 106 of file OsTimeComponentAc.cpp.

~OsTimeComponentBase()

Svc::OsTimeComponentBase::~OsTimeComponentBase ( )

protectedvirtual

Destroy OsTimeComponentBase object.

Definition at line 113 of file OsTimeComponentAc.cpp.

Member Function Documentation

get_setEpoch_InputPort()

Svc::InputOsTimeEpochPort * Svc::OsTimeComponentBase::get_setEpoch_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

setEpoch[portNum]

Parameters

portNum

The port number

Definition at line 80 of file OsTimeComponentAc.cpp.

get_timeGetPort_InputPort()

Fw::InputTimePort * Svc::OsTimeComponentBase::get_timeGetPort_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

timeGetPort[portNum]

Parameters

portNum

The port number

Definition at line 91 of file OsTimeComponentAc.cpp.

getNum_setEpoch_InputPorts()

FwIndexType Svc::OsTimeComponentBase::getNum_setEpoch_InputPorts ( ) const

protected

Get the number of setEpoch input ports

Returns

The number of setEpoch input ports

Definition at line 123 of file OsTimeComponentAc.cpp.

getNum_timeGetPort_InputPorts()

FwIndexType Svc::OsTimeComponentBase::getNum_timeGetPort_InputPorts ( ) const

protected

Get the number of timeGetPort input ports

Returns

The number of timeGetPort input ports

Definition at line 129 of file OsTimeComponentAc.cpp.

init()

void Svc::OsTimeComponentBase::init

(

FwEnumStoreType

instance = 0

)

Initialize OsTimeComponentBase object.

Parameters

instance

The instance number

Definition at line 21 of file OsTimeComponentAc.cpp.

setEpoch_handler()

virtual void Svc::OsTimeComponentBase::setEpoch_handler ( FwIndexType  portNum, const Fw::Time &  fw_time, const Os::RawTime &  os_time  )

protectedpure virtual

Handler for input port setEpoch.

Parameters

portNum

The port number

setEpoch_handlerBase()

void Svc::OsTimeComponentBase::setEpoch_handlerBase ( FwIndexType  portNum, const Fw::Time &  fw_time, const Os::RawTime &  os_time  )

protected

Handler base-class function for input port setEpoch.

Parameters

portNum

The port number

Definition at line 141 of file OsTimeComponentAc.cpp.

timeGetPort_handler()

virtual void Svc::OsTimeComponentBase::timeGetPort_handler ( FwIndexType  portNum, Fw::Time &  time  )

protectedpure virtual

Handler for input port timeGetPort.

Parameters

portNum	The port number
time	Reference to Time object

timeGetPort_handlerBase()

void Svc::OsTimeComponentBase::timeGetPort_handlerBase ( FwIndexType  portNum, Fw::Time &  time  )

protected

Handler base-class function for input port timeGetPort.

Parameters

portNum	The port number
time	Reference to Time object

Definition at line 162 of file OsTimeComponentAc.cpp.

Friends And Related Function Documentation

OsTimeComponentBaseFriend

friend class OsTimeComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 32 of file OsTimeComponentAc.hpp.

OsTimeTesterBase

friend class OsTimeTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 34 of file OsTimeComponentAc.hpp.

---

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

• Svc/OsTime/OsTimeComponentAc.hpp
• Svc/OsTime/OsTimeComponentAc.cpp