F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Svc::PosixTimeComponentBase Class Referenceabstract

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

#include <Svc/PosixTime/PosixTimeComponentAc.hpp>

Inheritance diagram for Svc::PosixTimeComponentBase:
Fw::PassiveComponentBase Fw::ObjBase Svc::PosixTime

Public Member Functions

void init (FwEnumStoreType instance=0)
 Initialize PosixTimeComponentBase object. More...
 
Fw::InputTimePortget_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_TIMEGETPORT_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 

Protected Member Functions

 PosixTimeComponentBase (const char *compName="")
 Construct PosixTimeComponentBase object. More...
 
virtual ~PosixTimeComponentBase ()
 Destroy PosixTimeComponentBase object. More...
 
FwIndexType getNum_timeGetPort_InputPorts () const
 
virtual void timeGetPort_handler (FwIndexType portNum, Fw::Time &time)=0
 Handler for input port timeGetPort. 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 PosixTimeComponentBaseFriend
 Friend class for white-box testing. More...
 
class PosixTimeTesterBase
 Friend class tester to support autocoded test harness. More...
 

Detailed Description

Auto-generated base for PosixTime component.

A component for getting time

Definition at line 22 of file PosixTimeComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_TIMEGETPORT_INPUT_PORTS 

Definition at line 42 of file PosixTimeComponentAc.hpp.

Constructor & Destructor Documentation

◆ PosixTimeComponentBase()

Svc::PosixTimeComponentBase::PosixTimeComponentBase ( const char *  compName = "")
protected

Construct PosixTimeComponentBase object.

Parameters
compNameThe component name

Definition at line 71 of file PosixTimeComponentAc.cpp.

◆ ~PosixTimeComponentBase()

Svc::PosixTimeComponentBase::~PosixTimeComponentBase ( )
protectedvirtual

Destroy PosixTimeComponentBase object.

Definition at line 78 of file PosixTimeComponentAc.cpp.

Member Function Documentation

◆ get_timeGetPort_InputPort()

Fw::InputTimePort * Svc::PosixTimeComponentBase::get_timeGetPort_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
timeGetPort[portNum]
Parameters
portNumThe port number

Definition at line 56 of file PosixTimeComponentAc.cpp.

◆ getNum_timeGetPort_InputPorts()

FwIndexType Svc::PosixTimeComponentBase::getNum_timeGetPort_InputPorts ( ) const
protected

Get the number of timeGetPort input ports

Returns
The number of timeGetPort input ports

Definition at line 88 of file PosixTimeComponentAc.cpp.

◆ init()

void Svc::PosixTimeComponentBase::init ( FwEnumStoreType  instance = 0)

Initialize PosixTimeComponentBase object.

Parameters
instanceThe instance number

Definition at line 21 of file PosixTimeComponentAc.cpp.

◆ timeGetPort_handler()

virtual void Svc::PosixTimeComponentBase::timeGetPort_handler ( FwIndexType  portNum,
Fw::Time time 
)
protectedpure virtual

Handler for input port timeGetPort.

Parameters
portNumThe port number
timeReference to Time object

Implemented in Svc::PosixTime.

◆ timeGetPort_handlerBase()

void Svc::PosixTimeComponentBase::timeGetPort_handlerBase ( FwIndexType  portNum,
Fw::Time time 
)
protected

Handler base-class function for input port timeGetPort.

Parameters
portNumThe port number
timeReference to Time object

Definition at line 100 of file PosixTimeComponentAc.cpp.

Friends And Related Function Documentation

◆ PosixTimeComponentBaseFriend

friend class PosixTimeComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 31 of file PosixTimeComponentAc.hpp.

◆ PosixTimeTesterBase

friend class PosixTimeTesterBase
friend

Friend class tester to support autocoded test harness.

Definition at line 33 of file PosixTimeComponentAc.hpp.


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