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

#include <Fw/Log/LogTextPortAc.hpp>

Inheritance diagram for Fw::InputLogTextPort:
Fw::InputPortBase Fw::PortBase Fw::ObjBase

Public Types

enum  { SERIALIZED_SIZE }
 
typedef void(* CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::TextLogString &text)
 The port callback function type. More...
 

Public Member Functions

 InputLogTextPort ()
 Constructor. More...
 
void init ()
 Initialization function. More...
 
void addCallComp (Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
 Register a component. More...
 
void invoke (FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::TextLogString &text)
 Invoke a port interface. More...
 
- Public Member Functions inherited from Fw::InputPortBase
void setPortNum (NATIVE_INT_TYPE portNum)
 
- Public Member Functions inherited from Fw::PortBase
bool isConnected ()
 

Additional Inherited Members

- Protected Member Functions inherited from Fw::InputPortBase
 InputPortBase ()
 
virtual ~InputPortBase ()
 
- Protected Member Functions inherited from Fw::PortBase
 PortBase ()
 
virtual ~PortBase ()
 
- Protected Member Functions inherited from Fw::ObjBase
 ObjBase (const char *name)
 ObjBase constructor. More...
 
virtual ~ObjBase ()
 Destructor. More...
 
void init ()
 Object initializer. More...
 
- Protected Attributes inherited from Fw::InputPortBase
PassiveComponentBasem_comp
 
NATIVE_INT_TYPE m_portNum
 
- Protected Attributes inherited from Fw::PortBase
Fw::ObjBasem_connObj
 

Detailed Description

Input LogText port Text event log port Use for development and debugging, turn off for flight

Definition at line 28 of file LogTextPortAc.hpp.

Member Typedef Documentation

◆ CompFuncPtr

typedef void(* Fw::InputLogTextPort::CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::TextLogString &text)

The port callback function type.

Definition at line 54 of file LogTextPortAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representations of the port arguments.

Definition at line 38 of file LogTextPortAc.hpp.

Constructor & Destructor Documentation

◆ InputLogTextPort()

Fw::InputLogTextPort::InputLogTextPort ( )

Constructor.

Definition at line 47 of file LogTextPortAc.cpp.

Member Function Documentation

◆ addCallComp()

void Fw::InputLogTextPort::addCallComp ( Fw::PassiveComponentBase callComp,
CompFuncPtr  funcPtr 
)

Register a component.

Parameters
callCompThe containing component
funcPtrThe port callback function

Definition at line 61 of file LogTextPortAc.cpp.

◆ init()

void Fw::InputLogTextPort::init ( )
virtual

Initialization function.

Reimplemented from Fw::InputPortBase.

Definition at line 55 of file LogTextPortAc.cpp.

◆ invoke()

void Fw::InputLogTextPort::invoke ( FwEventIdType  id,
Fw::Time timeTag,
const Fw::LogSeverity severity,
Fw::TextLogString text 
)

Invoke a port interface.

Parameters
idLog ID
timeTagTime Tag
severityThe severity argument
textText of log message

Definition at line 75 of file LogTextPortAc.cpp.


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