Interface IDisplayService

Namespace: MAT.Atlas.Automation.Api

Assembly: MAT.Atlas.Automation.Api.dll

Syntax

[AutomationService("Display")]
public interface IDisplayService : IAutomationService

Methods

AddDisplayParameter(ObjectId, String)

Declaration

DisplayParameter AddDisplayParameter(ObjectId displayId, string parameterIdentifier)

Parameters

Type	Name	Description
ObjectId	displayId
System.String	parameterIdentifier

Returns

Type	Description
DisplayParameter

AssociateSetToDisplay(ObjectId, ObjectId)

Declaration

void AssociateSetToDisplay(ObjectId displayId, ObjectId setId)

Parameters

Type	Name	Description
ObjectId	displayId
ObjectId	setId

CycleDisplayXAxisMapping(ObjectId)

Declaration

void CycleDisplayXAxisMapping(ObjectId displayId)

Parameters

Type	Name	Description
ObjectId	displayId

GetDisplay(ObjectId)

Declaration

Display GetDisplay(ObjectId displayId)

Parameters

Type	Name	Description
ObjectId	displayId

Returns

Type	Description
Display

GetDisplayParameterById(ObjectId, ObjectId)

Declaration

DisplayParameter GetDisplayParameterById(ObjectId displayId, ObjectId parameterInstanceIdentifier)

Parameters

Type	Name	Description
ObjectId	displayId
ObjectId	parameterInstanceIdentifier

Returns

Type	Description
DisplayParameter

GetDisplayParameterProperties(ObjectId, String)

Declaration

Property[] GetDisplayParameterProperties(ObjectId displayId, string parameterIdentifier)

Parameters

Type	Name	Description
ObjectId	displayId
System.String	parameterIdentifier

Returns

Type	Description
Property[]

GetDisplayParameterPropertyValue(ObjectId, String, String)

Declaration

Value GetDisplayParameterPropertyValue(ObjectId displayId, string parameterIdentifier, string propertyName)

Parameters

Type	Name	Description
ObjectId	displayId
System.String	parameterIdentifier
System.String	propertyName

Returns

Type	Description
Value

GetDisplayParameters(ObjectId)

Declaration

DisplayParameter[] GetDisplayParameters(ObjectId displayId)

Parameters

Type	Name	Description
ObjectId	displayId

Returns

Type	Description
DisplayParameter[]

GetDisplayProperties(ObjectId)

Declaration

Property[] GetDisplayProperties(ObjectId displayId)

Parameters

Type	Name	Description
ObjectId	displayId

Returns

Type	Description
Property[]

GetDisplayPropertyValue(ObjectId, String)

Declaration

Value GetDisplayPropertyValue(ObjectId displayId, string propertyName)

Parameters

Type	Name	Description
ObjectId	displayId
System.String	propertyName

Returns

Type	Description
Value

GetDisplayTimeBase(ObjectId)

Declaration

TimeBase GetDisplayTimeBase(ObjectId displayId)

Parameters

Type	Name	Description
ObjectId	displayId

Returns

Type	Description
TimeBase

RemoveDisplay(ObjectId)

Declaration

void RemoveDisplay(ObjectId displayId)

Parameters

Type	Name	Description
ObjectId	displayId

RemoveDisplayParameter(ObjectId, String)

Declaration

void RemoveDisplayParameter(ObjectId displayId, string parameterIdentifier)

Parameters

Type	Name	Description
ObjectId	displayId
System.String	parameterIdentifier

RemoveDisplayParameterById(ObjectId, ObjectId)

Declaration

void RemoveDisplayParameterById(ObjectId displayId, ObjectId parameterInstanceIdentifier)

Parameters

Type	Name	Description
ObjectId	displayId
ObjectId	parameterInstanceIdentifier

RenameDisplay(ObjectId, String)

Declaration

void RenameDisplay(ObjectId displayId, string name)

Parameters

Type	Name	Description
ObjectId	displayId
System.String	name

SetDisplayLockedToCurrentAssociation(ObjectId, Boolean)

Declaration

void SetDisplayLockedToCurrentAssociation(ObjectId displayId, bool isLockedToCurrentAssociation)

Parameters

Type	Name	Description
ObjectId	displayId
System.Boolean	isLockedToCurrentAssociation

SetDisplayParameterPropertyValue(ObjectId, String, String, Value)

Declaration

void SetDisplayParameterPropertyValue(ObjectId displayId, string parameterIdentifier, string propertyName, Value propertyValue)

Parameters

Type	Name	Description
ObjectId	displayId
System.String	parameterIdentifier
System.String	propertyName
Value	propertyValue

SetDisplayPropertyValue(ObjectId, String, Value)

Declaration

void SetDisplayPropertyValue(ObjectId displayId, string propertyName, Value propertyValue)

Parameters

Type	Name	Description
ObjectId	displayId
System.String	propertyName
Value	propertyValue

TogglePause(ObjectId)

Declaration

void TogglePause(ObjectId displayId)

Parameters

Type	Name	Description
ObjectId	displayId