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

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

#include <Svc/LinuxTimer/LinuxTimerComponentAc.hpp>

Inheritance diagram for Svc::LinuxTimerComponentBase:
Fw::PassiveComponentBase Fw::ObjBase Svc::LinuxTimerComponentImpl

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 U32)
 Set the ID base. More...
 
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. 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 LinuxTimerComponentBaseFriend
 Friend class for white-box testing. More...
 
class LinuxTimerTesterBase
 Friend class tester to support autocoded test harness. 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
compNameThe 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
portNumThe port number
cycleStartCycle 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
instanceThe 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
portNumThe 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
portNumThe port number
portThe input port

Definition at line 51 of file LinuxTimerComponentAc.cpp.

Friends And Related Function Documentation

◆ LinuxTimerComponentBaseFriend

friend class LinuxTimerComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 31 of file LinuxTimerComponentAc.hpp.

◆ LinuxTimerTesterBase

friend class LinuxTimerTesterBase
friend

Friend class tester to support autocoded test harness.

Definition at line 33 of file LinuxTimerComponentAc.hpp.


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