PkLocoIO Class |
Represents a Loconet packet that comunicates with a LocoIO device.
Inheritance HierarchyNamespace: RRAutoLib.Loconet
Assembly: RRAutoLib (in RRAutoLib.dll) Version: 4.0.8678.28884
Syntax<SerializableAttribute> Public Class PkLocoIO Inherits PkPeerXfer
The PkLocoIO type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PkLocoIO | Initializes a new instance of the PkLocoIO class |
 | PkLocoIO(SerializationInfo, StreamingContext) | Used to inherit custom serialization from Packet because constructors are not inherited. |
Properties| Name | Description | |
|---|---|---|
 | Address | Target address of the LocoIO device this packet is being sent to. |
| Bytes | Gets the bytes that makes up a Loconet packet message. (Inherited from Packet.) |
| Command | The action this LocoIO packet will perform. |
| Data | Gets or sets the 8 bytes to be moved. (Inherited from PkPeerXfer.) |
| Description | User friendly description of the packet. (Overrides PkPeerXferDescription.) |
| ID | Gets the unique identifier of the packet. (Inherited from Packet.) |
| IsEchoe | Gets value indicating if the packet is an echoe. (Inherited from Packet.) |
| MultiMask | Ports to be affected by a multiport write. |
| MultiState | Port state values for a multiport write. |
| NeedsPacketResponse | (Overrides PacketNeedsPacketResponse.) |
| OpCode | Gets the Loconet operation code associated with the packet. (Inherited from PkPeerXfer.) |
| ParmsDesc | User friendly description of the most significant packet parameters. (Overrides PkPeerXferParmsDesc.) |
| PostTxWait | Gets or sets the time in milliseconds to wait after sending this packet before performing the next step. (Inherited from Packet.) |
| ReadData | Values returned from the LocoIO's memory registers. |
| Register | The memory register to be read or written to in a LocoIO device. |
| RxPacket | Gets the received response packet post transmit. (Inherited from Packet.) |
| SourceID | Gets or sets the source identifier of the byte move. (Inherited from PkPeerXfer.) |
| SubAddress | Target sub-address of the LocoIO device this packet is being sent to. |
| Tag | Gets or sets an arbitrary object that is associated with the packet. (Inherited from Packet.) |
| TargetHighAdr | Gets or sets the target's high address of the byte move. (Inherited from PkPeerXfer.) |
| TargetLowAdr | Gets or sets the target's low address of the byte move. (Inherited from PkPeerXfer.) |
| TimeStamp | Gets an event time stamp of the packet's echo or arrival. (Inherited from Packet.) |
| WriteData | Value to be written to a LocoIO's memory register. |
Methods| Name | Description | |
|---|---|---|
 | BroadcastAddress | Sends a broadcast messages to all LocoIO devices seen on the network. |
| BytesToString | Converts the Bytes into a readable string. (Inherited from Packet.) |
 | Clone | Creates a copy of the packet. (Inherited from Packet.) |
| GetObjectData | (Inherited from Packet.) |
| Read | Reads requested data, returned from the LocoIO. |
| RequestConfig | Sends a message to a LocoIO device requesting configuration data. |
| RequestSetup | Sends a message to a LocoIO device requesting setup data. |
| RequestStates | Sends a message to a LocoIO device requesting states data. |
| ValidPacketResponse | (Overrides PacketValidPacketResponse(Packet).) |
| WriteConfig | Sends three messages to a LocoIO device writting configuration data. |
| WriteSetup | Sends a message to a LocoIO device writting setup data. |
| WriteStates | Sends a messages to a LocoIO device writting state data. |
Fields| Name | Description | |
|---|---|---|
 | _blnIsEchoe | Exposed through IsEchoe property. (Inherited from Packet.) |
| _bytaBytes | Exposed through Bytes property. (Inherited from Packet.) |
| _dblTimeStamp | Exposed through TimeStamp property. (Inherited from Packet.) |
| _objRxPacket | Exposed through RxPacket property. (Inherited from Packet.) |
| _objTag | Exposed through Tag property. (Inherited from Packet.) |
| _sctID | Exposed through ID property. (Inherited from Packet.) |
| _srtPostTxWait | Exposed through PostTxWait property. (Inherited from Packet.) |
Remarks
A PkLocoIO response is expected.
The static (Shared in Visual Basic) members in this class are helpers which simplify LocoIO operations.
See Also