Click or drag to resize

PkImmediate Class

Represents a Loconet packet used to send a direct DCC packet.
Inheritance Hierarchy

Namespace:  RRAutoLib.Loconet
Assembly:  RRAutoLib (in RRAutoLib.dll) Version: 4.0.8678.28884
Syntax
Copy
<SerializableAttribute>
Public Class PkImmediate
	Inherits Packet

The PkImmediate type exposes the following members.

Constructors
  NameDescription
Public methodPkImmediate
Initializes a new instance of the PkImmediate class
Protected methodPkImmediate(SerializationInfo, StreamingContext)
Used to inherit custom serialization from Packet because constructors are not inherited.
Top
Properties
  NameDescription
Public propertyBytes
Gets the bytes that makes up a Loconet packet message.
(Inherited from Packet.)
Public propertyCode exampleDccAddress
Gets or sets the DCC address encoded in the DccBytesByte.
Public propertyDccByteCount
Gets or sets the number of significant bytes in the DccBytesByte not including the checksum byte.
Public propertyDccBytes
Gets or sets the bytes that make up the DCC packet payload.
Public propertyCode exampleDccFunctions
Gets or sets the data encoded in the DccBytesByte related to function change requests.
Public propertyCode exampleDccInstruction
Gets or sets the DCC instruction encoded in the DccBytesByte.
Public propertyDescription
User friendly description of the packet.
(Overrides PacketDescription.)
Public propertyID
Gets the unique identifier of the packet.
(Inherited from Packet.)
Public propertyIsDccLongAdr
Gets the length type of the DCC address encoded in the DccBytesByte.
Public propertyIsEchoe
Gets value indicating if the packet is an echoe.
(Inherited from Packet.)
Public propertyNeedsPacketResponse
Gets value indicating if this packet expects a response packet.
(Inherited from Packet.)
Public propertyOpCode
Gets the Loconet operation code associated with the packet.
(Overrides PacketOpCode.)
Public propertyParmsDesc
User friendly description of the most significant packet parameters.
(Overrides PacketParmsDesc.)
Public propertyPostTxWait
Gets or sets the time in milliseconds to wait after sending this packet before performing the next step.
(Inherited from Packet.)
Public propertyRepeatCount
Gets or sets the number of times to repeat the DCC packet transmission.
Public propertyRxPacket
Gets the received response packet post transmit.
(Inherited from Packet.)
Public propertyTag
Gets or sets an arbitrary object that is associated with the packet.
(Inherited from Packet.)
Public propertyTimeStamp
Gets an event time stamp of the packet's echo or arrival.
(Inherited from Packet.)
Top
Methods
  NameDescription
Public methodBytesToString
Converts the Bytes into a readable string.
(Inherited from Packet.)
Public methodCode exampleClone
Creates a copy of the packet.
(Inherited from Packet.)
Protected methodGetObjectData (Inherited from Packet.)
Public methodValidPacketResponse (Overrides PacketValidPacketResponse(Packet).)
Top
Fields
  NameDescription
Protected field_blnIsEchoe
Exposed through IsEchoe property.
(Inherited from Packet.)
Protected field_bytaBytes
Exposed through Bytes property.
(Inherited from Packet.)
Protected field_dblTimeStamp
Exposed through TimeStamp property.
(Inherited from Packet.)
Protected field_objRxPacket
Exposed through RxPacket property.
(Inherited from Packet.)
Protected field_objTag
Exposed through Tag property.
(Inherited from Packet.)
Protected field_sctID
Exposed through ID property.
(Inherited from Packet.)
Protected field_srtPostTxWait
Exposed through PostTxWait property.
(Inherited from Packet.)
Top
Remarks
This Loconet packet wraps a DCC packet which it forwards directly to the track. A PkLongAck response is expected.
Examples
In the following example, we are setting functions 21 through 28 of an auxiliary decoder configured with an address of 813. The order of parameter assignment is very important due to the offsets created by variable bit addressing and instruction. For proper encoding, the address must be set first, then the instruction, and lastly the instruction specific method that encodes the data.
VB
Copy
'assumes LoconetService (locServ) has been previously initialized and started
locServ.TxPacket(New PkImmediate() With {
    .DccAddress = 813,
    .DccInstruction = PkImmediate.DccInstrType.Func21To28,
    .DccFunctions = {1, 0, 0, 0, 1, 0, 0, 0}
})
See Also