Model Railroad System  2.2.2
Public Member Functions | Private Member Functions | List of all members
lcc::GridConnectMessage Class Reference

A Grid Connect formatted CAN message. More...

Public Member Functions

 GridConnectMessage (name,...)
 Constructor: create a Grid Connect Message object. More...
 
 setHeader (header)
 Set the header. More...
 
 setByte (val, n)
 Set a data byte. More...
 
 setHexDigit (val, n)
 Set a hex digit. More...
 

Private Member Functions

 _set_extended (opt, extended)
 Configure method for the -extended option. More...
 
 _get_extended (opt)
 CGet method for the -extended option. More...
 
 _set_rtr (opt, rtr)
 Configure method for the -rtr option. More...
 
 _get_rtr (opt)
 CGet method for the -rtr option. More...
 
 _copyCM (option, m)
 Configure method for the -canmessage option. More...
 

Detailed Description

A Grid Connect formatted CAN message.

This is an ASCII formatted version of a CAN message, used by some USB connected CAN interface devices.

This class is used to convert from binary CAN Messages to ASCII Grid Connect messages. See GridConnectReply for converting from ASCII Grid Connect messages to binary CAN Messages.

Options:

Constructor & Destructor Documentation

◆ GridConnectMessage()

lcc::GridConnectMessage::GridConnectMessage ( name  ,
  ... 
)

Constructor: create a Grid Connect Message object.

Create a Grid Connect Message. Typically, a CANMessage is configured with the -canmessage option and then the toString method is used to get a printable Grid Connect Message string.

Parameters
nameThe name of the object.
...The options:
  • -canmessage A binary CANMessage to be converted to a Grid Connect message. A write only option.
  • -extended A boolean flag to indicate if this is an extended protocol message.
  • -rtr A boolean flag to indicate if this is a reply expected message.

Member Function Documentation

◆ _copyCM()

lcc::GridConnectMessage::_copyCM ( option  ,
 
)
private

Configure method for the -canmessage option.

Copies in a CANMessage and in the process formats a Grid Connect Message string.

Parameters
optionAlways -canmessage. Ignored.
mA CANMessage object.

◆ _get_extended()

lcc::GridConnectMessage::_get_extended ( opt  )
private

CGet method for the -extended option.

Gets the extended flag character.

Parameters
optAlways -extended. Ignored.
Returns
A boolean flag indicating extendedness.

◆ _get_rtr()

lcc::GridConnectMessage::_get_rtr ( opt  )
private

CGet method for the -rtr option.

Gets the rtr flag character.

Parameters
optAlways -rtr. Ignored. @returnA boolean flag indicating rtrness.

◆ _set_extended()

lcc::GridConnectMessage::_set_extended ( opt  ,
extended   
)
private

Configure method for the -extended option.

Sets the extended flag character.

Parameters
optAlways -extended. Ignored.
extendedBoolean flag indicating extendedness.

◆ _set_rtr()

lcc::GridConnectMessage::_set_rtr ( opt  ,
rtr   
)
private

Configure method for the -rtr option.

Sets the rtr flag character.

Parameters
optAlways -rtr. Ignored.
rtrBoolean flag indicating rtrness.

References FileEntry::configure().

◆ setByte()

lcc::GridConnectMessage::setByte ( val  ,
 
)

Set a data byte.

Stores a data byte as two hex digits.

Parameters
valThe data byte value, 0-255.
nThe data index, 0-7.

References FileEntry::cget(), lcc::complete, and lcc::first.

◆ setHeader()

lcc::GridConnectMessage::setHeader ( header  )

Set the header.

Sets the header. The header is converted to hex digits and stored in the data buffer.

Parameters
headerThe binary 29-bit header.

◆ setHexDigit()

lcc::GridConnectMessage::setHexDigit ( val  ,
 
)

Set a hex digit.

Stores a single nibble (0-16) at the specified index as an ASCII hex digit.

Parameters
valThe nibble (0-16) to store.
nThe data index.

References lcc::middle.