PkSlotMove Class |
Represents a Loconet packet that moves a slot.
Inheritance HierarchyNamespace: RRAutoLib.Loconet
Assembly: RRAutoLib (in RRAutoLib.dll) Version: 4.0.8678.28884
Syntax<SerializableAttribute> Public Class PkSlotMove Inherits Packet
The PkSlotMove type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PkSlotMove | Initializes a new instance of the PkSlotMove class |
| PkSlotMove(Byte, Byte) | Initializes a new instance of the PkSlotMove class |
 | PkSlotMove(SerializationInfo, StreamingContext) | Used to inherit custom serialization from Packet because constructors are not inherited. |
Properties| Name | Description | |
|---|---|---|
 | Bytes | Gets the bytes that makes up a Loconet packet message. (Inherited from Packet.) |
| Description | User friendly description of the packet. (Overrides PacketDescription.) |
| DestSlot | Gets or sets the destination slot to move to. |
| ID | Gets the unique identifier of the packet. (Inherited from Packet.) |
| IsEchoe | Gets value indicating if the packet is an echoe. (Inherited from Packet.) |
| NeedsPacketResponse | Gets value indicating if this packet expects a response packet. (Inherited from Packet.) |
| OpCode | Gets the Loconet operation code associated with the packet. (Overrides PacketOpCode.) |
| ParmsDesc | User friendly description of the most significant packet parameters. (Overrides PacketParmsDesc.) |
| PostTxWait | Gets or sets the time in milliseconds to wait after sending this packet before performing the next step. (Inherited from Packet.) |
| RxPacket | Gets the received response packet post transmit. (Inherited from Packet.) |
| SourceSlot | Gets or sets the source slot to move from. |
| Tag | Gets or sets an arbitrary object that is associated with the packet. (Inherited from Packet.) |
| TimeStamp | Gets an event time stamp of the packet's echo or arrival. (Inherited from Packet.) |
Methods| Name | Description | |
|---|---|---|
| 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.) |
| ValidPacketResponse | (Overrides PacketValidPacketResponse(Packet).) |
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.) |
RemarksOne of two packet responses is expected:
- A PkRdWrSlotData, if the slot move was successful.
- A PkLongAck, if the slot move was illegal.
ExamplesThis example demonstrates how PkSlotMove is used to purge a slot:
VB
'assumes LoconetService (locServ) has been previously initialized and started 'slot being released Dim slot As Byte = 5 'set slot speed to 0 locServ.TxPacket(New PkSetSlotSpeed(slot, 0)) 'set slot status locServ.TxPacket(New PkSlotStatus(slot, SlotActivity.Idle, ConsistType.NoConsist, SpeedSteps.DCC_128_SS)) 'do a slot move to special slot 0 locServ.TxPacket(New PkSlotMove(slot, 0))
See Also