Photomechanics API
Public Member Functions | Properties | Events | List of all members
IPhotomechanicsDevicesManagerService Interface Reference

Searches for turntables and cranes and instantiates API. More...

Inheritance diagram for IPhotomechanicsDevicesManagerService:
[legend]

Public Member Functions

Task SearchForDevices ()
 Try to find turntable and crane and instantiate their APIs and set TurnTableApi and CraneApi. More...
 
void StartMonitoringDevices ()
 Begin periodic search for connected turn tables. More...
 

Properties

IPEndPoint RD300EndPoint [get, set]
 RD-300 IP endpoint. If not null, manager will attempt to connect to provided endpoint. More...
 
ITurntableApi TurnTableApi [get]
 Turn table API. null if no device is connected. More...
 
ICraneApi CraneApi [get]
 Crane API. null if no device is connected. More...
 
TimeSpan DevicesDiscoveryInterval [get, set]
 Devices polling interval. More...
 

Events

AsyncTypedEventHandler< IPhotomechanicsDevicesManagerService > TurntableApiChanged
 Occurs when TurnTableApi is changed. More...
 
AsyncTypedEventHandler< IPhotomechanicsDevicesManagerService > CraneApiChanged
 Occurs when CraneApi is changed. More...
 

Detailed Description

Searches for turntables and cranes and instantiates API.

If using RD-300, don't forget to set RD300EndPoint.

Member Function Documentation

◆ SearchForDevices()

Task IPhotomechanicsDevicesManagerService.SearchForDevices ( )

Try to find turntable and crane and instantiate their APIs and set TurnTableApi and CraneApi.

Implemented in PhotomechanicsDevicesManagerService, and PhotomechanicsFakeDevicesManagerService.

◆ StartMonitoringDevices()

void IPhotomechanicsDevicesManagerService.StartMonitoringDevices ( )

Begin periodic search for connected turn tables.

Implemented in PhotomechanicsDevicesManagerService, and PhotomechanicsFakeDevicesManagerService.

Property Documentation

◆ RD300EndPoint

IPEndPoint IPhotomechanicsDevicesManagerService.RD300EndPoint
getset

RD-300 IP endpoint. If not null, manager will attempt to connect to provided endpoint.

Implemented in PhotomechanicsDevicesManagerService, and PhotomechanicsFakeDevicesManagerService.

◆ TurnTableApi

ITurntableApi IPhotomechanicsDevicesManagerService.TurnTableApi
get

Turn table API. null if no device is connected.

Implemented in PhotomechanicsDevicesManagerService, and PhotomechanicsFakeDevicesManagerService.

◆ CraneApi

ICraneApi IPhotomechanicsDevicesManagerService.CraneApi
get

Crane API. null if no device is connected.

Implemented in PhotomechanicsDevicesManagerService, and PhotomechanicsFakeDevicesManagerService.

◆ DevicesDiscoveryInterval

TimeSpan IPhotomechanicsDevicesManagerService.DevicesDiscoveryInterval
getset

Devices polling interval.

Implemented in PhotomechanicsDevicesManagerService, and PhotomechanicsFakeDevicesManagerService.

Event Documentation

◆ TurntableApiChanged

AsyncTypedEventHandler<IPhotomechanicsDevicesManagerService> IPhotomechanicsDevicesManagerService.TurntableApiChanged

Occurs when TurnTableApi is changed.

May (and usually will) not be invoked from the main thread.

◆ CraneApiChanged

AsyncTypedEventHandler<IPhotomechanicsDevicesManagerService> IPhotomechanicsDevicesManagerService.CraneApiChanged

Occurs when CraneApi is changed.

May (and usually will) not be invoked from the main thread.