1.2.17 OcaPhysicalPosition

Class Hierarchy:

OcaRoot : OcaAgent : OcaPhysicalPosition

class OcaPhysicalPosition : OcaAgent

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.

Properties:

static const OcaClassID ClassID = "1.2.17"

This property is an override of the OcaRoot property.

This property has id 1.1.

static const OcaClassVersionNumber ClassVersion = 3

Identifies the interface version of the class. Any change to the class definition leads to a higher class version. This property is an override of the OcaRoot property.

This property has id 1.2.

const OcaPositionCoordinateSystem CoordinateSystem

Type of physical coordinate system this object uses. Read-only, set at object construction time.

This property has id 3.1.

OcaPositionDescriptor PositionDescriptor

Position coordinates. For details, see AES70-1, section 5.5.9 and the OcaPositionDescriptor datatype definition.

This property has id 3.3.

const OcaPositionDescriptorFieldFlags PositionDescriptorFieldFlags

Position descriptor field flags. Describe which position descriptor fields are used by this object. Note that for a given position determining mechanism, not all position descriptor fields might be used. For example, a 2D position descriptor will not use altitude coordinates. Read-only, set at object construction time.

This property has id 3.2.

Properties inherited from 1.2 OcaAgent:

Methods:

OcaStatus GetCoordinateSystem(OcaPositionCoordinateSystem &CoordinateSystem)

Gets value of property CoordinateSystem.

This method has id 3.1.

OcaStatus GetPositionDescriptorFieldFlags(OcaPositionDescriptorFieldFlags &Flags)

Gets value of property PositionDescriptorFieldFlags.

This method has id 3.2.

  • Flags: Output parameter.

OcaStatus GetPositionDescriptor(OcaPositionDescriptor &PositionDescriptor, OcaPositionDescriptor &minPositionDescriptor, OcaPositionDescriptor &maxPositionDescriptor)

Gets value of property PositionDescriptor.

This method has id 3.3.

OcaStatus SetPositionDescriptor(OcaPositionDescriptor 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.

This method has id 3.4.

Methods inherited from 1.2 OcaAgent: