1.5 OcaDataset

Class Hierarchy:

OcaRoot : OcaDataset

class OcaDataset : OcaRoot

  • An OCA Dataset. A dataset is like a simple binary file that can be read and written.

  • Every dataset is a separate OcaDataset object.

Properties:

static const OcaClassID ClassID = "1.5"

Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This is a class property instead of an object property. This property will be overridden by each descendant class, in order to specify that class’s ClassID.

This property has id 1.1.

static const OcaClassVersionNumber ClassVersion = 1

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.

OcaTime LastModificationTime

Time of last modification. Optional, may be zero if not implemented.

This property has id 2.5.

OcaUint64 MaxSize

Maximum dataset size in bytes.

This property has id 2.6.

OcaString Name

Name of dataset. Must be unique in the device.

This property has id 2.2.

const OcaONo Owner

ONo of block that contains this object

This property has id 2.1.

OcaBoolean ReadOnly

TRUE => dataset is read-only. Value may or may not be changed, depending on implementation.

This property has id 2.4.

OcaMimeType Type

Type of dataset - MIME ‘content-type’ value. See the definition of OcaMimeType. The standard MIME types for AES70 datasets are defined normatively in [AES70-1(Dataset Type)].

This property has id 2.3.

Properties inherited from 1 OcaRoot:

Methods:

OcaStatus OpenRead(OcaLockState RequestedLockState, OcaUint64 &DatasetSize, OcaIOSessionHandle &Handle)

Opens a reading session. Returns status = ProcessingFailed if handle pool is used up.

This method has id 2.1.

OcaStatus OpenWrite(OcaLockState RequestedLockState, OcaUint64 &MaxPartSize, OcaIOSessionHandle &Handle)

Opens a writing session. Returns status = ProcessingFailed if handle pool is used up.

This method has id 2.2.

OcaStatus Close(OcaIOSessionHandle Handle)

Closes a reading or writing session.

This method has id 2.3.

OcaStatus Read(OcaIOSessionHandle Handle, OcaUint64 Position, OcaUint64 PartSize, OcaBoolean &EndOfData, OcaLongBlob &Part)

Reads a part of the Dataset.

This method has id 2.4.

OcaStatus Write(OcaIOSessionHandle Handle, OcaUint64 Position, OcaLongBlob Part)

Writes a part of the dataset.

This method has id 2.5.

OcaStatus Clear(OcaIOSessionHandle Handle)

Removes all data from the dataset.

This method has id 2.6.

OcaStatus GetOwner(OcaONo &Owner)

Gets the value of property Owner.

This method has id 2.7.

  • Owner: Output parameter.

OcaStatus GetName(OcaString &Name)

Gets the value of property Name.

This method has id 2.8.

  • Name: Output parameter.

OcaStatus SetName(OcaString Name)

Sets the value of property Name.

This method has id 2.9.

  • Name: Input parameter.

OcaStatus GetType(OcaString &Type)

Gets the value of property Type.

This method has id 2.10.

  • Type: Output parameter.

OcaStatus SetType(OcaString Type)

Sets the value of property Type .

This method has id 2.11.

  • Type: Input parameter.

OcaStatus GetReadOnly(OcaBoolean &ReadOnly)

Gets the value of the Readonly property.

This method has id 2.12.

OcaStatus SetReadOnly(OcaBoolean ReadOnly)

Sets the value of the Readonly property. Optional method.

This method has id 2.13.

OcaStatus GetLastModificationTime(OcaTime &Time)

Gets the value of property LastModificationTime. Optional method.

This method has id 2.14.

  • Time: Output parameter.

OcaStatus GetDatasetSizes(OcaUint64 &CurrentSize, OcaUint64 &MaxSize)

Gets current & max sizes

This method has id 2.15.

Methods inherited from 1 OcaRoot: