Interface IWorkstationState
- Namespace
- Acuit.Pinpoint.Workstation
- Assembly
- Acuit.Pinpoint.Workstation.Abstractions.dll
Provides access to the workstation state. This is the core service used to integrate with Acuit Pinpoint Workstation.
public interface IWorkstationState : INotifyPropertyChanged
- Inherited Members
Remarks
Changes to workstation state are raised as messages sent by the IMessenger service. See the message types in the
Acuit.Pinpoint.Workstation.Messaging namespace for available messages.
This is not thread-safe. All access should occur from the main application thread.
Properties
ActiveOrConfiguredLineName
Gets the line name that is either active (if the station is running) or configured (if the station is not running), or an empty string if the station is not configured.
string ActiveOrConfiguredLineName { get; }
Property Value
ActiveOrConfiguredStationTypeName
Gets the station type name that is either active (if the station is running) or configured (if the station is not running), or an empty string if the station is not configured.
string ActiveOrConfiguredStationTypeName { get; }
Property Value
ActiveOrMachineStationName
Gets the station name (if the station is running) or the machine name (if the station is not running).
string ActiveOrMachineStationName { get; }
Property Value
IsStarting
Gets whether the workstation is attempting to start.
bool IsStarting { get; }
Property Value
RunningStation
Gets the IRunningStation representing the running station, or null if the station is not running.
IRunningStation? RunningStation { get; }
Property Value
Remarks
When the station starts, this will be set to a new instance of IRunningStation, and the StationStartedMessage message will be sent via the IMessenger service. When the station stops, this will be set to null, and the StationStoppedMessage message will be sent via the IMessenger service.
For the station to start, it must connect to Acuit Pinpoint and retrieve its configuration settings.
This will be initialized during startup after successfully connecting to Acuit Pinpoint and retrieving the station settings (based on the Acuit Pinpoint connection configuration). While the application is running, this can subsequently change if the Acuit Pinpoint connection is reconfigured or if a unit scan triggers a change to a linked line.
If a plug-in depends on key/value configuration settings that might come from Acuit Pinpoint, it should ensure that this is not null (or wait until the StationStartedMessage message is sent) to use Configuration to initialize.