Class InformationStream
Provides access to the Information Stream of the Virtual Controller. Currently only I/O signals are supported. The Information Stream is synchronized with Virtual Time, so you can use it together with the Simulator object in order to react on signal value changes during a simulation. Each change event is stamped with the virtual time when it occured.
Namespace: ABB.Robotics.RobotStudio.Stations
Assembly: ABB.Robotics.RobotStudio.Stations.dll
Syntax
olete("Use ABB.Robotics.RobotStudio.Stations.Simulator.DataRecorder instead")]
public class InformationStream
Methods
SubscribeIOSignal(Guid, String)
Sets up a subscription to the specified signal.
Declaration
public InformationStreamSubscriptionResult SubscribeIOSignal(Guid subscriptionId, string signalName)
Parameters
Type | Name | Description |
---|---|---|
Guid | subscriptionId | Id that should be unique for each caller that wants to maintain their set of subscriptions. All previous subscriptions with the same Id will be removed, before subscribing to the one specified. |
String | signalName | Signal names. |
Returns
Type | Description |
---|---|
InformationStreamSubscriptionResult | A InformationStreamSubscriptionResult that gives subscription status the signal. |
SubscribeIOSignals(Guid, String[])
Sets up a subscription to the specified signals.
Declaration
public InformationStreamSubscriptionResult SubscribeIOSignals(Guid subscriptionId, string[] signalNames)
Parameters
Type | Name | Description |
---|---|---|
Guid | subscriptionId | Id that should be unique for each caller that wants to maintain their set of subscriptions. All previous subscriptions with the same Id will be removed, before subscribing to the ones specified. |
String[] | signalNames | Signal names. |
Returns
Type | Description |
---|---|
InformationStreamSubscriptionResult | A InformationStreamSubscriptionResult that gives subscription status for each signal. |
UnsubscribeIOSignals(Guid)
Removes the subscription to all signals, for this client.
Declaration
public void UnsubscribeIOSignals(Guid subscriptionId)
Parameters
Type | Name | Description |
---|---|---|
Guid | subscriptionId | Id that should be unique for each caller that wants to maintain their set of subscriptions. All previous subscriptions with the same Id will be removed, before subscribing to the one specified. |
Events
EventsAvailable
Occurs when events from the previous virtual time step are available.
Declaration
public event InformationStreamEventHandler EventsAvailable
Event Type
Type | Description |
---|---|
InformationStreamEventHandler |