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

Connect to a CAN bus using GridConnect formatted message over a Tcp/Ip connection. More...

Public Member Functions

 CANGridConnectOverTcp (name,...)
 Constructor: create a connection to a Grid Connect USB serial device. More...
 

Static Public Member Functions

static buildPortnidandhostDialog ()
 Function to construct the Dialog to ask the user for a port, host, and Node ID. More...
 
static _CancelOpenTransport ()
 Function bound to the Cancel button. More...
 
static _OpenTransport ()
 Function bound to the Open button. More...
 
static requiredOpts ()
 Return the default option list. More...
 
static drawOptionsDialog (...)
 Pop up the Options Dialog box. More...
 

Static Public Attributes

static portnidandhostDialog
 Dialog to ask the user for a port, host, and Node ID. More...
 
static portLSpin
 LabelSpinBox containing possible network ports. More...
 
static hostLEntry
 LabelEntry containing the hostname. More...
 
static nidLEntry
 LabelEntry containing the Node ID. More...
 

Private Attributes

 gccomponent
 GC Component. More...
 
 socket
 The Tcp/Ip socket. More...
 

Detailed Description

Connect to a CAN bus using GridConnect formatted message over a Tcp/Ip connection.

Options:

Constructor & Destructor Documentation

◆ CANGridConnectOverTcp()

lcc::CANGridConnectOverTcp::CANGridConnectOverTcp ( name  ,
  ... 
)

Constructor: create a connection to a Grid Connect USB serial device.

Connect to the CAN bus via a Grid Connect USB serial port interface.

Parameters
nameThe name of the instance.
...The options:
  • -port The Tcp/Ip port number. The default is 12021.
  • -host The host to connect to. The default is localhost.
  • -nid The Node ID that the computer will assume in the format of hh:hh:hh:hh:hh:hh which is a 48 bit number expressed as 6 pairs of hexadecimal digits separacted by colons (:).
  • -eventhandler This is a script prefix that is run on incoming messages. The current message as a binary CanMessage is appended.
  • -promisciousmode Promiscious mode flag. If true all messages are handled, whether they are addressed to this node or not.

Member Function Documentation

◆ _CancelOpenTransport()

static lcc::CANGridConnectOverTcp::_CancelOpenTransport ( )
static

Function bound to the Cancel button.

Closes the dialog box and returns the empty string.

Returns
The empty string.

◆ _OpenTransport()

static lcc::CANGridConnectOverTcp::_OpenTransport ( )
static

Function bound to the Open button.

Closes the dialog box and returns the options needed to open the transport.

Returns
An option argument list with the -nid and -port options.

◆ buildPortnidandhostDialog()

static lcc::CANGridConnectOverTcp::buildPortnidandhostDialog ( )
static

Function to construct the Dialog to ask the user for a port, host, and Node ID.

Returns
The Dialog box object.

◆ drawOptionsDialog()

static lcc::CANGridConnectOverTcp::drawOptionsDialog (   ...)
static

Pop up the Options Dialog box.

Pops up the Options Dialog box and collects the options needed to open the OpenLCBOverTcp object.

Parameters
...Options:
  • -parent Set the parent for this dialog box.
  • -port The default Tcp/Ip port number option.
  • -host The default Tcp/Ip hostname option.
  • -nid The default Node ID to use for the Node ID option.
Returns
Either the null string or an options list.

◆ requiredOpts()

static lcc::CANGridConnectOverTcp::requiredOpts ( )
static

Return the default option list.

Returns the default options for the options dialog.

Returns
The option value list.

Member Data Documentation

◆ gccomponent

lcc::CANGridConnectOverTcp::gccomponent
private

GC Component.

◆ hostLEntry

lcc::CANGridConnectOverTcp::hostLEntry
static

LabelEntry containing the hostname.

◆ nidLEntry

lcc::CANGridConnectOverTcp::nidLEntry
static

LabelEntry containing the Node ID.

◆ portLSpin

lcc::CANGridConnectOverTcp::portLSpin
static

LabelSpinBox containing possible network ports.

◆ portnidandhostDialog

lcc::CANGridConnectOverTcp::portnidandhostDialog
static

Dialog to ask the user for a port, host, and Node ID.

◆ socket

lcc::CANGridConnectOverTcp::socket
private

The Tcp/Ip socket.