.. _ocaphysicalposition: 1.2.17 OcaPhysicalPosition =========================== Class Hierarchy: :ref:`OcaRoot ` : :ref:`OcaAgent ` : :ref:`OcaPhysicalPosition ` .. cpp: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**: .. _ocaphysicalposition_classid: .. cpp:member:: static const OcaClassID ClassID = "1.2.17" This property is an override of the **OcaRoot** property. This property has id ``1.1``. .. _ocaphysicalposition_classversion: .. cpp:member:: 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``. .. _ocaphysicalposition_coordinatesystem: .. cpp:member:: const OcaPositionCoordinateSystem CoordinateSystem Type of physical coordinate system this object uses. Read-only, set at object construction time. This property has id ``3.1``. .. _ocaphysicalposition_positiondescriptor: .. cpp:member:: OcaPositionDescriptor PositionDescriptor Position coordinates. For details, see AES70-1, section 5.5.9 and the **OcaPositionDescriptor** datatype definition. This property has id ``3.3``. .. _ocaphysicalposition_positiondescriptorfieldflags: .. cpp:member:: 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 :ref:`ocaagent`: - :cpp:texpr:`OcaClassID` :ref:`OcaRoot::ClassID ` - :cpp:texpr:`OcaClassVersionNumber` :ref:`OcaRoot::ClassVersion ` - :cpp:texpr:`OcaBoolean` :ref:`OcaRoot::Lockable ` - :cpp:texpr:`OcaLockState` :ref:`OcaRoot::LockState ` - :cpp:texpr:`OcaONo` :ref:`OcaRoot::ObjectNumber ` - :cpp:texpr:`OcaString` :ref:`OcaRoot::Role ` - :cpp:texpr:`OcaClassID` :ref:`OcaAgent::ClassID ` - :cpp:texpr:`OcaClassVersionNumber` :ref:`OcaAgent::ClassVersion ` - :cpp:texpr:`OcaString` :ref:`OcaAgent::Label ` - :cpp:texpr:`OcaONo` :ref:`OcaAgent::Owner ` **Methods**: .. _ocaphysicalposition_getcoordinatesystem: .. cpp:function:: OcaStatus GetCoordinateSystem(OcaPositionCoordinateSystem &CoordinateSystem) Gets value of property **CoordinateSystem**. This method has id ``3.1``. - :cpp:expr:`CoordinateSystem`: Output parameter. .. _ocaphysicalposition_getpositiondescriptorfieldflags: .. cpp:function:: OcaStatus GetPositionDescriptorFieldFlags(OcaPositionDescriptorFieldFlags &Flags) Gets value of property **PositionDescriptorFieldFlags**. This method has id ``3.2``. - :cpp:expr:`Flags`: Output parameter. .. _ocaphysicalposition_getpositiondescriptor: .. cpp:function:: OcaStatus GetPositionDescriptor(OcaPositionDescriptor &PositionDescriptor, OcaPositionDescriptor &minPositionDescriptor, OcaPositionDescriptor &maxPositionDescriptor) Gets value of property **PositionDescriptor**. This method has id ``3.3``. - :cpp:expr:`PositionDescriptor`: Output parameter. - :cpp:expr:`minPositionDescriptor`: Output parameter. - :cpp:expr:`maxPositionDescriptor`: Output parameter. .. _ocaphysicalposition_setpositiondescriptor: .. cpp:function:: 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``. - :cpp:expr:`PositionDescriptor`: Input parameter. Methods inherited from :ref:`ocaagent`: - :ref:`OcaAgent::GetClassIdentification ` - :ref:`OcaAgent::GetLockable ` - :ref:`OcaAgent::GetLockState ` - :ref:`OcaAgent::GetRole ` - :ref:`OcaAgent::SetLockNoWrite ` - :ref:`OcaAgent::SetLockNoReadWrite ` - :ref:`OcaAgent::Unlock ` - :ref:`OcaAgent::GetLabel ` - :ref:`OcaAgent::GetOwner ` - :ref:`OcaAgent::GetPath ` - :ref:`OcaAgent::SetLabel `