OcaPhysicalPosition¶
A online version of the AES70 specification of this class can be found at http://docs.deuso.de.
The class is a subclass of OcaAgent()
.
This class defines the properties
Name |
JavaScript Type |
AES70 Type |
---|---|---|
CoordinateSystem |
OcaPositionCoordinateSystem |
OcaPositionCoordinateSystem |
PositionDescriptorFieldFlags |
int |
OcaPositionDescriptorFieldFlags |
PositionDescriptor |
OcaPositionDescriptor |
OcaPositionDescriptor |
Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Label, Owner, CoordinateSystem, PositionDescriptorFieldFlags and PositionDescriptor.
-
class
OcaPhysicalPosition
(objectNumber, device)¶ Physical position of device or an element of it. AES70 supports a variety of positional coordinate systems. For details, see AES70-1, section 5.5.9.
-
OcaPhysicalPosition.
OnPositionDescriptorChanged
¶ type: PropertyEvent.<OcaPositionDescriptor>
This event is emitted when the property PositionDescriptor changes in the remote object. The property
PositionDescriptor
is described in the AES70 standard as follows. Position coordinates. For details, see AES70-1, section 5.5.9 and the <b>OcaPositionDescriptor </b>datatype definition.
-
OcaPhysicalPosition.
GetCoordinateSystem
()¶ Retrieves value of property CoordinateSystem . Result indicates whether retrieval was successful.
- Returns
Promise.<OcaPositionCoordinateSystem> – A promise which resolves to a single value of type
OcaPositionCoordinateSystem()
.
-
OcaPhysicalPosition.
GetPositionDescriptor
()¶ Retrieves value of property PositioinDescriptor . Result indicates whether retrieval was successful. The return values of this method are
PositionDescriptor of type
OcaPositionDescriptor()
minPositionDescriptor of type
OcaPositionDescriptor()
maxPositionDescriptor of type
OcaPositionDescriptor()
- Returns
Promise.<Arguments.<OcaPositionDescriptor, OcaPositionDescriptor, OcaPositionDescriptor>> –
-
OcaPhysicalPosition.
GetPositionDescriptorFieldFlags
()¶ Retrieves value of property PositionDescriptorFieldFlags . Result indicates whether retrieval was successful.
- Returns
Promise.<int> – A promise which resolves to a single value of type
int
.
-
OcaPhysicalPosition.
SetPositionDescriptor
(PositionDescriptor)¶ Sets value of property PositionDescriptor . Result indicates whether setting was successful. The ParameterError status is returned if: (a) the FieldFlags field of the given PositionDescriptor value differs from the object’s basic position descriptor as given in its PositionDescriptorFieldFlags property, or (b) the given CoordinateSystem value conflicts with the object’s basic coordinate system as given in its CoordinateSystem property. This is an optional method, not implemented for read-only position objects.
- Arguments
PositionDescriptor (OcaPositionDescriptor) –
- Returns
Promise.<void> –
-