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

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

#include <Svc/FatalHandler/FatalHandlerComponentAc.hpp>

Inheritance diagram for Svc::FatalHandlerComponentBase:
Fw::PassiveComponentBase Fw::ObjBase Svc::FatalHandlerComponentImpl

Public Member Functions

void init (FwEnumStoreType instance=0)
 Initialize FatalHandlerComponentBase object. More...
 
Svc::InputFatalEventPortget_FatalReceive_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_FATALRECEIVE_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 

Protected Member Functions

 FatalHandlerComponentBase (const char *compName="")
 Construct FatalHandlerComponentBase object. More...
 
virtual ~FatalHandlerComponentBase ()
 Destroy FatalHandlerComponentBase object. More...
 
FwIndexType getNum_FatalReceive_InputPorts () const
 
virtual void FatalReceive_handler (FwIndexType portNum, FwEventIdType Id)=0
 Handler for input port FatalReceive. More...
 
void FatalReceive_handlerBase (FwIndexType portNum, FwEventIdType Id)
 Handler base-class function for input port FatalReceive. More...
 
- 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...
 

Friends

class FatalHandlerComponentBaseFriend
 Friend class for white-box testing. More...
 

Detailed Description

Auto-generated base for FatalHandler component.

Handles FATAL calls

Definition at line 22 of file FatalHandlerComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_FATALRECEIVE_INPUT_PORTS 

Definition at line 40 of file FatalHandlerComponentAc.hpp.

Constructor & Destructor Documentation

◆ FatalHandlerComponentBase()

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

Construct FatalHandlerComponentBase object.

Parameters
compNameThe component name

Definition at line 71 of file FatalHandlerComponentAc.cpp.

◆ ~FatalHandlerComponentBase()

Svc::FatalHandlerComponentBase::~FatalHandlerComponentBase ( )
protectedvirtual

Destroy FatalHandlerComponentBase object.

Definition at line 78 of file FatalHandlerComponentAc.cpp.

Member Function Documentation

◆ FatalReceive_handler()

virtual void Svc::FatalHandlerComponentBase::FatalReceive_handler ( FwIndexType  portNum,
FwEventIdType  Id 
)
protectedpure virtual

Handler for input port FatalReceive.

Parameters
portNumThe port number
IdThe ID of the FATAL event

◆ FatalReceive_handlerBase()

void Svc::FatalHandlerComponentBase::FatalReceive_handlerBase ( FwIndexType  portNum,
FwEventIdType  Id 
)
protected

Handler base-class function for input port FatalReceive.

Parameters
portNumThe port number
IdThe ID of the FATAL event

Definition at line 100 of file FatalHandlerComponentAc.cpp.

◆ get_FatalReceive_InputPort()

Svc::InputFatalEventPort * Svc::FatalHandlerComponentBase::get_FatalReceive_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
FatalReceive[portNum]
Parameters
portNumThe port number

Definition at line 56 of file FatalHandlerComponentAc.cpp.

◆ getNum_FatalReceive_InputPorts()

FwIndexType Svc::FatalHandlerComponentBase::getNum_FatalReceive_InputPorts ( ) const
protected

Get the number of FatalReceive input ports

Returns
The number of FatalReceive input ports

Definition at line 88 of file FatalHandlerComponentAc.cpp.

◆ init()

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

Initialize FatalHandlerComponentBase object.

Parameters
instanceThe instance number

Definition at line 21 of file FatalHandlerComponentAc.cpp.

Friends And Related Function Documentation

◆ FatalHandlerComponentBaseFriend

friend class FatalHandlerComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 31 of file FatalHandlerComponentAc.hpp.


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