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

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

#include <Svc/BufferRepeater/BufferRepeaterComponentAc.hpp>

Inheritance diagram for Svc::BufferRepeaterComponentBase:
Fw::PassiveComponentBase Fw::ObjBase Svc::BufferRepeater

Public Member Functions

void init (FwEnumStoreType instance=0)
 Initialize BufferRepeaterComponentBase object. More...
 
Fw::InputBufferSendPortget_portIn_InputPort (FwIndexType portNum)
 
void set_Log_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
 Connect port to Log[portNum]. More...
 
void set_Time_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
 Connect port to Time[portNum]. More...
 
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_portOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to portOut[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_PORTIN_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  { NUM_LOG_OUTPUT_PORTS = 1, NUM_LOGTEXT_OUTPUT_PORTS = 1, NUM_TIME_OUTPUT_PORTS = 1 }
 Enumerations for numbers of special output ports. More...
 
enum  { NUM_ALLOCATE_OUTPUT_PORTS = 1, NUM_DEALLOCATE_OUTPUT_PORTS = 1, NUM_PORTOUT_OUTPUT_PORTS = 10 }
 Enumerations for numbers of typed output ports. More...
 
enum  { EVENTID_ALLOCATIONSOFTFAILURE = 0x0, EVENTID_ALLOCATIONHARDFAILURE = 0x1 }
 Event IDs. More...
 

Protected Member Functions

 BufferRepeaterComponentBase (const char *compName="")
 Construct BufferRepeaterComponentBase object. More...
 
virtual ~BufferRepeaterComponentBase ()
 Destroy BufferRepeaterComponentBase object. More...
 
FwIndexType getNum_portIn_InputPorts () const
 
FwIndexType getNum_Log_OutputPorts () const
 
FwIndexType getNum_Time_OutputPorts () const
 
FwIndexType getNum_allocate_OutputPorts () const
 
FwIndexType getNum_deallocate_OutputPorts () const
 
FwIndexType getNum_portOut_OutputPorts () const
 
bool isConnected_Log_OutputPort (FwIndexType portNum)
 
bool isConnected_Time_OutputPort (FwIndexType portNum)
 
bool isConnected_allocate_OutputPort (FwIndexType portNum)
 
bool isConnected_deallocate_OutputPort (FwIndexType portNum)
 
bool isConnected_portOut_OutputPort (FwIndexType portNum)
 
virtual void portIn_handler (FwIndexType portNum, Fw::Buffer &fwBuffer)=0
 Handler for input port portIn. More...
 
void portIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Handler base-class function for input port portIn. 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 portOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port portOut. More...
 
void log_WARNING_HI_AllocationSoftFailure (I32 port, U32 size) const
 
void log_FATAL_AllocationHardFailure (I32 port, U32 size) const
 
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...
 

Friends

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

Detailed Description

Auto-generated base for BufferRepeater component.

A component for repeating Fw.BufferSend calls to multiple consumers

Definition at line 29 of file BufferRepeaterComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_PORTIN_INPUT_PORTS 

Definition at line 47 of file BufferRepeaterComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of special output ports.

Enumerator
NUM_LOG_OUTPUT_PORTS 
NUM_LOGTEXT_OUTPUT_PORTS 
NUM_TIME_OUTPUT_PORTS 

Definition at line 52 of file BufferRepeaterComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_ALLOCATE_OUTPUT_PORTS 
NUM_DEALLOCATE_OUTPUT_PORTS 
NUM_PORTOUT_OUTPUT_PORTS 

Definition at line 59 of file BufferRepeaterComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Event IDs.

Enumerator
EVENTID_ALLOCATIONSOFTFAILURE 

Soft failure in allocation.

EVENTID_ALLOCATIONHARDFAILURE 

Hard failure in allocation.

Definition at line 66 of file BufferRepeaterComponentAc.hpp.

Constructor & Destructor Documentation

◆ BufferRepeaterComponentBase()

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

Construct BufferRepeaterComponentBase object.

Parameters
compNameThe component name

Definition at line 373 of file BufferRepeaterComponentAc.cpp.

◆ ~BufferRepeaterComponentBase()

Svc::BufferRepeaterComponentBase::~BufferRepeaterComponentBase ( )
protectedvirtual

Destroy BufferRepeaterComponentBase object.

Definition at line 380 of file BufferRepeaterComponentAc.cpp.

Member Function Documentation

◆ allocate_out()

Fw::Buffer Svc::BufferRepeaterComponentBase::allocate_out ( FwIndexType  portNum,
U32  size 
)
protected

Invoke output port allocate.

Parameters
portNumThe port number
sizeThe requested size

Definition at line 551 of file BufferRepeaterComponentAc.cpp.

◆ deallocate_out()

void Svc::BufferRepeaterComponentBase::deallocate_out ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protected

Invoke output port deallocate.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 566 of file BufferRepeaterComponentAc.cpp.

◆ get_portIn_InputPort()

Fw::InputBufferSendPort * Svc::BufferRepeaterComponentBase::get_portIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
portIn[portNum]
Parameters
portNumThe port number

Definition at line 172 of file BufferRepeaterComponentAc.cpp.

◆ getNum_allocate_OutputPorts()

FwIndexType Svc::BufferRepeaterComponentBase::getNum_allocate_OutputPorts ( ) const
protected

Get the number of allocate output ports

Returns
The number of allocate output ports

Definition at line 426 of file BufferRepeaterComponentAc.cpp.

◆ getNum_deallocate_OutputPorts()

FwIndexType Svc::BufferRepeaterComponentBase::getNum_deallocate_OutputPorts ( ) const
protected

Get the number of deallocate output ports

Returns
The number of deallocate output ports

Definition at line 432 of file BufferRepeaterComponentAc.cpp.

◆ getNum_Log_OutputPorts()

FwIndexType Svc::BufferRepeaterComponentBase::getNum_Log_OutputPorts ( ) const
protected

Get the number of Log output ports

Returns
The number of Log output ports

Definition at line 400 of file BufferRepeaterComponentAc.cpp.

◆ getNum_portIn_InputPorts()

FwIndexType Svc::BufferRepeaterComponentBase::getNum_portIn_InputPorts ( ) const
protected

Get the number of portIn input ports

Returns
The number of portIn input ports

Definition at line 390 of file BufferRepeaterComponentAc.cpp.

◆ getNum_portOut_OutputPorts()

FwIndexType Svc::BufferRepeaterComponentBase::getNum_portOut_OutputPorts ( ) const
protected

Get the number of portOut output ports

Returns
The number of portOut output ports

Definition at line 438 of file BufferRepeaterComponentAc.cpp.

◆ getNum_Time_OutputPorts()

FwIndexType Svc::BufferRepeaterComponentBase::getNum_Time_OutputPorts ( ) const
protected

Get the number of Time output ports

Returns
The number of Time output ports

Definition at line 416 of file BufferRepeaterComponentAc.cpp.

◆ getTime()

Fw::Time Svc::BufferRepeaterComponentBase::getTime ( )
protected

Get the time

\return The current time

Definition at line 821 of file BufferRepeaterComponentAc.cpp.

◆ init()

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

Initialize BufferRepeaterComponentBase object.

Parameters
instanceThe instance number

Definition at line 21 of file BufferRepeaterComponentAc.cpp.

◆ isConnected_allocate_OutputPort()

bool Svc::BufferRepeaterComponentBase::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 489 of file BufferRepeaterComponentAc.cpp.

◆ isConnected_deallocate_OutputPort()

bool Svc::BufferRepeaterComponentBase::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 500 of file BufferRepeaterComponentAc.cpp.

◆ isConnected_Log_OutputPort()

bool Svc::BufferRepeaterComponentBase::isConnected_Log_OutputPort ( FwIndexType  portNum)
protected

Check whether port Log is connected

Returns
Whether port Log is connected
Parameters
portNumThe port number

Definition at line 448 of file BufferRepeaterComponentAc.cpp.

◆ isConnected_portOut_OutputPort()

bool Svc::BufferRepeaterComponentBase::isConnected_portOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port portOut is connected

Returns
Whether port portOut is connected
Parameters
portNumThe port number

Definition at line 511 of file BufferRepeaterComponentAc.cpp.

◆ isConnected_Time_OutputPort()

bool Svc::BufferRepeaterComponentBase::isConnected_Time_OutputPort ( FwIndexType  portNum)
protected

Check whether port Time is connected

Returns
Whether port Time is connected
Parameters
portNumThe port number

Definition at line 474 of file BufferRepeaterComponentAc.cpp.

◆ log_FATAL_AllocationHardFailure()

void Svc::BufferRepeaterComponentBase::log_FATAL_AllocationHardFailure ( I32  port,
U32  size 
) const
protected

Log event AllocationHardFailure

Hard failure in allocation

Parameters
portThe port index that needed an allocation
sizeThe requested allocation size

Definition at line 702 of file BufferRepeaterComponentAc.cpp.

◆ log_WARNING_HI_AllocationSoftFailure()

void Svc::BufferRepeaterComponentBase::log_WARNING_HI_AllocationSoftFailure ( I32  port,
U32  size 
) const
protected

Log event AllocationSoftFailure

Soft failure in allocation

Parameters
portThe port index that needed an allocation
sizeThe requested allocation size

Definition at line 600 of file BufferRepeaterComponentAc.cpp.

◆ portIn_handler()

virtual void Svc::BufferRepeaterComponentBase::portIn_handler ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protectedpure virtual

Handler for input port portIn.

Parameters
portNumThe port number
fwBufferThe buffer

◆ portIn_handlerBase()

void Svc::BufferRepeaterComponentBase::portIn_handlerBase ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protected

Handler base-class function for input port portIn.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 528 of file BufferRepeaterComponentAc.cpp.

◆ portOut_out()

void Svc::BufferRepeaterComponentBase::portOut_out ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protected

Invoke output port portOut.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 581 of file BufferRepeaterComponentAc.cpp.

◆ set_allocate_OutputPort()

void Svc::BufferRepeaterComponentBase::set_allocate_OutputPort ( FwIndexType  portNum,
Fw::InputBufferGetPort port 
)

Connect port to allocate[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 237 of file BufferRepeaterComponentAc.cpp.

◆ set_deallocate_OutputPort()

void Svc::BufferRepeaterComponentBase::set_deallocate_OutputPort ( FwIndexType  portNum,
Fw::InputBufferSendPort port 
)

Connect port to deallocate[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 251 of file BufferRepeaterComponentAc.cpp.

◆ set_Log_OutputPort()

void Svc::BufferRepeaterComponentBase::set_Log_OutputPort ( FwIndexType  portNum,
Fw::InputLogPort port 
)

Connect port to Log[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 187 of file BufferRepeaterComponentAc.cpp.

◆ set_portOut_OutputPort()

void Svc::BufferRepeaterComponentBase::set_portOut_OutputPort ( FwIndexType  portNum,
Fw::InputBufferSendPort port 
)

Connect port to portOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 265 of file BufferRepeaterComponentAc.cpp.

◆ set_Time_OutputPort()

void Svc::BufferRepeaterComponentBase::set_Time_OutputPort ( FwIndexType  portNum,
Fw::InputTimePort port 
)

Connect port to Time[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 219 of file BufferRepeaterComponentAc.cpp.

Friends And Related Function Documentation

◆ BufferRepeaterComponentBaseFriend

friend class BufferRepeaterComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 38 of file BufferRepeaterComponentAc.hpp.


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