MotionDataPacket Class

Represents a packet of a motion driver

Definition

Namespace: Redler.Motion.Communication.MotionPackets
Assembly: Redler.Motion.Communication (in Redler.Motion.Communication.dll) Version: 0.0.0.0

C#

public class MotionDataPacket : IMotionPacket

MotionDataPacket(ValueTupleUInt16, Byte, Boolean)	Constructing a GET packet
MotionDataPacket(ValueTupleUInt16, Byte, Int32)	Constructing a set packet with an Int32 data
MotionDataPacket(ValueTupleUInt16, Byte, Single)	Constructing a set packet with a Single data

Command	The packet Command. Constructed by an index and a sub-index tuple
DataLength	How many data bytes to send. Relevant to CANOpen protocol only. In not defined, a default mapping is applied.
ErrorFlag	Determines whether the packet is parsed correctly or not
Index	Gets the index of the packet, 14-bit
IsDriverFault	Determines if the packet is a driver fault. For example, 100[0] in serial communication and abort codes in CANOpen. In that case, the command is the command that caused the error (if applicable) and the driver fault is embedded in the payload
IsFloat	Indicates whether the packet is a float packet
IsMaster	Relevant only to Lunar project. means that the frameColor bits are 00 and means 01.
IsSet	Indicates whether the packet is a set packet
Payload	The data of the packet. Must be always 4 bytes long
PayloadAsFloat	The payload of the packet represented as a single floating point number
PayloadAsInt	The payload of the packet represented as a int32
PayloadAsUInt	The payload of the packet represented as a uint32
SendAsCANObject	A flag that indicates that this packet is constructed like a CAN object
SubIndex	Gets the subindex of the packet, 6-bit

Equals	Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object))
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
GetDataString	Gets the data in hexadecimal representation
GetErrorPacket	Generates an error packet with a given error code
GetHashCode	Serves as the default hash function. (Overrides ObjectGetHashCode)
GetType	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
SetData(Int32)	Sets the Payload of the packet with an Int32 value
SetData(Single)	Sets the Payload of the packet with an Single value
ToString	Returns a string that represents the current object. (Overrides ObjectToString)

Equality(MotionDataPacket, MotionDataPacket)	Determines whether two data packets are equal
Inequality(MotionDataPacket, MotionDataPacket)	Determines whether two data packets are different