Model Railroad System
2.2.1
|
Connect to a OpenLCB interface. More...
Public Member Functions | |
OpenLCBNode (name,...) | |
Constructor: construct a OpenLCBNode object. More... | |
SendInitComplete () | |
Send an initialization complete message. More... | |
SendVerifyNodeID (nid="") | |
Send a verify node id message. More... | |
ProtocolSupportRequest (nid) | |
Send a Protocol Support Request to the specified node. More... | |
ProduceEvent (eventid) | |
Send an event message. More... | |
IdentifyConsumer (eventid) | |
Send an identify consumer message. More... | |
ConsumerIdentified (eventid, validity) | |
Send a consumer identified message. More... | |
ConsumerRangeIdentified (eventidrange) | |
Send a consumer range identified message. More... | |
IdentifyProducer (eventid) | |
Send an identify producer message. More... | |
ProducerIdentified (eventid, validity) | |
Send a producer identified message. More... | |
ProducerRangeIdentified (eventidrange) | |
Send a producer range identified message. More... | |
IdentifyEvents (nid="") | |
Send an identify events message. More... | |
LearnEvent (eventid) | |
Send a learn event message. More... | |
SendDatagram (nid, data) | |
Send a datagram message to the specificed Node ID. More... | |
DatagramReceivedOK (nid, flags=0) | |
Send a datagram received ok message. More... | |
DatagramRejected (nid, errorcode) | |
Send a datagram rejected message. More... | |
SendSimpleNodeInfoRequest (nid) | |
Send a simple node info request message. More... | |
SendSupportedProtocolsRequest (nid) | |
Send a Supported protocols request message. More... | |
SendMySupportedProtocols (nid) | |
Send my supported protocols message. More... | |
ReturnMySupportedProtocols () | |
Return my protocol support bitvector (three bytes). More... | |
SendMySimpleNodeInfo (nid) | |
Send my simple node info message. More... | |
ReturnMySimpleNodeInfo () | |
Return my Simple Node Info payload. More... | |
SendMyNodeVerifcation () | |
Send my node verification message. More... | |
Private Member Functions | |
_messageHandler (message) | |
Generic message handler. More... | |
Static Private Member Functions | |
static | nidlist (nid) |
Break a Node ID string into a list of bytes. More... | |
static | _buildSelectTransportConstructorDialog () |
Build a dialog box to select the transport constructor. More... | |
static | _CancelSelectTransport () |
Bound to the Cancel button. More... | |
static | _SelectTransport () |
Bound to the Select button. More... | |
static | selectTransportConstructor (...) |
@oublicsection Pop up a select transport constructor dialog box. More... | |
static | transportConstructors () |
Return the list of known available transport constructors. More... | |
Private Attributes | |
transport | |
The logical transport layer component. More... | |
protocolsupport | |
Protocol support: Simple Protocol subset and SimpleNodeInfo by default. More... | |
simplenodeinfo | |
Simple node info payload. More... | |
Static Private Attributes | |
static | _transportConstructors |
Array of transport constructors. More... | |
static | selectTransportConstructorDialog |
Dialog box to select the transport constructor. More... | |
static | constructorCombo |
LabelComboBox to select a transport constructor. More... | |
Connect to a OpenLCB interface.
This class implements the high level interface to the OpenLCB network.
Options:
lcc::OpenLCBNode::OpenLCBNode | ( | name | , |
... | |||
) |
Constructor: construct a OpenLCBNode object.
Open a connection to the OpenLCB network.
name | The name of the OpenLCBNode object. |
... | Options:
|
|
staticprivate |
Build a dialog box to select the transport constructor.
|
staticprivate |
Bound to the Cancel
button.
Closes the transport constructor dialog box and return the null string.
|
private |
Generic message handler.
message | The received OpenLCB message. |
|
staticprivate |
Bound to the Select
button.
Closes the transport constructor dialog box and returns the selected transport constructor.
lcc::OpenLCBNode::ConsumerIdentified | ( | eventid | , |
validity | |||
) |
Send a consumer identified message.
eventid | The event id to send. |
validity | The validity of the eventid: one of the words valid, invalid, or unknown. |
lcc::OpenLCBNode::ConsumerRangeIdentified | ( | eventidrange | ) |
Send a consumer range identified message.
eventidrange | The event id range identified. |
lcc::OpenLCBNode::DatagramReceivedOK | ( | nid | , |
flags | = 0 |
||
) |
Send a datagram received ok message.
nid | The Node ID to send the message to. |
flags | The (optional) flags to send. |
lcc::OpenLCBNode::DatagramRejected | ( | nid | , |
errorcode | |||
) |
Send a datagram rejected message.
nid | The Node ID to send the message to. |
errorcode | The error code to send. |
lcc::OpenLCBNode::IdentifyConsumer | ( | eventid | ) |
Send an identify consumer message.
eventid | The event id to send. |
lcc::OpenLCBNode::IdentifyEvents | ( | nid | = "" | ) |
Send an identify events message.
nid | The (optional) Node ID to send the message to. If ommited, a global verify node id message is sent. |
lcc::OpenLCBNode::IdentifyProducer | ( | eventid | ) |
Send an identify producer message.
eventid | The event id to send. |
lcc::OpenLCBNode::LearnEvent | ( | eventid | ) |
Send a learn event message.
eventid | The event id to learn. |
|
staticprivate |
Break a Node ID string into a list of bytes.
nid | The Node ID to split up. |
lcc::OpenLCBNode::ProduceEvent | ( | eventid | ) |
Send an event message.
eventid | The event id to send. |
lcc::OpenLCBNode::ProducerIdentified | ( | eventid | , |
validity | |||
) |
Send a producer identified message.
eventid | The event id to send. |
validity | The validity of the eventid: one of the words valid, invalid, or unknown. |
lcc::OpenLCBNode::ProducerRangeIdentified | ( | eventidrange | ) |
Send a producer range identified message.
eventidrange | The event id range identified. |
lcc::OpenLCBNode::ProtocolSupportRequest | ( | nid | ) |
Send a Protocol Support Request to the specified node.
nid | The Node ID to send the message to. |
lcc::OpenLCBNode::ReturnMySimpleNodeInfo | ( | ) |
Return my Simple Node Info payload.
lcc::OpenLCBNode::ReturnMySupportedProtocols | ( | ) |
Return my protocol support bitvector (three bytes).
|
staticprivate |
@oublicsection Pop up a select transport constructor dialog box.
... | Options:
|
lcc::OpenLCBNode::SendDatagram | ( | nid | , |
data | |||
) |
Send a datagram message to the specificed Node ID.
nid | The Node ID to send the message to. |
data | The data to send (1 to 64 bytes). |
lcc::OpenLCBNode::SendInitComplete | ( | ) |
Send an initialization complete message.
lcc::OpenLCBNode::SendMyNodeVerifcation | ( | ) |
Send my node verification message.
lcc::OpenLCBNode::SendMySimpleNodeInfo | ( | nid | ) |
Send my simple node info message.
nid | The Node ID to send the message to. |
lcc::OpenLCBNode::SendMySupportedProtocols | ( | nid | ) |
Send my supported protocols message.
nid | The Node ID to send the message to. |
lcc::OpenLCBNode::SendSimpleNodeInfoRequest | ( | nid | ) |
Send a simple node info request message.
nid | The Node ID to send the message to. |
lcc::OpenLCBNode::SendSupportedProtocolsRequest | ( | nid | ) |
Send a Supported protocols request message.
nid | The Node ID to send the message to. |
lcc::OpenLCBNode::SendVerifyNodeID | ( | nid | = "" | ) |
Send a verify node id message.
nid | The (optional) Node ID to send the message to. If ommited, a global verify node id message is sent. |
|
staticprivate |
Return the list of known available transport constructors.
|
staticprivate |
Array of transport constructors.
|
staticprivate |
LabelComboBox to select a transport constructor.
|
private |
Protocol support: Simple Protocol subset and SimpleNodeInfo by default.
|
staticprivate |
Dialog box to select the transport constructor.
|
private |
Simple node info payload.
|
private |
The logical transport layer component.