OpenCPN Partial API docs
Loading...
Searching...
No Matches
NavmsgStatus Class Reference

Representation of message status as determined by the multiplexer. More...

#include <navmsg_filter.h>

Public Types

enum class  Direction {
  kInput , kHandled , kOutput , kInternal ,
  kNone
}
 
enum class  Accepted { kOk , kFilteredNoOutput , kFilteredDropped , kNone }
 
enum class  State {
  kOk , kChecksumError , kMalformed , kTxError ,
  kNone
}
 

Public Member Functions

 NavmsgStatus (Direction direction_, State status_, Accepted accepted_)
 
 NavmsgStatus (Direction direction)
 
 NavmsgStatus (State status)
 
 NavmsgStatus (Accepted accepted)
 

Static Public Member Functions

static std::string AcceptedToString (Accepted)
 Return string representation of argument.
 
static Accepted StringToAccepted (const std::string &s)
 Return Accepted value corresponding to argument s.
 

Public Attributes

Direction direction
 
State status
 
Accepted accepted
 

Detailed Description

Representation of message status as determined by the multiplexer.

kInput is the exception, reflecting messages received but yet not handled by the mux.

Definition at line 62 of file navmsg_filter.h.

Member Enumeration Documentation

◆ Accepted

enum class NavmsgStatus::Accepted
strong

Definition at line 65 of file navmsg_filter.h.

◆ Direction

enum class NavmsgStatus::Direction
strong

Definition at line 64 of file navmsg_filter.h.

◆ State

enum class NavmsgStatus::State
strong

Definition at line 66 of file navmsg_filter.h.

Constructor & Destructor Documentation

◆ NavmsgStatus() [1/5]

NavmsgStatus::NavmsgStatus ( Direction  direction_,
State  status_,
Accepted  accepted_ 
)
inline

Definition at line 68 of file navmsg_filter.h.

◆ NavmsgStatus() [2/5]

NavmsgStatus::NavmsgStatus ( Direction  direction)
inline

Definition at line 71 of file navmsg_filter.h.

◆ NavmsgStatus() [3/5]

NavmsgStatus::NavmsgStatus ( State  status)
inline

Definition at line 74 of file navmsg_filter.h.

◆ NavmsgStatus() [4/5]

NavmsgStatus::NavmsgStatus ( Accepted  accepted)
inline

Definition at line 77 of file navmsg_filter.h.

◆ NavmsgStatus() [5/5]

NavmsgStatus::NavmsgStatus ( )
inline

Definition at line 80 of file navmsg_filter.h.

Member Function Documentation

◆ AcceptedToString()

std::string NavmsgStatus::AcceptedToString ( Accepted  a)
static

Return string representation of argument.

Definition at line 45 of file navmsg_filter.cpp.

◆ StringToAccepted()

Accepted NavmsgStatus::StringToAccepted ( const std::string &  s)
static

Return Accepted value corresponding to argument s.

Definition at line 55 of file navmsg_filter.cpp.

Member Data Documentation

◆ accepted

Accepted NavmsgStatus::accepted

Definition at line 90 of file navmsg_filter.h.

◆ direction

Direction NavmsgStatus::direction

Definition at line 88 of file navmsg_filter.h.

◆ status

State NavmsgStatus::status

Definition at line 89 of file navmsg_filter.h.


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