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

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

#include <Svc/ComStub/ComStubComponentAc.hpp>

Inheritance diagram for Svc::ComStubComponentBase:
Fw::PassiveComponentBase Fw::ObjBase Svc::ComStub

Public Member Functions

void init (FwEnumStoreType instance=0)
 Initialize ComStubComponentBase object. More...
 
Drv::InputByteStreamSendPortget_comDataIn_InputPort (FwIndexType portNum)
 
Drv::InputByteStreamReadyPortget_drvConnected_InputPort (FwIndexType portNum)
 
Drv::InputByteStreamRecvPortget_drvDataIn_InputPort (FwIndexType portNum)
 
void set_comDataOut_OutputPort (FwIndexType portNum, Drv::InputByteStreamRecvPort *port)
 Connect port to comDataOut[portNum]. More...
 
void set_comStatus_OutputPort (FwIndexType portNum, Fw::InputSuccessConditionPort *port)
 Connect port to comStatus[portNum]. More...
 
void set_drvDataOut_OutputPort (FwIndexType portNum, Drv::InputByteStreamSendPort *port)
 Connect port to drvDataOut[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_COMDATAIN_INPUT_PORTS = 1, NUM_DRVCONNECTED_INPUT_PORTS = 1, NUM_DRVDATAIN_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  { NUM_COMDATAOUT_OUTPUT_PORTS = 1, NUM_COMSTATUS_OUTPUT_PORTS = 1, NUM_DRVDATAOUT_OUTPUT_PORTS = 1 }
 Enumerations for numbers of typed output ports. More...
 

Protected Member Functions

 ComStubComponentBase (const char *compName="")
 Construct ComStubComponentBase object. More...
 
virtual ~ComStubComponentBase ()
 Destroy ComStubComponentBase object. More...
 
FwIndexType getNum_comDataIn_InputPorts () const
 
FwIndexType getNum_drvConnected_InputPorts () const
 
FwIndexType getNum_drvDataIn_InputPorts () const
 
FwIndexType getNum_comDataOut_OutputPorts () const
 
FwIndexType getNum_comStatus_OutputPorts () const
 
FwIndexType getNum_drvDataOut_OutputPorts () const
 
bool isConnected_comDataOut_OutputPort (FwIndexType portNum)
 
bool isConnected_comStatus_OutputPort (FwIndexType portNum)
 
bool isConnected_drvDataOut_OutputPort (FwIndexType portNum)
 
virtual Drv::SendStatus comDataIn_handler (FwIndexType portNum, Fw::Buffer &sendBuffer)=0
 Handler for input port comDataIn. More...
 
virtual void drvConnected_handler (FwIndexType portNum)=0
 Handler for input port drvConnected. More...
 
virtual void drvDataIn_handler (FwIndexType portNum, Fw::Buffer &recvBuffer, const Drv::RecvStatus &recvStatus)=0
 Handler for input port drvDataIn. More...
 
Drv::SendStatus comDataIn_handlerBase (FwIndexType portNum, Fw::Buffer &sendBuffer)
 Handler base-class function for input port comDataIn. More...
 
void drvConnected_handlerBase (FwIndexType portNum)
 Handler base-class function for input port drvConnected. More...
 
void drvDataIn_handlerBase (FwIndexType portNum, Fw::Buffer &recvBuffer, const Drv::RecvStatus &recvStatus)
 Handler base-class function for input port drvDataIn. More...
 
void comDataOut_out (FwIndexType portNum, Fw::Buffer &recvBuffer, const Drv::RecvStatus &recvStatus)
 Invoke output port comDataOut. More...
 
void comStatus_out (FwIndexType portNum, Fw::Success &condition)
 Invoke output port comStatus. More...
 
Drv::SendStatus drvDataOut_out (FwIndexType portNum, Fw::Buffer &sendBuffer)
 Invoke output port drvDataOut. 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 ComStubComponentBaseFriend
 Friend class for white-box testing. More...
 

Detailed Description

Auto-generated base for ComStub component.

Communication adapter interface implementing communication adapter interface via a Drv.ByteStreamDriverModel.

Definition at line 25 of file ComStubComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_COMDATAIN_INPUT_PORTS 
NUM_DRVCONNECTED_INPUT_PORTS 
NUM_DRVDATAIN_INPUT_PORTS 

Definition at line 43 of file ComStubComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_COMDATAOUT_OUTPUT_PORTS 
NUM_COMSTATUS_OUTPUT_PORTS 
NUM_DRVDATAOUT_OUTPUT_PORTS 

Definition at line 50 of file ComStubComponentAc.hpp.

Constructor & Destructor Documentation

◆ ComStubComponentBase()

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

Construct ComStubComponentBase object.

Parameters
compNameThe component name

Definition at line 280 of file ComStubComponentAc.cpp.

◆ ~ComStubComponentBase()

Svc::ComStubComponentBase::~ComStubComponentBase ( )
protectedvirtual

Destroy ComStubComponentBase object.

Definition at line 287 of file ComStubComponentAc.cpp.

Member Function Documentation

◆ comDataIn_handler()

virtual Drv::SendStatus Svc::ComStubComponentBase::comDataIn_handler ( FwIndexType  portNum,
Fw::Buffer sendBuffer 
)
protectedpure virtual

Handler for input port comDataIn.

Parameters
portNumThe port number
sendBufferData to send

◆ comDataIn_handlerBase()

Drv::SendStatus Svc::ComStubComponentBase::comDataIn_handlerBase ( FwIndexType  portNum,
Fw::Buffer sendBuffer 
)
protected

Handler base-class function for input port comDataIn.

Parameters
portNumThe port number
sendBufferData to send

Definition at line 380 of file ComStubComponentAc.cpp.

◆ comDataOut_out()

void Svc::ComStubComponentBase::comDataOut_out ( FwIndexType  portNum,
Fw::Buffer recvBuffer,
const Drv::RecvStatus recvStatus 
)
protected

Invoke output port comDataOut.

Parameters
portNumThe port number

Definition at line 441 of file ComStubComponentAc.cpp.

◆ comStatus_out()

void Svc::ComStubComponentBase::comStatus_out ( FwIndexType  portNum,
Fw::Success condition 
)
protected

Invoke output port comStatus.

Parameters
portNumThe port number
conditionCondition success/failure

Definition at line 458 of file ComStubComponentAc.cpp.

◆ drvConnected_handler()

virtual void Svc::ComStubComponentBase::drvConnected_handler ( FwIndexType  portNum)
protectedpure virtual

Handler for input port drvConnected.

Parameters
portNumThe port number

◆ drvConnected_handlerBase()

void Svc::ComStubComponentBase::drvConnected_handlerBase ( FwIndexType  portNum)
protected

Handler base-class function for input port drvConnected.

Parameters
portNumThe port number

Definition at line 403 of file ComStubComponentAc.cpp.

◆ drvDataIn_handler()

virtual void Svc::ComStubComponentBase::drvDataIn_handler ( FwIndexType  portNum,
Fw::Buffer recvBuffer,
const Drv::RecvStatus recvStatus 
)
protectedpure virtual

Handler for input port drvDataIn.

Parameters
portNumThe port number

◆ drvDataIn_handlerBase()

void Svc::ComStubComponentBase::drvDataIn_handlerBase ( FwIndexType  portNum,
Fw::Buffer recvBuffer,
const Drv::RecvStatus recvStatus 
)
protected

Handler base-class function for input port drvDataIn.

Parameters
portNumThe port number

Definition at line 416 of file ComStubComponentAc.cpp.

◆ drvDataOut_out()

Drv::SendStatus Svc::ComStubComponentBase::drvDataOut_out ( FwIndexType  portNum,
Fw::Buffer sendBuffer 
)
protected

Invoke output port drvDataOut.

Parameters
portNumThe port number
sendBufferData to send

Definition at line 473 of file ComStubComponentAc.cpp.

◆ get_comDataIn_InputPort()

Drv::InputByteStreamSendPort * Svc::ComStubComponentBase::get_comDataIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
comDataIn[portNum]
Parameters
portNumThe port number

Definition at line 161 of file ComStubComponentAc.cpp.

◆ get_drvConnected_InputPort()

Drv::InputByteStreamReadyPort * Svc::ComStubComponentBase::get_drvConnected_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
drvConnected[portNum]
Parameters
portNumThe port number

Definition at line 172 of file ComStubComponentAc.cpp.

◆ get_drvDataIn_InputPort()

Drv::InputByteStreamRecvPort * Svc::ComStubComponentBase::get_drvDataIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
drvDataIn[portNum]
Parameters
portNumThe port number

Definition at line 183 of file ComStubComponentAc.cpp.

◆ getNum_comDataIn_InputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_comDataIn_InputPorts ( ) const
protected

Get the number of comDataIn input ports

Returns
The number of comDataIn input ports

Definition at line 297 of file ComStubComponentAc.cpp.

◆ getNum_comDataOut_OutputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_comDataOut_OutputPorts ( ) const
protected

Get the number of comDataOut output ports

Returns
The number of comDataOut output ports

Definition at line 319 of file ComStubComponentAc.cpp.

◆ getNum_comStatus_OutputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_comStatus_OutputPorts ( ) const
protected

Get the number of comStatus output ports

Returns
The number of comStatus output ports

Definition at line 325 of file ComStubComponentAc.cpp.

◆ getNum_drvConnected_InputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_drvConnected_InputPorts ( ) const
protected

Get the number of drvConnected input ports

Returns
The number of drvConnected input ports

Definition at line 303 of file ComStubComponentAc.cpp.

◆ getNum_drvDataIn_InputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_drvDataIn_InputPorts ( ) const
protected

Get the number of drvDataIn input ports

Returns
The number of drvDataIn input ports

Definition at line 309 of file ComStubComponentAc.cpp.

◆ getNum_drvDataOut_OutputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_drvDataOut_OutputPorts ( ) const
protected

Get the number of drvDataOut output ports

Returns
The number of drvDataOut output ports

Definition at line 331 of file ComStubComponentAc.cpp.

◆ init()

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

Initialize ComStubComponentBase object.

Parameters
instanceThe instance number

Definition at line 21 of file ComStubComponentAc.cpp.

◆ isConnected_comDataOut_OutputPort()

bool Svc::ComStubComponentBase::isConnected_comDataOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port comDataOut is connected

Returns
Whether port comDataOut is connected
Parameters
portNumThe port number

Definition at line 341 of file ComStubComponentAc.cpp.

◆ isConnected_comStatus_OutputPort()

bool Svc::ComStubComponentBase::isConnected_comStatus_OutputPort ( FwIndexType  portNum)
protected

Check whether port comStatus is connected

Returns
Whether port comStatus is connected
Parameters
portNumThe port number

Definition at line 352 of file ComStubComponentAc.cpp.

◆ isConnected_drvDataOut_OutputPort()

bool Svc::ComStubComponentBase::isConnected_drvDataOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port drvDataOut is connected

Returns
Whether port drvDataOut is connected
Parameters
portNumThe port number

Definition at line 363 of file ComStubComponentAc.cpp.

◆ set_comDataOut_OutputPort()

void Svc::ComStubComponentBase::set_comDataOut_OutputPort ( FwIndexType  portNum,
Drv::InputByteStreamRecvPort port 
)

Connect port to comDataOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 198 of file ComStubComponentAc.cpp.

◆ set_comStatus_OutputPort()

void Svc::ComStubComponentBase::set_comStatus_OutputPort ( FwIndexType  portNum,
Fw::InputSuccessConditionPort port 
)

Connect port to comStatus[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 212 of file ComStubComponentAc.cpp.

◆ set_drvDataOut_OutputPort()

void Svc::ComStubComponentBase::set_drvDataOut_OutputPort ( FwIndexType  portNum,
Drv::InputByteStreamSendPort port 
)

Connect port to drvDataOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 226 of file ComStubComponentAc.cpp.

Friends And Related Function Documentation

◆ ComStubComponentBaseFriend

friend class ComStubComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 34 of file ComStubComponentAc.hpp.


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