Interface IDisplayService
Display service.
Namespace: MAT.Atlas.Automation.Api
Assembly: MAT.Atlas.Automation.Api.dll
Syntax
[AutomationService("Display")]
public interface IDisplayService : IAutomationService
Methods
AddDisplayParameter(ObjectId, String)
Add a parameter to a display.
Declaration
DisplayParameter AddDisplayParameter(ObjectId displayId, string parameterIdentifier)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
Returns
Type | Description |
---|---|
DisplayParameter | Added display parameter properties. |
AssociateSetToDisplay(ObjectId, ObjectId)
Associate a set to a display.
Declaration
void AssociateSetToDisplay(ObjectId displayId, ObjectId setId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
ObjectId | setId | Unique identifier of a set. |
Remarks
Only works if set association is not currently locked.
CycleDisplayXAxisMapping(ObjectId)
Cycle XAxis mapping for the display.
Declaration
void CycleDisplayXAxisMapping(ObjectId displayId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
GetDisplay(ObjectId)
Get the properties of a display.
Declaration
Display GetDisplay(ObjectId displayId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
Returns
Type | Description |
---|---|
Display | Display properties. |
GetDisplayParameterById(ObjectId, ObjectId)
Get the properties of a parameter associated with a display.
Declaration
DisplayParameter GetDisplayParameterById(ObjectId displayId, ObjectId parameterInstanceIdentifier)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
ObjectId | parameterInstanceIdentifier | Unique identifier of a display parameter. |
Returns
Type | Description |
---|---|
DisplayParameter | Display parameter properties. |
GetDisplayParameterProperties(ObjectId, String)
Get the properties of a display parameter.
Declaration
Property[] GetDisplayParameterProperties(ObjectId displayId, string parameterIdentifier)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
Returns
Type | Description |
---|---|
Property[] | Collection of display parameter properties. |
GetDisplayParameterPropertyValue(ObjectId, String, String)
Get display parameter property value.
Declaration
Value GetDisplayParameterPropertyValue(ObjectId displayId, string parameterIdentifier, string propertyName)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.String | propertyName | Property name. |
Returns
Type | Description |
---|---|
Value | Property value. |
GetDisplayParameters(ObjectId)
Get the properties of all parameters associated with a display.
Declaration
DisplayParameter[] GetDisplayParameters(ObjectId displayId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
Returns
Type | Description |
---|---|
DisplayParameter[] | Collection of display parameter properties. |
GetDisplayProperties(ObjectId)
Get the properties of a display.
Declaration
Property[] GetDisplayProperties(ObjectId displayId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
Returns
Type | Description |
---|---|
Property[] | Collection of display properties. |
GetDisplayPropertyValue(ObjectId, String)
Get display property value.
Declaration
Value GetDisplayPropertyValue(ObjectId displayId, string propertyName)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
System.String | propertyName | Property name. |
Returns
Type | Description |
---|---|
Value | Property value. |
GetDisplayTimeBase(ObjectId)
Get the timebase properties of a display.
Declaration
TimeBase GetDisplayTimeBase(ObjectId displayId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
Returns
Type | Description |
---|---|
TimeBase | Timebase properties. |
RemoveDisplay(ObjectId)
Remove a display.
Declaration
void RemoveDisplay(ObjectId displayId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
RemoveDisplayParameter(ObjectId, String)
Remove a parameter from a display.
Declaration
void RemoveDisplayParameter(ObjectId displayId, string parameterIdentifier)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
System.String | parameterIdentifier | Unique identifier of a display parameter. |
RemoveDisplayParameterById(ObjectId, ObjectId)
Remove a parameter from a display.
Declaration
void RemoveDisplayParameterById(ObjectId displayId, ObjectId parameterInstanceIdentifier)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
ObjectId | parameterInstanceIdentifier | Unique identifier of a display parameter. |
RenameDisplay(ObjectId, String)
Change the title of a display.
Declaration
void RenameDisplay(ObjectId displayId, string name)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
System.String | name | New title for the display. |
SetDisplayLockedToCurrentAssociation(ObjectId, Boolean)
Lock/Unlock the associated set of a display.
Declaration
void SetDisplayLockedToCurrentAssociation(ObjectId displayId, bool isLockedToCurrentAssociation)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
System.Boolean | isLockedToCurrentAssociation | Whether to lock or unlock set association. |
SetDisplayParameterPropertyValue(ObjectId, String, String, Value)
Set display parameter property value.
Declaration
void SetDisplayParameterPropertyValue(ObjectId displayId, string parameterIdentifier, string propertyName, Value propertyValue)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.String | propertyName | Property name. |
Value | propertyValue | Property value. |
SetDisplayPropertyValue(ObjectId, String, Value)
Set display property value.
Declaration
void SetDisplayPropertyValue(ObjectId displayId, string propertyName, Value propertyValue)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
System.String | propertyName | Property name. |
Value | propertyValue | Property value. |
TogglePause(ObjectId)
Toggle between live and pause or historic replay for a display.
Declaration
void TogglePause(ObjectId displayId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |