Model Railroad System  2.2.2
Classes | Typedefs | Enumerations | Functions
lcc Namespace Reference

Namespace that holds the LCC interface code. More...

Classes

class  EventID
 An event id structure. More...
 
class  EventID_or_null
 An EventID or empty string. More...
 
class  CANHeader
 CAN Header type. More...
 
class  MTIHeader
 MTI Header type. More...
 
class  MTIDetail
 MTI Header type, detailed version. More...
 
class  CanMessage
 A CAN Message, containing a 29-bit header and upto 8 bytes of data. More...
 
class  GridConnectMessage
 A Grid Connect formatted CAN message. More...
 
class  GridConnectReply
 A Grid Connect formatted CAN message (reply). More...
 
class  nid_or_null
 Node ID regexp pattern or the empty string. More...
 
class  CanAlias
 Implements a CAN Alias. More...
 
class  CanTransport
 Logical transport of CAN Messages. More...
 
class  OpenLCBMessage
 OpenLCB Message type. More...
 
class  CANGridConnect
 Base class to connect to a CAN bus using GridConnect formatted message over. More...
 
class  CANGridConnectOverUSBSerial
 Connect to a CAN bus using GridConnect formatted message over a USB Serial port. More...
 
class  OpenLCBOverTcp
 Connect to a OpenLCB over Tcp/Ip. More...
 
class  CANGridConnectOverTcp
 Connect to a CAN bus using GridConnect formatted message over a Tcp/Ip connection. More...
 
class  CANGridConnectOverCANSocket
 Connect to a CAN bus using GridConnect formatted message over a CAN Socket connection. More...
 
class  OpenLCBProtocols
 Supported LCC Protocol name type. More...
 
class  OpenLCBNode
 Connect to a OpenLCB interface. More...
 
class  ConfigOptions
 Display memory config options. More...
 
class  ConfigMemory
 Configure memory. More...
 
class  EventLog
 Event received log, with event sender. More...
 
class  EventReceived
 Display a received event. More...
 
class  SendEvent
 Send Event Dialog – send PCRE message. More...
 
class  ConfigurationEditor
 Generate OpenLCB Memory Configuration Window. More...
 

Typedefs

typedef int twobits
 A 2 bit integer. More...
 
typedef int threebits
 A 3 bit integer. More...
 
typedef int fivebits
 A 5 bit integer. More...
 
typedef int sixbits
 A 6 bit integer. More...
 
typedef int length
 An integer from 1 to 64. More...
 
typedef int byte
 An 8-bit unsigned byte. More...
 
typedef int twelvebits
 A 12 bit integer. More...
 
typedef int fifteenbits
 A 15 bit integer. More...
 
typedef int sixteenbits
 A 16 bit integer. More...
 
typedef int headerword
 A 29 bit integer. More...
 
typedef int uint32
 A 32 bit unsigned integer. More...
 
typedef listtype eightbytes
 A list of bytes, from 0 to 8 elements. More...
 
typedef listtype bytelist72
 A list of bytes, from 0 to 72 elements. More...
 
typedef listtype bytelist
 A list of bytes, unbounded. More...
 
typedef listtype databuf
 A list of bytes, from 1 ro 64 elements. More...
 
typedef char * nid
 Node ID regexp pattern. More...
 

Enumerations

enum  datagramcontent {
  complete , first , middle , last ,
  stream
}
 Datagram and stream types. More...
 
enum  eventvalidity { valid , invalid , unknown }
 Event validity. More...
 

Functions

 AbstractMessage ()
 Define common variables and accessor methods. More...
 
 AbstractMRMessage ()
 @Brief Macro to create common methods and variables for an AbstractMRMessage More...
 

Detailed Description

Namespace that holds the LCC interface code.

This is a cross-platform implementation ...

Author
Robert Heller <heller@deepsoft.com>

Package provided

LCC 1.0

Package provided

ConfigDialogs 1.0

Package provided

EventDialogs 1.0

Package provided

ConfigurationEditor 1.0

Typedef Documentation

◆ byte

unsigned char lcc::byte

An 8-bit unsigned byte.

◆ bytelist

A list of bytes, unbounded.

◆ bytelist72

A list of bytes, from 0 to 72 elements.

◆ databuf

A list of bytes, from 1 ro 64 elements.

◆ eightbytes

A list of bytes, from 0 to 8 elements.

◆ fifteenbits

A 15 bit integer.

◆ fivebits

A 5 bit integer.

◆ headerword

A 29 bit integer.

◆ length

An integer from 1 to 64.

◆ nid

string lcc::nid

Node ID regexp pattern.

A Node Id is six bytes as pairs of hex digits separacted by colons (:).

◆ sixbits

A 6 bit integer.

◆ sixteenbits

A 16 bit integer.

◆ threebits

A 3 bit integer.

◆ twelvebits

A 12 bit integer.

◆ twobits

A 2 bit integer.

◆ uint32

A 32 bit unsigned integer.

Enumeration Type Documentation

◆ datagramcontent

Datagram and stream types.

Enumerator
complete 

One frame datagram.

first 

First frame datagram.

middle 

Middle frame datagram.

last 

Last frame datagram.

stream 

Stream frame.

◆ eventvalidity

Event validity.

Enumerator
valid 

Currently valid.

invalid 

Currently invalid.

unknown 

Currently unknown.

Function Documentation

◆ AbstractMessage()

lcc::AbstractMessage ( )

Define common variables and accessor methods.

◆ AbstractMRMessage()

lcc::AbstractMRMessage ( )

@Brief Macro to create common methods and variables for an AbstractMRMessage