![]() |
F´ Flight Software - C/C++ Documentation
devel
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for LinuxUartDriver component. More...
#include <Drv/LinuxUartDriver/LinuxUartDriverComponentAc.hpp>
Protected Types | |
enum | { NUM_SEND_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 , NUM_TLM_OUTPUT_PORTS = 1 } |
Enumerations for numbers of special output 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... | |
enum | { EVENTID_OPENERROR = 0x0 , EVENTID_CONFIGERROR = 0x1 , EVENTID_WRITEERROR = 0x2 , EVENTID_READERROR = 0x3 , EVENTID_PORTOPENED = 0x4 , EVENTID_NOBUFFERS = 0x5 , EVENTID_BUFFERTOOSMALL = 0x6 } |
Event IDs. More... | |
enum | { EVENTID_WRITEERROR_THROTTLE = 5 , EVENTID_READERROR_THROTTLE = 5 , EVENTID_NOBUFFERS_THROTTLE = 20 } |
Event throttle values: sets initial value of countdown variables. More... | |
enum | { CHANNELID_BYTESSENT = 0x0 , CHANNELID_BYTESRECV = 0x1 } |
Channel IDs. More... | |
Friends | |
class | LinuxUartDriverComponentBaseFriend |
Friend class for white-box testing. More... | |
Auto-generated base for LinuxUartDriver component.
Definition at line 33 of file LinuxUartDriverComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
Enumerator | |
---|---|
NUM_SEND_INPUT_PORTS |
Definition at line 51 of file LinuxUartDriverComponentAc.hpp.
|
protected |
Enumerations for numbers of special output ports.
Enumerator | |
---|---|
NUM_LOG_OUTPUT_PORTS | |
NUM_LOGTEXT_OUTPUT_PORTS | |
NUM_TIME_OUTPUT_PORTS | |
NUM_TLM_OUTPUT_PORTS |
Definition at line 56 of file LinuxUartDriverComponentAc.hpp.
|
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 64 of file LinuxUartDriverComponentAc.hpp.
|
protected |
Event IDs.
Definition at line 72 of file LinuxUartDriverComponentAc.hpp.
|
protected |
Event throttle values: sets initial value of countdown variables.
Definition at line 83 of file LinuxUartDriverComponentAc.hpp.
|
protected |
Channel IDs.
Enumerator | |
---|---|
CHANNELID_BYTESSENT | Channel ID for BytesSent. |
CHANNELID_BYTESRECV | Channel ID for BytesRecv. |
Definition at line 90 of file LinuxUartDriverComponentAc.hpp.
|
protected |
Construct LinuxUartDriverComponentBase object.
compName | The component name |
Definition at line 539 of file LinuxUartDriverComponentAc.cpp.
|
protectedvirtual |
Destroy LinuxUartDriverComponentBase object.
Definition at line 548 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Invoke output port allocate.
portNum | The port number |
size | The requested size |
Definition at line 763 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Invoke output port deallocate.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 778 of file LinuxUartDriverComponentAc.cpp.
Drv::InputByteStreamSendPort * Drv::LinuxUartDriverComponentBase::get_send_InputPort | ( | NATIVE_INT_TYPE | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 282 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Get the number of allocate output ports
Definition at line 600 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Get the number of deallocate output ports
Definition at line 606 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Get the number of Log output ports
Definition at line 568 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Get the number of ready output ports
Definition at line 612 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Get the number of recv output ports
Definition at line 618 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Get the number of send input ports
Definition at line 558 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Get the number of Time output ports
Definition at line 584 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Get the number of Tlm output ports
Definition at line 590 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Get the time
\return The current time
Definition at line 1619 of file LinuxUartDriverComponentAc.cpp.
void Drv::LinuxUartDriverComponentBase::init | ( | NATIVE_INT_TYPE | instance = 0 | ) |
Initialize LinuxUartDriverComponentBase object.
instance | The instance number |
Definition at line 21 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Check whether port allocate is connected
portNum | The port number |
Definition at line 680 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Check whether port deallocate is connected
portNum | The port number |
Definition at line 691 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Check whether port Log is connected
portNum | The port number |
Definition at line 628 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Check whether port ready is connected
portNum | The port number |
Definition at line 702 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Check whether port recv is connected
portNum | The port number |
Definition at line 713 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Check whether port Time is connected
portNum | The port number |
Definition at line 654 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Check whether port Tlm is connected
portNum | The port number |
Definition at line 665 of file LinuxUartDriverComponentAc.cpp.
|
protectedvirtual |
Lock the guarded mutex.
Definition at line 1639 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Log event PortOpened
UART port opened event
device | The device |
Definition at line 1240 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Log event BufferTooSmall
UART ran out of buffers
device | The device |
size | The provided buffer size |
needed | The buffer size needed |
Definition at line 1404 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Log event ConfigError
UART config error
device | The device |
error | The error code |
Definition at line 930 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Log event NoBuffers
UART ran out of buffers
device | The device |
Definition at line 1318 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Reset throttle value for NoBuffers.
Definition at line 1538 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Log event OpenError
UART open error
device | The device |
error | The error code |
name | error string |
Definition at line 824 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Log event ReadError
UART read error
device | The device |
error | The error code |
Definition at line 1134 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Reset throttle value for ReadError.
Definition at line 1531 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Log event WriteError
UART write error
device | The device |
error | The error code |
Definition at line 1028 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Reset throttle value for WriteError.
Definition at line 1524 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Invoke output port ready.
portNum | The port number |
Definition at line 793 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Invoke output port recv.
portNum | The port number |
Definition at line 803 of file LinuxUartDriverComponentAc.cpp.
|
protectedpure virtual |
Handler for input port send.
portNum | The port number |
sendBuffer | Data to send |
|
protected |
Handler base-class function for input port send.
portNum | The port number |
sendBuffer | Data to send |
Definition at line 730 of file LinuxUartDriverComponentAc.cpp.
void Drv::LinuxUartDriverComponentBase::set_allocate_OutputPort | ( | NATIVE_INT_TYPE | portNum, |
Fw::InputBufferGetPort * | port | ||
) |
Connect port to allocate[portNum].
portNum | The port number |
port | The input port |
Definition at line 361 of file LinuxUartDriverComponentAc.cpp.
void Drv::LinuxUartDriverComponentBase::set_deallocate_OutputPort | ( | NATIVE_INT_TYPE | portNum, |
Fw::InputBufferSendPort * | port | ||
) |
Connect port to deallocate[portNum].
portNum | The port number |
port | The input port |
Definition at line 375 of file LinuxUartDriverComponentAc.cpp.
void Drv::LinuxUartDriverComponentBase::set_Log_OutputPort | ( | NATIVE_INT_TYPE | portNum, |
Fw::InputLogPort * | port | ||
) |
Connect port to Log[portNum].
portNum | The port number |
port | The input port |
Definition at line 297 of file LinuxUartDriverComponentAc.cpp.
void Drv::LinuxUartDriverComponentBase::set_ready_OutputPort | ( | NATIVE_INT_TYPE | portNum, |
Drv::InputByteStreamReadyPort * | port | ||
) |
Connect port to ready[portNum].
portNum | The port number |
port | The input port |
Definition at line 389 of file LinuxUartDriverComponentAc.cpp.
void Drv::LinuxUartDriverComponentBase::set_recv_OutputPort | ( | NATIVE_INT_TYPE | portNum, |
Drv::InputByteStreamRecvPort * | port | ||
) |
Connect port to recv[portNum].
portNum | The port number |
port | The input port |
Definition at line 403 of file LinuxUartDriverComponentAc.cpp.
void Drv::LinuxUartDriverComponentBase::set_Time_OutputPort | ( | NATIVE_INT_TYPE | portNum, |
Fw::InputTimePort * | port | ||
) |
Connect port to Time[portNum].
portNum | The port number |
port | The input port |
Definition at line 329 of file LinuxUartDriverComponentAc.cpp.
void Drv::LinuxUartDriverComponentBase::set_Tlm_OutputPort | ( | NATIVE_INT_TYPE | portNum, |
Fw::InputTlmPort * | port | ||
) |
Connect port to Tlm[portNum].
portNum | The port number |
port | The input port |
Definition at line 343 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Write telemetry channel BytesRecv
Bytes Received
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1582 of file LinuxUartDriverComponentAc.cpp.
|
protected |
Write telemetry channel BytesSent
Bytes Sent
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1549 of file LinuxUartDriverComponentAc.cpp.
|
protectedvirtual |
Unlock the guarded mutex.
Definition at line 1645 of file LinuxUartDriverComponentAc.cpp.
|
friend |
Friend class for white-box testing.
Definition at line 42 of file LinuxUartDriverComponentAc.hpp.