Index

Class OcaPhysicalPosition

ClassID: 1.2.17

extends 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 readonly OcaClassID ClassID = 1.2.17

Level: 1 Index: 1

This property is an override of the OcaRoot property.

static readonly OcaClassVersionNumber ClassVersion = 1

Level: 1 Index: 2

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.

readonly OcaPositionCoordinateSystem CoordinateSystem

Level: 3 Index: 1

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

readonly OcaPositionDescriptorFieldFlags PositionDescriptorFieldFlags

Level: 3 Index: 2

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

OcaPositionDescriptor PositionDescriptor

Level: 3 Index: 3

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

Properties inherited from OcaAgent

OcaString Label

OcaONo Owner

Properties inherited from OcaRoot

readonly OcaONo ObjectNumber

readonly OcaBoolean Lockable

readonly OcaString Role

Methods

OcaPhysicalPosition::GetCoordinateSystem ( ) → ( OcaPositionCoordinateSystem CoordinateSystem)

Level: 3 Index: 1

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

OcaPhysicalPosition::GetPositionDescriptorFieldFlags ( ) → ( OcaPositionDescriptorFieldFlags Flags)

Level: 3 Index: 2

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

OcaPhysicalPosition::GetPositionDescriptor ( ) → ( OcaPositionDescriptor PositionDescriptor, OcaPositionDescriptor minPositionDescriptor, OcaPositionDescriptor maxPositionDescriptor)

Level: 3 Index: 3

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

OcaPhysicalPosition::SetPositionDescriptor ( OcaPositionDescriptor PositionDescriptor )

Level: 3 Index: 4

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.

Methods inherited from OcaAgent

OcaAgent::GetLabel ( ) → ( OcaString Label)

OcaAgent::SetLabel ( OcaString Label )

OcaAgent::GetOwner ( ) → ( OcaONo owner)

OcaAgent::GetPath ( ) → ( OcaNamePath NamePath, OcaONoPath ONoPath)

Methods inherited from OcaRoot

OcaRoot::GetClassIdentification ( ) → ( OcaClassIdentification ClassIdentification)

OcaRoot::GetLockable ( ) → ( OcaBoolean lockable)

OcaRoot::LockTotal ( )

OcaRoot::Unlock ( )

OcaRoot::GetRole ( ) → ( OcaString Role)

OcaRoot::LockReadonly ( )