Class UDPStream

The role of this class is to stream the incoming data from a datagram socket into a RawData type to be outputed inside the SystemGraph. The data is copied from the internal circular buffer into the RawData when a signal event happen on the Read input port.

Inheritance
Object
NodeRuntime
UDPStream
Inherited Members
Namespace: Mechatronics.SensorSDK
Syntax
[NodeCategory("Connectivity", "UDPStream", NodeTick.Asynchronous, (LifeCycle)0, 0F, NodeMode.Standard, false)]
public class UDPStream : NodeRuntime

Fields

port

Declaration
[Tooltip("Port number to listen.")]
[Field("Port", PortDirection.Left, FieldExtra.Read)]
[SerializeField]
protected PortType<int> port
Field Value
Type Description
PortType<Int32>

rawData

Declaration
[Tooltip("Copy of the data read on UDP port.")]
[Field("RawData", PortDirection.Right, FieldExtra.Write)]
[SerializeField]
protected PortType<RawData> rawData
Field Value
Type Description
PortType<RawData>

readLatch

Declaration
[Tooltip("Read UDP buffer and set RawData output.")]
[Field("Read", PortDirection.Left, FieldExtra.Read | FieldExtra.ChangeEvent)]
[SerializeField]
protected PortType<bool> readLatch
Field Value
Type Description
PortType<Boolean>

size

Declaration
[Tooltip("Size in bytes of the internal circular buffer to store read data. (Will be rounded to a multiple of 4 bytes)")]
[Field("Size", PortDirection.Left, FieldExtra.Read)]
[SerializeField]
protected PortType<uint> size
Field Value
Type Description
PortType<UInt32>

Methods

Disable()

Disable change event on readlatch port and release the UDP client.

Declaration
public override void Disable()
Overrides

Enable(Scheduler.ClockState)

Enable change event on readlatch port and create a UDP client.

Declaration
public override void Enable(Scheduler.ClockState clockState)
Parameters
Type Name Description
Scheduler.ClockState clockState

The parameters of the waveform associated to this node
Overrides