NMEA2000 Library  0.1
Library to handle NMEA 2000 Communication written in C++
tN2kCANMsg Class Reference

Class used internally on tNMEA2000 to handle incoming NMEA2000 messages. More...

#include <N2kCANMsg.h>

Collaboration diagram for tN2kCANMsg:

Public Member Functions

 tN2kCANMsg ()
 Constructor of class tN2kCANMsg. More...
 
void FreeMessage ()
 Free the message. More...
 

Public Attributes

unsigned char CopiedLen
 Length of copied bytes. More...
 
bool FreeMsg
 Message is free for fill up
More...
 
bool KnownMessage
 Message is already known
More...
 
unsigned char LastFrame
 Last received frame sequence number on fast packets or multi packet
More...
 
tN2kMsg N2kMsg
 Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. More...
 
bool Ready
 Message ready for handling?
More...
 
bool SystemMessage
 Message is a system message. More...
 
unsigned char TPMaxPackets
 =0 not TP message. >0 number of packets can be received
More...
 
unsigned char TPRequireCTS
 =0 no, n=after each n frames
More...
 

Detailed Description

Class used internally on tNMEA2000 to handle incoming NMEA2000 messages.

Definition at line 41 of file N2kCANMsg.h.

Constructor & Destructor Documentation

◆ tN2kCANMsg()

tN2kCANMsg::tN2kCANMsg ( )
inline

Constructor of class tN2kCANMsg.

Definition at line 48 of file N2kCANMsg.h.

Member Function Documentation

◆ FreeMessage()

void tN2kCANMsg::FreeMessage ( )
inline

Free the message.

This resets the whole message and clears all the content

Definition at line 86 of file N2kCANMsg.h.

Member Data Documentation

◆ CopiedLen

unsigned char tN2kCANMsg::CopiedLen

Length of copied bytes.

Definition at line 77 of file N2kCANMsg.h.

◆ FreeMsg

bool tN2kCANMsg::FreeMsg

Message is free for fill up

Definition at line 62 of file N2kCANMsg.h.

◆ KnownMessage

bool tN2kCANMsg::KnownMessage

Message is already known

Definition at line 66 of file N2kCANMsg.h.

◆ LastFrame

unsigned char tN2kCANMsg::LastFrame

Last received frame sequence number on fast packets or multi packet

Definition at line 75 of file N2kCANMsg.h.

◆ N2kMsg

tN2kMsg tN2kCANMsg::N2kMsg

Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.

Definition at line 58 of file N2kCANMsg.h.

◆ Ready

bool tN2kCANMsg::Ready

Message ready for handling?

Definition at line 60 of file N2kCANMsg.h.

◆ SystemMessage

bool tN2kCANMsg::SystemMessage

Message is a system message.

Definition at line 64 of file N2kCANMsg.h.

◆ TPMaxPackets

unsigned char tN2kCANMsg::TPMaxPackets

=0 not TP message. >0 number of packets can be received

Definition at line 71 of file N2kCANMsg.h.

◆ TPRequireCTS

unsigned char tN2kCANMsg::TPRequireCTS

=0 no, n=after each n frames

Definition at line 69 of file N2kCANMsg.h.


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