Click or drag to resize

PkMultiSense Class

Represents a Loconet packet for complex sensor data exchange.
Inheritance Hierarchy

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

The PkMultiSense type exposes the following members.

Constructors
  NameDescription
Public methodPkMultiSense
Initializes a new instance of the PkMultiSense class
Protected methodPkMultiSense(SerializationInfo, StreamingContext)
Used to inherit custom serialization from Packet because constructors are not inherited.
Top
Properties
  NameDescription
Public propertyActualLocoOrient
Gets actual locomotive's orientation reported by the transponder, taking LocoOrientInverted into account.
Public propertyBDL16Address
Gets or sets the BDL16x address of the transponding receiver reporting the event.
Public propertyBDL16Zone
Gets or sets the BDL16x zone of the transponding receiver reporting the event.
Public propertyBytes
Gets the bytes that makes up a Loconet packet message.
(Inherited from Packet.)
Public propertyDccAddress
Gets or sets the locomotive's address reported by the transponder.
Public propertyDescription
User friendly description of the packet.
(Overrides PacketDescription.)
Public propertyDeviceAddress
Gets or sets the device independent address of the transponding receiver reporting the event.
Public propertyID
Gets the unique identifier of the packet.
(Inherited from Packet.)
Public propertyIsEchoe
Gets value indicating if the packet is an echoe.
(Inherited from Packet.)
Public propertyLocoDirection
Gets or sets the locomotive's direction reported by the transponder.
Public propertyLocoOrientation
Gets or sets the locomotive's orientation reported by the transponder.
Public propertyLocoOrientInverted
Gets or sets if current LocoOrientation is inverted, probably due to auto-reverse, reported by the transponder.
Public propertyNeedsPacketResponse (Overrides PacketNeedsPacketResponse.)
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 propertyPmAsAutoRev
Gets the power manager's auto reverse configuration of its four relays.
Public propertyPmRelayStatus
Gets the power manager's on/off status of its four relays.
Public propertyPostTxWait
Gets or sets the time in milliseconds to wait after sending this packet before performing the next step.
(Inherited from Packet.)
Public propertyProgAddress
Gets or sets the address of the device being programmed.
Public propertyProgOpsState
Gets or sets the state of the option switch.
Public propertyProgOpSwitch
Gets or sets the option switch number to be affected.
Public propertyProgWrite
Gets or sets if packet is used for reading or writing data.
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.)
Public propertyType
Gets or sets the type of message encoded in this 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
PkMultiSense packets can have several uses depending on the value assigned to the Type property:
  • Report transponding events.
  • Report power management events.
  • Program power management devices.
  • Program block detection devices.
  • Program security element devices.
  • Program stationary decoder devices.
For programming types, a PkLongAck response is expected to confirm the operation.
See Also