tNMEA2000::tDeviceInformation Class Reference

Class that holds all the device informations and several helper functions to that. More...

#include <NMEA2000.h>

Collaboration diagram for tNMEA2000::tDeviceInformation:

Classes
union	tUnionDeviceInformation
	Union that holds the device informations. More...

Public Member Functions
	tDeviceInformation ()
	Construct a new empty Device Information object. More...
unsigned char	GetDeviceClass () const
	Get the Device Class from the Device Information. More...
unsigned char	GetDeviceFunction () const
	Get the Device Function from the Device Information. More...
unsigned char	GetDeviceInstance () const
	Get the Device Instance from the Device Information. More...
unsigned char	GetDeviceInstanceLower () const
	Get the Device Instance (lower bits) from the Device Information. More...
unsigned char	GetDeviceInstanceUpper () const
	Get the Device Instance (upper bits) from the Device Information. More...
unsigned char	GetIndustryGroup () const
	Get the Industry Group from the Device Information. More...
uint16_t	GetManufacturerCode () const
	Get the Manufacturer Code from the Device Information. More...
uint64_t	GetName () const
	Get the Name from the Device Information. More...
unsigned char	GetSystemInstance () const
	Get the System Instance from the Device Information. More...
uint32_t	GetUniqueNumber () const
	Get the unique Number from the Device Information. More...
bool	IsSame (uint64_t Other)
	Check if two devices are the same, by comparing the device NAME. More...
void	SetDeviceClass (unsigned char _DeviceClass)
	Set the Device Class to the Device Information. More...
void	SetDeviceFunction (unsigned char _DeviceFunction)
	Set the Device Function to the Device Information. More...
void	SetDeviceInstance (unsigned char _DeviceInstance)
	Set the Device Instance to the Device Information. More...
void	SetIndustryGroup (unsigned char _IndustryGroup)
	Set the Industry Group to the Device Information. More...
void	SetManufacturerCode (uint16_t _ManufacturerCode)
	Set the Manufacturer Code to the Device Information. More...
void	SetName (uint64_t _Name)
	Set the Name to the Device Information. More...
void	SetSystemInstance (unsigned char _SystemInstance)
	Set the System Instance to the Device Information. More...
void	SetUniqueNumber (uint32_t _UniqueNumber)
	Set a unique Number to the Device Information. More...

Protected Attributes
tUnionDeviceInformation	DeviceInformation
	Union that contains all the Device Information More...

Detailed Description

Class that holds all the device informations and several helper functions to that.

Definition at line 297 of file NMEA2000.h.

Constructor & Destructor Documentation

tDeviceInformation()

tNMEA2000::tDeviceInformation::tDeviceInformation ( )

inline

Construct a new empty Device Information object.

Definition at line 358 of file NMEA2000.h.

Member Function Documentation

GetDeviceClass()

unsigned char tNMEA2000::tDeviceInformation::GetDeviceClass ( ) const

inline

Get the Device Class from the Device Information.

Returns

unsigned char -> Device class code, tDeviceInformation::tUnionDeviceInformation::DeviceClass

Definition at line 433 of file NMEA2000.h.

GetDeviceFunction()

unsigned char tNMEA2000::tDeviceInformation::GetDeviceFunction ( ) const

inline

Get the Device Function from the Device Information.

Returns

unsigned char -> Device function code, tDeviceInformation::tUnionDeviceInformation::DeviceFunction

Definition at line 419 of file NMEA2000.h.

GetDeviceInstance()

unsigned char tNMEA2000::tDeviceInformation::GetDeviceInstance ( ) const

inline

Get the Device Instance from the Device Information.

Returns

unsigned char

Definition at line 394 of file NMEA2000.h.

GetDeviceInstanceLower()

unsigned char tNMEA2000::tDeviceInformation::GetDeviceInstanceLower ( ) const

inline

Get the Device Instance (lower bits) from the Device Information.

Returns

unsigned char

Definition at line 400 of file NMEA2000.h.

GetDeviceInstanceUpper()

unsigned char tNMEA2000::tDeviceInformation::GetDeviceInstanceUpper ( ) const

inline

Get the Device Instance (upper bits) from the Device Information.

Returns

unsigned char

Definition at line 405 of file NMEA2000.h.

GetIndustryGroup()

unsigned char tNMEA2000::tDeviceInformation::GetIndustryGroup ( ) const

inline

Get the Industry Group from the Device Information.

Returns

unsigned char

Definition at line 445 of file NMEA2000.h.

GetManufacturerCode()

uint16_t tNMEA2000::tDeviceInformation::GetManufacturerCode ( ) const

inline

Get the Manufacturer Code from the Device Information.

Returns

uint16_t

Definition at line 382 of file NMEA2000.h.

GetName()

uint64_t tNMEA2000::tDeviceInformation::GetName ( ) const

inline

Get the Name from the Device Information.

Returns

uint64_t

Definition at line 462 of file NMEA2000.h.

GetSystemInstance()

unsigned char tNMEA2000::tDeviceInformation::GetSystemInstance ( ) const

inline

Get the System Instance from the Device Information.

Returns

unsigned char

Definition at line 457 of file NMEA2000.h.

GetUniqueNumber()

uint32_t tNMEA2000::tDeviceInformation::GetUniqueNumber ( ) const

inline

Get the unique Number from the Device Information.

Returns

uint32_t

Definition at line 370 of file NMEA2000.h.

IsSame()

bool tNMEA2000::tDeviceInformation::IsSame ( uint64_t  Other )

inline

Check if two devices are the same, by comparing the device NAME.

Parameters

Other

NAME of the other device

Return values

true
false

Definition at line 474 of file NMEA2000.h.

SetDeviceClass()

void tNMEA2000::tDeviceInformation::SetDeviceClass ( unsigned char  _DeviceClass )

inline

Set the Device Class to the Device Information.

Parameters

_DeviceClass

Device class code, tDeviceInformation::tUnionDeviceInformation::DeviceClass

Definition at line 426 of file NMEA2000.h.

SetDeviceFunction()

void tNMEA2000::tDeviceInformation::SetDeviceFunction ( unsigned char  _DeviceFunction )

inline

Set the Device Function to the Device Information.

Parameters

_DeviceFunction

Device function code, tDeviceInformation::tUnionDeviceInformation::DeviceFunction

Definition at line 412 of file NMEA2000.h.

SetDeviceInstance()

void tNMEA2000::tDeviceInformation::SetDeviceInstance ( unsigned char  _DeviceInstance )

inline

Set the Device Instance to the Device Information.

Parameters

_DeviceInstance

Instance for the device

Definition at line 388 of file NMEA2000.h.

SetIndustryGroup()

void tNMEA2000::tDeviceInformation::SetIndustryGroup ( unsigned char  _IndustryGroup )

inline

Set the Industry Group to the Device Information.

Parameters

_IndustryGroup

Industry Group

Definition at line 439 of file NMEA2000.h.

SetManufacturerCode()

void tNMEA2000::tDeviceInformation::SetManufacturerCode ( uint16_t  _ManufacturerCode )

inline

Set the Manufacturer Code to the Device Information.

Parameters

_ManufacturerCode

Manufacturer Code (max 11 bits)

Definition at line 376 of file NMEA2000.h.

SetName()

void tNMEA2000::tDeviceInformation::SetName ( uint64_t  _Name )

inline

Set the Name to the Device Information.

Parameters

_Name

Name of the device

Definition at line 467 of file NMEA2000.h.

SetSystemInstance()

void tNMEA2000::tDeviceInformation::SetSystemInstance ( unsigned char  _SystemInstance )

inline

Set the System Instance to the Device Information.

Parameters

_SystemInstance

System Instance

Definition at line 451 of file NMEA2000.h.

SetUniqueNumber()

void tNMEA2000::tDeviceInformation::SetUniqueNumber ( uint32_t  _UniqueNumber )

inline

Set a unique Number to the Device Information.

Parameters

_UniqueNumber

a unique number for the device (max 21 bits)

Definition at line 364 of file NMEA2000.h.

Member Data Documentation

DeviceInformation

tUnionDeviceInformation tNMEA2000::tDeviceInformation::DeviceInformation

protected

Union that contains all the Device Information

Definition at line 352 of file NMEA2000.h.

---

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

• NMEA2000.h