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

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

#include <Drv/Udp/UdpComponentAc.hpp>

Inheritance diagram for Drv::UdpComponentBase:
Fw::PassiveComponentBase Fw::ObjBase Drv::UdpComponentImpl

Public Member Functions

void init (FwEnumStoreType instance=0)
 Initialize UdpComponentBase object. More...
 
Drv::InputByteStreamSendPortget_send_InputPort (FwIndexType portNum)
 
void set_allocate_OutputPort (FwIndexType portNum, Fw::InputBufferGetPort *port)
 Connect port to allocate[portNum]. More...
 
void set_deallocate_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to deallocate[portNum]. More...
 
void set_ready_OutputPort (FwIndexType portNum, Drv::InputByteStreamReadyPort *port)
 Connect port to ready[portNum]. More...
 
void set_recv_OutputPort (FwIndexType portNum, Drv::InputByteStreamRecvPort *port)
 Connect port to recv[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_SEND_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  { NUM_ALLOCATE_OUTPUT_PORTS = 1 , NUM_DEALLOCATE_OUTPUT_PORTS = 1 , NUM_READY_OUTPUT_PORTS = 1 , NUM_RECV_OUTPUT_PORTS = 1 }
 Enumerations for numbers of typed output ports. More...
 

Protected Member Functions

 UdpComponentBase (const char *compName="")
 Construct UdpComponentBase object. More...
 
virtual ~UdpComponentBase ()
 Destroy UdpComponentBase object. More...
 
FwIndexType getNum_send_InputPorts () const
 
FwIndexType getNum_allocate_OutputPorts () const
 
FwIndexType getNum_deallocate_OutputPorts () const
 
FwIndexType getNum_ready_OutputPorts () const
 
FwIndexType getNum_recv_OutputPorts () const
 
bool isConnected_allocate_OutputPort (FwIndexType portNum)
 
bool isConnected_deallocate_OutputPort (FwIndexType portNum)
 
bool isConnected_ready_OutputPort (FwIndexType portNum)
 
bool isConnected_recv_OutputPort (FwIndexType portNum)
 
virtual Drv::SendStatus send_handler (FwIndexType portNum, Fw::Buffer &sendBuffer)=0
 Handler for input port send. More...
 
Drv::SendStatus send_handlerBase (FwIndexType portNum, Fw::Buffer &sendBuffer)
 Handler base-class function for input port send. More...
 
Fw::Buffer allocate_out (FwIndexType portNum, U32 size)
 Invoke output port allocate. More...
 
void deallocate_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port deallocate. More...
 
void ready_out (FwIndexType portNum)
 Invoke output port ready. More...
 
void recv_out (FwIndexType portNum, Fw::Buffer &recvBuffer, const Drv::RecvStatus &recvStatus)
 Invoke output port recv. More...
 
virtual void lock ()
 Lock the guarded mutex. More...
 
virtual void unLock ()
 Unlock the guarded mutex. 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 UdpComponentBaseFriend
 Friend class for white-box testing. More...
 

Detailed Description

Auto-generated base for Udp component.

Definition at line 25 of file UdpComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_SEND_INPUT_PORTS 

Definition at line 43 of file UdpComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_ALLOCATE_OUTPUT_PORTS 
NUM_DEALLOCATE_OUTPUT_PORTS 
NUM_READY_OUTPUT_PORTS 
NUM_RECV_OUTPUT_PORTS 

Definition at line 48 of file UdpComponentAc.hpp.

Constructor & Destructor Documentation

◆ UdpComponentBase()

Drv::UdpComponentBase::UdpComponentBase ( const char *  compName = "")
protected

Construct UdpComponentBase object.

Parameters
compNameThe component name

Definition at line 256 of file UdpComponentAc.cpp.

◆ ~UdpComponentBase()

Drv::UdpComponentBase::~UdpComponentBase ( )
protectedvirtual

Destroy UdpComponentBase object.

Definition at line 263 of file UdpComponentAc.cpp.

Member Function Documentation

◆ allocate_out()

Fw::Buffer Drv::UdpComponentBase::allocate_out ( FwIndexType  portNum,
U32  size 
)
protected

Invoke output port allocate.

Parameters
portNumThe port number
sizeThe requested size

Definition at line 394 of file UdpComponentAc.cpp.

◆ deallocate_out()

void Drv::UdpComponentBase::deallocate_out ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protected

Invoke output port deallocate.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 409 of file UdpComponentAc.cpp.

◆ get_send_InputPort()

Drv::InputByteStreamSendPort * Drv::UdpComponentBase::get_send_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
send[portNum]
Parameters
portNumThe port number

Definition at line 131 of file UdpComponentAc.cpp.

◆ getNum_allocate_OutputPorts()

FwIndexType Drv::UdpComponentBase::getNum_allocate_OutputPorts ( ) const
protected

Get the number of allocate output ports

Returns
The number of allocate output ports

Definition at line 283 of file UdpComponentAc.cpp.

◆ getNum_deallocate_OutputPorts()

FwIndexType Drv::UdpComponentBase::getNum_deallocate_OutputPorts ( ) const
protected

Get the number of deallocate output ports

Returns
The number of deallocate output ports

Definition at line 289 of file UdpComponentAc.cpp.

◆ getNum_ready_OutputPorts()

FwIndexType Drv::UdpComponentBase::getNum_ready_OutputPorts ( ) const
protected

Get the number of ready output ports

Returns
The number of ready output ports

Definition at line 295 of file UdpComponentAc.cpp.

◆ getNum_recv_OutputPorts()

FwIndexType Drv::UdpComponentBase::getNum_recv_OutputPorts ( ) const
protected

Get the number of recv output ports

Returns
The number of recv output ports

Definition at line 301 of file UdpComponentAc.cpp.

◆ getNum_send_InputPorts()

FwIndexType Drv::UdpComponentBase::getNum_send_InputPorts ( ) const
protected

Get the number of send input ports

Returns
The number of send input ports

Definition at line 273 of file UdpComponentAc.cpp.

◆ init()

void Drv::UdpComponentBase::init ( FwEnumStoreType  instance = 0)

Initialize UdpComponentBase object.

Parameters
instanceThe instance number

Definition at line 20 of file UdpComponentAc.cpp.

◆ isConnected_allocate_OutputPort()

bool Drv::UdpComponentBase::isConnected_allocate_OutputPort ( FwIndexType  portNum)
protected

Check whether port allocate is connected

Returns
Whether port allocate is connected
Parameters
portNumThe port number

Definition at line 311 of file UdpComponentAc.cpp.

◆ isConnected_deallocate_OutputPort()

bool Drv::UdpComponentBase::isConnected_deallocate_OutputPort ( FwIndexType  portNum)
protected

Check whether port deallocate is connected

Returns
Whether port deallocate is connected
Parameters
portNumThe port number

Definition at line 322 of file UdpComponentAc.cpp.

◆ isConnected_ready_OutputPort()

bool Drv::UdpComponentBase::isConnected_ready_OutputPort ( FwIndexType  portNum)
protected

Check whether port ready is connected

Returns
Whether port ready is connected
Parameters
portNumThe port number

Definition at line 333 of file UdpComponentAc.cpp.

◆ isConnected_recv_OutputPort()

bool Drv::UdpComponentBase::isConnected_recv_OutputPort ( FwIndexType  portNum)
protected

Check whether port recv is connected

Returns
Whether port recv is connected
Parameters
portNumThe port number

Definition at line 344 of file UdpComponentAc.cpp.

◆ lock()

void Drv::UdpComponentBase::lock ( )
protectedvirtual

Lock the guarded mutex.

Definition at line 458 of file UdpComponentAc.cpp.

◆ ready_out()

void Drv::UdpComponentBase::ready_out ( FwIndexType  portNum)
protected

Invoke output port ready.

Parameters
portNumThe port number

Definition at line 424 of file UdpComponentAc.cpp.

◆ recv_out()

void Drv::UdpComponentBase::recv_out ( FwIndexType  portNum,
Fw::Buffer recvBuffer,
const Drv::RecvStatus recvStatus 
)
protected

Invoke output port recv.

Parameters
portNumThe port number

Definition at line 434 of file UdpComponentAc.cpp.

◆ send_handler()

virtual Drv::SendStatus Drv::UdpComponentBase::send_handler ( FwIndexType  portNum,
Fw::Buffer sendBuffer 
)
protectedpure virtual

Handler for input port send.

Parameters
portNumThe port number
sendBufferData to send

◆ send_handlerBase()

Drv::SendStatus Drv::UdpComponentBase::send_handlerBase ( FwIndexType  portNum,
Fw::Buffer sendBuffer 
)
protected

Handler base-class function for input port send.

Parameters
portNumThe port number
sendBufferData to send

Definition at line 361 of file UdpComponentAc.cpp.

◆ set_allocate_OutputPort()

void Drv::UdpComponentBase::set_allocate_OutputPort ( FwIndexType  portNum,
Fw::InputBufferGetPort port 
)

Connect port to allocate[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 146 of file UdpComponentAc.cpp.

◆ set_deallocate_OutputPort()

void Drv::UdpComponentBase::set_deallocate_OutputPort ( FwIndexType  portNum,
Fw::InputBufferSendPort port 
)

Connect port to deallocate[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 160 of file UdpComponentAc.cpp.

◆ set_ready_OutputPort()

void Drv::UdpComponentBase::set_ready_OutputPort ( FwIndexType  portNum,
Drv::InputByteStreamReadyPort port 
)

Connect port to ready[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 174 of file UdpComponentAc.cpp.

◆ set_recv_OutputPort()

void Drv::UdpComponentBase::set_recv_OutputPort ( FwIndexType  portNum,
Drv::InputByteStreamRecvPort port 
)

Connect port to recv[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 188 of file UdpComponentAc.cpp.

◆ unLock()

void Drv::UdpComponentBase::unLock ( )
protectedvirtual

Unlock the guarded mutex.

Definition at line 464 of file UdpComponentAc.cpp.

Friends And Related Function Documentation

◆ UdpComponentBaseFriend

friend class UdpComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 34 of file UdpComponentAc.hpp.


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