Strongly-typed class representing PGN 128001 - Vessel Acceleration. More...

#include <PGN128001.h>

Inheritance diagram for nmealib::nmea2000::PGN128001:

[legend]

Collaboration diagram for nmealib::nmea2000::PGN128001:

[legend]

Public Member Functions
	PGN128001 (uint8_t sequenceId, Acceleration longitudinalAcceleration, Acceleration transverseAcceleration, Acceleration verticalAcceleration, Byte reserved=Byte::fromRaw(255)) noexcept

	PGN128001 (const PGN128001 &)=default

PGN128001 &	operator= (const PGN128001 &)=default

	PGN128001 (PGN128001 &&) noexcept=default

PGN128001 &	operator= (PGN128001 &&) noexcept=default

	~PGN128001 () override=default

std::unique_ptr< nmealib::Message >	clone () const override
	Creates a polymorphic deep copy of this Message2000.

uint8_t	getSequenceId () const noexcept

Acceleration	getLongitudinalAcceleration () const noexcept

Acceleration	getTransverseAcceleration () const noexcept

Acceleration	getVerticalAcceleration () const noexcept

float	getLongitudinalAccelerationG () const noexcept

float	getTransverseAccelerationG () const noexcept

float	getVerticalAccelerationG () const noexcept

std::string	getStringContent (bool verbose) const noexcept override
	Returns a human-readable string representation of the message.

bool	operator== (const PGN128001 &other) const noexcept

virtual bool	operator== (const Message2000 &other) const noexcept

Public Member Functions inherited from nmealib::nmea2000::Message2000
	Message2000 (const Message2000 &)=default

Message2000 &	operator= (const Message2000 &)=default

	Message2000 (Message2000 &&) noexcept=default

Message2000 &	operator= (Message2000 &&)=default

	~Message2000 () override=default

const std::vector< uint8_t > &	getCanId () const noexcept
	Returns the 29-bit CAN identifier as 4 bytes (big-endian).

const std::vector< uint8_t > &	getCanFrame () const noexcept
	Returns the raw CAN frame payload (0-223 bytes).

uint8_t	getCanFrameLength () const noexcept
	Returns the number of bytes in the CAN frame payload.

uint8_t	getPriority () const noexcept
	Returns the 3-bit message priority (0 = highest, 7 = lowest).

bool	getPriority3 () const noexcept
	Returns individual priority bits (P3 is the MSB).

bool	getPriority2 () const noexcept
	Bit 3 of canId_[0].

bool	getPriority1 () const noexcept
	Bit 2 of canId_[0].

bool	getHeaderReserved () const noexcept
	Returns the Reserved bit (R1).

bool	getDataPage () const noexcept
	Returns the Data Page bit (DP).

uint8_t	getPDUFormat () const noexcept
	Returns the PDU Format byte (PF).

uint8_t	getPDUSpecific () const noexcept
	Returns the PDU Specific byte (PS).

uint8_t	getSourceAddress () const noexcept
	Returns the source address of the transmitting device.

uint8_t	getDestinationAddress () const noexcept
	Returns the destination address.

uint32_t	getPgn () const noexcept
	Returns the PGN (Parameter Group Number) extracted from the CAN Id.

std::string	serialize () const override
	Serializes the message to "CANID:data" hex format.

bool	validate () const override
	Returns true if the PGN fits in 18 bits and the frame is 0-223 bytes.

Public Member Functions inherited from nmealib::Message
	Message ()

	Message (std::string raw, Type type=Type::Unknown, TimePoint ts=std::chrono::system_clock::now()) noexcept

virtual	~Message ()

	Message (const Message &)=default

Message &	operator= (const Message &)=default

	Message (Message &&) noexcept=default

Message &	operator= (Message &&) noexcept=default

Type	getType () const noexcept
	Returns the message type.

const std::string &	getRawData () const noexcept
	Returns the raw, unmodified data string as received.

TimePoint	getTimestamp () const noexcept
	Returns the timestamp associated with this message.

bool	operator== (const Message &other) const noexcept
	Compares two Message objects for equality based on their content.

Friends
class	Nmea2000Factory

class	MessageRegistry

Additional Inherited Members
Public Types inherited from nmealib::Message
enum class	Type { Unknown , NMEA0183 , NMEA2000 }
	Defines the type of NMEA message, allowing for differentiation between various standards. More...

using	TimePoint = std::chrono::system_clock::time_point

Static Public Member Functions inherited from nmealib::Message
static std::string	typeToString (Type t)
	Converts a Message::Type enum value to its string representation.

Protected Member Functions inherited from nmealib::nmea2000::Message2000
std::string	toString (bool verbose) const noexcept
	Returns the base string common to all PGNs (used by getStringContent).

Protected Member Functions inherited from nmealib::Message
void	setType (Type t) noexcept
	Sets the message type.

void	setRaw (std::string r) noexcept
	Sets the raw data string.

void	setTimestamp (TimePoint ts) noexcept
	Sets the message timestamp.

Static Protected Member Functions inherited from nmealib::nmea2000::Message2000
static std::unique_ptr< Message2000 >	create (std::string raw, TimePoint ts=std::chrono::system_clock::now())
	Protected factory — parses "CANID:data" (and variant formats) into a Message2000.

Protected Attributes inherited from nmealib::nmea2000::Message2000
std::vector< uint8_t >	canId_
	29-bit CAN Id stored as 4 bytes (big-endian)

std::vector< uint8_t >	canFrame_
	CAN frame payload (0-223 bytes)

Protected Attributes inherited from nmealib::Message
std::string	rawData_

Type	type_ {Type::Unknown}

TimePoint	timestamp_ {}

Detailed Description

Strongly-typed class representing PGN 128001 - Vessel Acceleration.

PGN 128001 is used to report the linear acceleraions of the vessel. The message contains the following fields:

Sequence ID (1 byte): A counter that increments with each new message instance.
Longitudinal Acceleration (2 bytes): Acceleration of the vessel in the longitudinal direction, stored in an Acceleration dataType, in m/s² [-327.64, 327.64], resolution 0.01 m/s².
Transverse Acceleration (2 bytes): Acceleration of the vessel in the transverse direction, stored in an Acceleration dataType, in m/s² [-327.64, 327.64], resolution 0.01 m/s².
Vertical Acceleration (2 bytes): Acceleration of the vessel in the vertical direction, stored in an Acceleration dataType, in m/s² [-327.64, 327.64], resolution 0.01 m/s².
Reserved (1 byte): Used for Alignment and future expansion, should be set to 1.

Definition at line 26 of file PGN128001.h.

Constructor & Destructor Documentation

◆ PGN128001() [1/3]

nmealib::nmea2000::PGN128001::PGN128001	(	uint8_t	sequenceId,
		Acceleration	longitudinalAcceleration,
		Acceleration	transverseAcceleration,
		Acceleration	verticalAcceleration,
		Byte	reserved = `Byte::fromRaw(255)`
	)

noexcept

Definition at line 47 of file PGN128001.cpp.

◆ PGN128001() [2/3]

nmealib::nmea2000::PGN128001::PGN128001 ( const PGN128001 & )

default

◆ PGN128001() [3/3]

nmealib::nmea2000::PGN128001::PGN128001 ( PGN128001 && )

defaultnoexcept

◆ ~PGN128001()

nmealib::nmea2000::PGN128001::~PGN128001 ( )

overridedefault

Member Function Documentation

◆ clone()

std::unique_ptr< Message > nmealib::nmea2000::PGN128001::clone ( ) const

overridevirtual

Creates a polymorphic deep copy of this Message2000.

Reimplemented from nmealib::nmea2000::Message2000.

Definition at line 63 of file PGN128001.cpp.

◆ getLongitudinalAcceleration()

Acceleration nmealib::nmea2000::PGN128001::getLongitudinalAcceleration ( ) const

noexcept

Returns: the longitudinal acceleration in m/s².

Definition at line 127 of file PGN128001.cpp.

◆ getLongitudinalAccelerationG()

float nmealib::nmea2000::PGN128001::getLongitudinalAccelerationG ( ) const

noexcept

Definition at line 139 of file PGN128001.cpp.

◆ getSequenceId()

uint8_t nmealib::nmea2000::PGN128001::getSequenceId ( ) const

noexcept

Returns: the sequence ID.

Definition at line 123 of file PGN128001.cpp.

◆ getStringContent()

std::string nmealib::nmea2000::PGN128001::getStringContent ( bool verbose ) const

overridevirtualnoexcept

Returns a human-readable string representation of the message.

Verbose: multi-line dump of all fields. Non-verbose: single-line summary.

Reimplemented from nmealib::nmea2000::Message2000.

Definition at line 67 of file PGN128001.cpp.

◆ getTransverseAcceleration()

Acceleration nmealib::nmea2000::PGN128001::getTransverseAcceleration ( ) const

noexcept

Returns: the transverse acceleration in m/s².

Definition at line 131 of file PGN128001.cpp.

◆ getTransverseAccelerationG()

float nmealib::nmea2000::PGN128001::getTransverseAccelerationG ( ) const

noexcept

Definition at line 143 of file PGN128001.cpp.

◆ getVerticalAcceleration()

Acceleration nmealib::nmea2000::PGN128001::getVerticalAcceleration ( ) const

noexcept

Returns: the vertical acceleration in m/s².

Definition at line 135 of file PGN128001.cpp.

◆ getVerticalAccelerationG()

float nmealib::nmea2000::PGN128001::getVerticalAccelerationG ( ) const

noexcept

Definition at line 147 of file PGN128001.cpp.

◆ operator=() [1/2]

PGN128001 & nmealib::nmea2000::PGN128001::operator= ( const PGN128001 & )

default

◆ operator=() [2/2]

PGN128001 & nmealib::nmea2000::PGN128001::operator= ( PGN128001 && )

defaultnoexcept

◆ operator==() [1/2]

bool nmealib::nmea2000::Message2000::operator== ( const Message2000 & other ) const

virtualnoexcept

Reimplemented from nmealib::nmea2000::Message2000.

Definition at line 192 of file nmea2000.cpp.

◆ operator==() [2/2]

bool nmealib::nmea2000::PGN128001::operator== ( const PGN128001 & other ) const

noexcept

Definition at line 151 of file PGN128001.cpp.

Friends And Related Symbol Documentation

◆ MessageRegistry

friend class MessageRegistry

friend

Definition at line 92 of file PGN128001.h.

◆ Nmea2000Factory

friend class Nmea2000Factory

friend

Definition at line 91 of file PGN128001.h.

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

include/nmealib/nmea2000/PGN128001.h
src/nmea2000/PGN128001.cpp

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PGN128001() [1/3]

◆ PGN128001() [2/3]

◆ PGN128001() [3/3]

◆ ~PGN128001()

Member Function Documentation

◆ clone()

◆ getLongitudinalAcceleration()

◆ getLongitudinalAccelerationG()

◆ getSequenceId()

◆ getStringContent()

◆ getTransverseAcceleration()

◆ getTransverseAccelerationG()

◆ getVerticalAcceleration()

◆ getVerticalAccelerationG()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

Friends And Related Symbol Documentation

◆ MessageRegistry

◆ Nmea2000Factory