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...
 
Svc::InputComDataWithContextPortget_dataIn_InputPort (FwIndexType portNum)
 
Svc::InputComDataWithContextPortget_dataReturnIn_InputPort (FwIndexType portNum)
 
Drv::InputByteStreamReadyPortget_drvConnected_InputPort (FwIndexType portNum)
 
Drv::InputByteStreamDataPortget_drvReceiveIn_InputPort (FwIndexType portNum)
 
Drv::InputByteStreamDataPortget_drvSendReturnIn_InputPort (FwIndexType portNum)
 
void set_comStatusOut_OutputPort (FwIndexType portNum, Fw::InputSuccessConditionPort *port)
 Connect port to comStatusOut[portNum]. More...
 
void set_dataOut_OutputPort (FwIndexType portNum, Svc::InputComDataWithContextPort *port)
 Connect port to dataOut[portNum]. More...
 
void set_dataReturnOut_OutputPort (FwIndexType portNum, Svc::InputComDataWithContextPort *port)
 Connect port to dataReturnOut[portNum]. More...
 
void set_drvReceiveReturnOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to drvReceiveReturnOut[portNum]. More...
 
void set_drvSendOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to drvSendOut[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_DATAIN_INPUT_PORTS = 1, NUM_DATARETURNIN_INPUT_PORTS = 1, NUM_DRVCONNECTED_INPUT_PORTS = 1, NUM_DRVRECEIVEIN_INPUT_PORTS = 1,
  NUM_DRVSENDRETURNIN_INPUT_PORTS = 1
}
 Enumerations for numbers of typed input ports. More...
 
enum  {
  NUM_COMSTATUSOUT_OUTPUT_PORTS = 1, NUM_DATAOUT_OUTPUT_PORTS = 1, NUM_DATARETURNOUT_OUTPUT_PORTS = 1, NUM_DRVRECEIVERETURNOUT_OUTPUT_PORTS = 1,
  NUM_DRVSENDOUT_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_dataIn_InputPorts () const
 
FwIndexType getNum_dataReturnIn_InputPorts () const
 
FwIndexType getNum_drvConnected_InputPorts () const
 
FwIndexType getNum_drvReceiveIn_InputPorts () const
 
FwIndexType getNum_drvSendReturnIn_InputPorts () const
 
FwIndexType getNum_comStatusOut_OutputPorts () const
 
FwIndexType getNum_dataOut_OutputPorts () const
 
FwIndexType getNum_dataReturnOut_OutputPorts () const
 
FwIndexType getNum_drvReceiveReturnOut_OutputPorts () const
 
FwIndexType getNum_drvSendOut_OutputPorts () const
 
bool isConnected_comStatusOut_OutputPort (FwIndexType portNum)
 
bool isConnected_dataOut_OutputPort (FwIndexType portNum)
 
bool isConnected_dataReturnOut_OutputPort (FwIndexType portNum)
 
bool isConnected_drvReceiveReturnOut_OutputPort (FwIndexType portNum)
 
bool isConnected_drvSendOut_OutputPort (FwIndexType portNum)
 
virtual void dataIn_handler (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)=0
 Handler for input port dataIn. More...
 
virtual void dataReturnIn_handler (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)=0
 Handler for input port dataReturnIn. More...
 
virtual void drvConnected_handler (FwIndexType portNum)=0
 Handler for input port drvConnected. More...
 
virtual void drvReceiveIn_handler (FwIndexType portNum, Fw::Buffer &buffer, const Drv::ByteStreamStatus &status)=0
 Handler for input port drvReceiveIn. More...
 
virtual void drvSendReturnIn_handler (FwIndexType portNum, Fw::Buffer &buffer, const Drv::ByteStreamStatus &status)=0
 Handler for input port drvSendReturnIn. More...
 
void dataIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
 Handler base-class function for input port dataIn. More...
 
void dataReturnIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
 Handler base-class function for input port dataReturnIn. More...
 
void drvConnected_handlerBase (FwIndexType portNum)
 Handler base-class function for input port drvConnected. More...
 
void drvReceiveIn_handlerBase (FwIndexType portNum, Fw::Buffer &buffer, const Drv::ByteStreamStatus &status)
 Handler base-class function for input port drvReceiveIn. More...
 
void drvSendReturnIn_handlerBase (FwIndexType portNum, Fw::Buffer &buffer, const Drv::ByteStreamStatus &status)
 Handler base-class function for input port drvSendReturnIn. More...
 
void comStatusOut_out (FwIndexType portNum, Fw::Success &condition)
 Invoke output port comStatusOut. More...
 
void dataOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
 Invoke output port dataOut. More...
 
void dataReturnOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
 Invoke output port dataReturnOut. More...
 
void drvReceiveReturnOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port drvReceiveReturnOut. More...
 
void drvSendOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port drvSendOut. 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 ComStubTesterBase
 Friend class tester to support autocoded test harness. More...
 
class ComStubTester
 Friend class tester implementation to support 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 26 of file ComStubComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_DATAIN_INPUT_PORTS 
NUM_DATARETURNIN_INPUT_PORTS 
NUM_DRVCONNECTED_INPUT_PORTS 
NUM_DRVRECEIVEIN_INPUT_PORTS 
NUM_DRVSENDRETURNIN_INPUT_PORTS 

Definition at line 46 of file ComStubComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_COMSTATUSOUT_OUTPUT_PORTS 
NUM_DATAOUT_OUTPUT_PORTS 
NUM_DATARETURNOUT_OUTPUT_PORTS 
NUM_DRVRECEIVERETURNOUT_OUTPUT_PORTS 
NUM_DRVSENDOUT_OUTPUT_PORTS 

Definition at line 55 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 458 of file ComStubComponentAc.cpp.

◆ ~ComStubComponentBase()

Svc::ComStubComponentBase::~ComStubComponentBase ( )
protectedvirtual

Destroy ComStubComponentBase object.

Definition at line 465 of file ComStubComponentAc.cpp.

Member Function Documentation

◆ comStatusOut_out()

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

Invoke output port comStatusOut.

Parameters
portNumThe port number
conditionCondition success/failure

Definition at line 705 of file ComStubComponentAc.cpp.

◆ dataIn_handler()

virtual void Svc::ComStubComponentBase::dataIn_handler ( FwIndexType  portNum,
Fw::Buffer data,
const ComCfg::FrameContext context 
)
protectedpure virtual

Handler for input port dataIn.

Parameters
portNumThe port number

◆ dataIn_handlerBase()

void Svc::ComStubComponentBase::dataIn_handlerBase ( FwIndexType  portNum,
Fw::Buffer data,
const ComCfg::FrameContext context 
)
protected

Handler base-class function for input port dataIn.

Parameters
portNumThe port number

Definition at line 604 of file ComStubComponentAc.cpp.

◆ dataOut_out()

void Svc::ComStubComponentBase::dataOut_out ( FwIndexType  portNum,
Fw::Buffer data,
const ComCfg::FrameContext context 
)
protected

Invoke output port dataOut.

Parameters
portNumThe port number

Definition at line 725 of file ComStubComponentAc.cpp.

◆ dataReturnIn_handler()

virtual void Svc::ComStubComponentBase::dataReturnIn_handler ( FwIndexType  portNum,
Fw::Buffer data,
const ComCfg::FrameContext context 
)
protectedpure virtual

Handler for input port dataReturnIn.

Parameters
portNumThe port number

◆ dataReturnIn_handlerBase()

void Svc::ComStubComponentBase::dataReturnIn_handlerBase ( FwIndexType  portNum,
Fw::Buffer data,
const ComCfg::FrameContext context 
)
protected

Handler base-class function for input port dataReturnIn.

Parameters
portNumThe port number

Definition at line 625 of file ComStubComponentAc.cpp.

◆ dataReturnOut_out()

void Svc::ComStubComponentBase::dataReturnOut_out ( FwIndexType  portNum,
Fw::Buffer data,
const ComCfg::FrameContext context 
)
protected

Invoke output port dataReturnOut.

Parameters
portNumThe port number

Definition at line 747 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 646 of file ComStubComponentAc.cpp.

◆ drvReceiveIn_handler()

virtual void Svc::ComStubComponentBase::drvReceiveIn_handler ( FwIndexType  portNum,
Fw::Buffer buffer,
const Drv::ByteStreamStatus status 
)
protectedpure virtual

Handler for input port drvReceiveIn.

Parameters
portNumThe port number

◆ drvReceiveIn_handlerBase()

void Svc::ComStubComponentBase::drvReceiveIn_handlerBase ( FwIndexType  portNum,
Fw::Buffer buffer,
const Drv::ByteStreamStatus status 
)
protected

Handler base-class function for input port drvReceiveIn.

Parameters
portNumThe port number

Definition at line 659 of file ComStubComponentAc.cpp.

◆ drvReceiveReturnOut_out()

void Svc::ComStubComponentBase::drvReceiveReturnOut_out ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protected

Invoke output port drvReceiveReturnOut.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 769 of file ComStubComponentAc.cpp.

◆ drvSendOut_out()

void Svc::ComStubComponentBase::drvSendOut_out ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protected

Invoke output port drvSendOut.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 789 of file ComStubComponentAc.cpp.

◆ drvSendReturnIn_handler()

virtual void Svc::ComStubComponentBase::drvSendReturnIn_handler ( FwIndexType  portNum,
Fw::Buffer buffer,
const Drv::ByteStreamStatus status 
)
protectedpure virtual

Handler for input port drvSendReturnIn.

Parameters
portNumThe port number

◆ drvSendReturnIn_handlerBase()

void Svc::ComStubComponentBase::drvSendReturnIn_handlerBase ( FwIndexType  portNum,
Fw::Buffer buffer,
const Drv::ByteStreamStatus status 
)
protected

Handler base-class function for input port drvSendReturnIn.

Parameters
portNumThe port number

Definition at line 680 of file ComStubComponentAc.cpp.

◆ get_dataIn_InputPort()

Svc::InputComDataWithContextPort * Svc::ComStubComponentBase::get_dataIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
dataIn[portNum]
Parameters
portNumThe port number

Definition at line 247 of file ComStubComponentAc.cpp.

◆ get_dataReturnIn_InputPort()

Svc::InputComDataWithContextPort * Svc::ComStubComponentBase::get_dataReturnIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
dataReturnIn[portNum]
Parameters
portNumThe port number

Definition at line 258 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 269 of file ComStubComponentAc.cpp.

◆ get_drvReceiveIn_InputPort()

Drv::InputByteStreamDataPort * Svc::ComStubComponentBase::get_drvReceiveIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
drvReceiveIn[portNum]
Parameters
portNumThe port number

Definition at line 280 of file ComStubComponentAc.cpp.

◆ get_drvSendReturnIn_InputPort()

Drv::InputByteStreamDataPort * Svc::ComStubComponentBase::get_drvSendReturnIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
drvSendReturnIn[portNum]
Parameters
portNumThe port number

Definition at line 291 of file ComStubComponentAc.cpp.

◆ getNum_comStatusOut_OutputPorts()

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

Get the number of comStatusOut output ports

Returns
The number of comStatusOut output ports

Definition at line 509 of file ComStubComponentAc.cpp.

◆ getNum_dataIn_InputPorts()

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

Get the number of dataIn input ports

Returns
The number of dataIn input ports

Definition at line 475 of file ComStubComponentAc.cpp.

◆ getNum_dataOut_OutputPorts()

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

Get the number of dataOut output ports

Returns
The number of dataOut output ports

Definition at line 515 of file ComStubComponentAc.cpp.

◆ getNum_dataReturnIn_InputPorts()

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

Get the number of dataReturnIn input ports

Returns
The number of dataReturnIn input ports

Definition at line 481 of file ComStubComponentAc.cpp.

◆ getNum_dataReturnOut_OutputPorts()

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

Get the number of dataReturnOut output ports

Returns
The number of dataReturnOut output ports

Definition at line 521 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 487 of file ComStubComponentAc.cpp.

◆ getNum_drvReceiveIn_InputPorts()

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

Get the number of drvReceiveIn input ports

Returns
The number of drvReceiveIn input ports

Definition at line 493 of file ComStubComponentAc.cpp.

◆ getNum_drvReceiveReturnOut_OutputPorts()

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

Get the number of drvReceiveReturnOut output ports

Returns
The number of drvReceiveReturnOut output ports

Definition at line 527 of file ComStubComponentAc.cpp.

◆ getNum_drvSendOut_OutputPorts()

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

Get the number of drvSendOut output ports

Returns
The number of drvSendOut output ports

Definition at line 533 of file ComStubComponentAc.cpp.

◆ getNum_drvSendReturnIn_InputPorts()

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

Get the number of drvSendReturnIn input ports

Returns
The number of drvSendReturnIn input ports

Definition at line 499 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_comStatusOut_OutputPort()

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

Check whether port comStatusOut is connected

Returns
Whether port comStatusOut is connected
Parameters
portNumThe port number

Definition at line 543 of file ComStubComponentAc.cpp.

◆ isConnected_dataOut_OutputPort()

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

Check whether port dataOut is connected

Returns
Whether port dataOut is connected
Parameters
portNumThe port number

Definition at line 554 of file ComStubComponentAc.cpp.

◆ isConnected_dataReturnOut_OutputPort()

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

Check whether port dataReturnOut is connected

Returns
Whether port dataReturnOut is connected
Parameters
portNumThe port number

Definition at line 565 of file ComStubComponentAc.cpp.

◆ isConnected_drvReceiveReturnOut_OutputPort()

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

Check whether port drvReceiveReturnOut is connected

Returns
Whether port drvReceiveReturnOut is connected
Parameters
portNumThe port number

Definition at line 576 of file ComStubComponentAc.cpp.

◆ isConnected_drvSendOut_OutputPort()

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

Check whether port drvSendOut is connected

Returns
Whether port drvSendOut is connected
Parameters
portNumThe port number

Definition at line 587 of file ComStubComponentAc.cpp.

◆ set_comStatusOut_OutputPort()

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

Connect port to comStatusOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 306 of file ComStubComponentAc.cpp.

◆ set_dataOut_OutputPort()

void Svc::ComStubComponentBase::set_dataOut_OutputPort ( FwIndexType  portNum,
Svc::InputComDataWithContextPort port 
)

Connect port to dataOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 320 of file ComStubComponentAc.cpp.

◆ set_dataReturnOut_OutputPort()

void Svc::ComStubComponentBase::set_dataReturnOut_OutputPort ( FwIndexType  portNum,
Svc::InputComDataWithContextPort port 
)

Connect port to dataReturnOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 334 of file ComStubComponentAc.cpp.

◆ set_drvReceiveReturnOut_OutputPort()

void Svc::ComStubComponentBase::set_drvReceiveReturnOut_OutputPort ( FwIndexType  portNum,
Fw::InputBufferSendPort port 
)

Connect port to drvReceiveReturnOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 348 of file ComStubComponentAc.cpp.

◆ set_drvSendOut_OutputPort()

void Svc::ComStubComponentBase::set_drvSendOut_OutputPort ( FwIndexType  portNum,
Fw::InputBufferSendPort port 
)

Connect port to drvSendOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 362 of file ComStubComponentAc.cpp.

Friends And Related Function Documentation

◆ ComStubTester

friend class ComStubTester
friend

Friend class tester implementation to support white-box testing.

Definition at line 37 of file ComStubComponentAc.hpp.

◆ ComStubTesterBase

friend class ComStubTesterBase
friend

Friend class tester to support autocoded test harness.

Definition at line 35 of file ComStubComponentAc.hpp.


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