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

#include <Svc/PassiveRateGroup/PassiveRateGroup.hpp>

Inheritance diagram for Svc::PassiveRateGroup:
Svc::PassiveRateGroupComponentBase Fw::PassiveComponentBase Fw::ObjBase

Public Member Functions

 PassiveRateGroup (const char *compName)
 PassiveRateGroupImpl constructor. More...
 
void configure (NATIVE_INT_TYPE contexts[], NATIVE_INT_TYPE numContexts)
 PassiveRateGroupImpl initialization function. More...
 
 ~PassiveRateGroup ()
 PassiveRateGroupImpl destructor. More...
 
- Public Member Functions inherited from Svc::PassiveRateGroupComponentBase
void init (FwEnumStoreType instance=0)
 Initialize PassiveRateGroupComponentBase object. More...
 
Svc::InputCyclePortget_CycleIn_InputPort (FwIndexType portNum)
 
void set_Time_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
 Connect port to Time[portNum]. More...
 
void set_Tlm_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port)
 Connect port to Tlm[portNum]. More...
 
void set_RateGroupMemberOut_OutputPort (FwIndexType portNum, Svc::InputSchedPort *port)
 Connect port to RateGroupMemberOut[portNum]. More...
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base. More...
 
U32 getIdBase () const
 

Additional Inherited Members

- Protected Types inherited from Svc::PassiveRateGroupComponentBase
enum  { NUM_CYCLEIN_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  { NUM_TIME_OUTPUT_PORTS = 1 , NUM_TLM_OUTPUT_PORTS = 1 }
 Enumerations for numbers of special output ports. More...
 
enum  { NUM_RATEGROUPMEMBEROUT_OUTPUT_PORTS = 10 }
 Enumerations for numbers of typed output ports. More...
 
enum  { CHANNELID_MAXCYCLETIME = 0x0 , CHANNELID_CYCLETIME = 0x1 , CHANNELID_CYCLECOUNT = 0x2 }
 Channel IDs. More...
 
- Protected Member Functions inherited from Svc::PassiveRateGroupComponentBase
 PassiveRateGroupComponentBase (const char *compName="")
 Construct PassiveRateGroupComponentBase object. More...
 
virtual ~PassiveRateGroupComponentBase ()
 Destroy PassiveRateGroupComponentBase object. More...
 
FwIndexType getNum_CycleIn_InputPorts () const
 
FwIndexType getNum_Time_OutputPorts () const
 
FwIndexType getNum_Tlm_OutputPorts () const
 
FwIndexType getNum_RateGroupMemberOut_OutputPorts () const
 
bool isConnected_Time_OutputPort (FwIndexType portNum)
 
bool isConnected_Tlm_OutputPort (FwIndexType portNum)
 
bool isConnected_RateGroupMemberOut_OutputPort (FwIndexType portNum)
 
void CycleIn_handlerBase (FwIndexType portNum, Os::RawTime &cycleStart)
 Handler base-class function for input port CycleIn. More...
 
void RateGroupMemberOut_out (FwIndexType portNum, U32 context)
 Invoke output port RateGroupMemberOut. More...
 
void tlmWrite_MaxCycleTime (U32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CycleTime (U32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CycleCount (U32 arg, Fw::Time _tlmTime=Fw::Time())
 
Fw::Time getTime ()
 
- Protected Member Functions inherited from Fw::PassiveComponentBase
 PassiveComponentBase (const char *name)
 Named constructor. More...
 
virtual ~PassiveComponentBase ()
 Destructor. More...
 
void init (NATIVE_INT_TYPE instance)
 Initialization function. More...
 
NATIVE_INT_TYPE 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...
 

Detailed Description

Definition at line 30 of file PassiveRateGroup.hpp.

Constructor & Destructor Documentation

◆ PassiveRateGroup()

Svc::PassiveRateGroup::PassiveRateGroup ( const char *  compName)
explicit

PassiveRateGroupImpl constructor.

The constructor of the class clears all the flags and copies the contents of the context array to private storage.

Parameters
compNameName of the component

Definition at line 20 of file PassiveRateGroup.cpp.

◆ ~PassiveRateGroup()

Svc::PassiveRateGroup::~PassiveRateGroup ( )

PassiveRateGroupImpl destructor.

The destructor of the class is empty

Definition at line 24 of file PassiveRateGroup.cpp.

Member Function Documentation

◆ configure()

void Svc::PassiveRateGroup::configure ( NATIVE_INT_TYPE  contexts[],
NATIVE_INT_TYPE  numContexts 
)

PassiveRateGroupImpl initialization function.

PassiveRateGroup configuration function

The configuration function takes an array of context values to pass to members of the rate group.

Parameters
contextsArray of integers that contain the context values that will be sent to each member component. The index of the array corresponds to the output port number.
numContextsThe number of elements in the context array.

Definition at line 26 of file PassiveRateGroup.cpp.


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