1.2.17 OcaPhysicalPosition

Class Hirarchy:

OcaRootOcaAgentOcaPhysicalPosition

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:

OcaClassID ClassID

This property is an override of the OcaRoot property.

This property has id 3.1.

OcaClassVersionNumber ClassVersion

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 3.2.

OcaPositionCoordinateSystem CoordinateSystem

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

This property has id 3.1.

OcaPositionDescriptorFieldFlags PositionDescriptorFieldFlags

Position descriptor field flags. Describe which position descriptor fields are used by this object. Read-only, set at object construction time.

This property has id 3.2.

OcaPositionDescriptor PositionDescriptor

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

This property has id 3.3.

Properties inherited from OcaAgent:

Properties inherited from OcaRoot:

Methods:

OcaStatus GetCoordinateSystem(OcaPositionCoordinateSystem &CoordinateSystem)

Retrieves value of property CoordinateSystem . Result indicates whether retrieval was successful.

This method has id 3.1.

Parameters

OcaPositionCoordinateSystem CoordinateSystem – Output parameter.

OcaStatus GetPositionDescriptorFieldFlags(OcaPositionDescriptorFieldFlags &Flags)

Retrieves value of property PositionDescriptorFieldFlags . Result indicates whether retrieval was successful.

This method has id 3.2.

Parameters

OcaPositionDescriptorFieldFlags Flags – Output parameter.

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

Retrieves value of property PositioinDescriptor . Result indicates whether retrieval was successful.

This method has id 3.3.

Parameters
  • OcaPositionDescriptor PositionDescriptor – Output parameter.

  • OcaPositionDescriptor minPositionDescriptor – Output parameter.

  • OcaPositionDescriptor maxPositionDescriptor – Output parameter.

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.

Parameters

OcaPositionDescriptor PositionDescriptor – Input parameter.

Methods inherited from OcaAgent:

Methods inherited from OcaRoot: