AAF Object Manager Documentation

OMBuiltinPropertyDefinition::localIdentification

OMPropertyId OMBuiltinPropertyDefinition::localIdentification(void)

The locally unique identification of the OMProperty defined by this OMBuiltinPropertyDefinition.

Defined in: OMPropertyDefinition.cpp

OMBuiltinPropertyDefinition::name

const wchar_t* OMBuiltinPropertyDefinition::name(void)

The name of the OMProperty defined by this OMBuiltinPropertyDefinition.

Defined in: OMPropertyDefinition.cpp

OMBuiltinPropertyDefinition::OMBuiltinPropertyDefinition

OMBuiltinPropertyDefinition::OMBuiltinPropertyDefinition(void)

Constructor.

Defined in: OMPropertyDefinition.cpp

OMBuiltinPropertyDefinition::type

const OMType* OMBuiltinPropertyDefinition::type(void)

The type of the OMProperty defined by this OMBuiltinPropertyDefinition.

Defined in: OMPropertyDefinition.cpp

OMBuiltinPropertyDefinition::~OMBuiltinPropertyDefinition

OMBuiltinPropertyDefinition::~OMBuiltinPropertyDefinition(void)

Destructor.

Defined in: OMPropertyDefinition.cpp

OMCharacterStringProperty class

OMCharacterStringProperty class OMCharacterStringProperty: public OMVariableSizeProperty

Abstract base class for persistent character string properties supported by the Object Manager.

Defined in: OMCharacterStringProperty.h

Class Template Arguments

CharacterType: The type of the characters that comprise the string.

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMCharacterStringProperty(const OMPropertyId propertyId, const wchar_t* name): Constructor.
virtual ~OMCharacterStringProperty(void): Destructor.
operator const CharacterType* () const: Type conversion. Convert an OMCharacterStringProperty into a string of CharacterType characters.
void assign(const CharacterType* characterString): Assign the string characterString to this OMCharacterStringProperty.
size_t length(void) const: The length of this OMCharacterStringProperty in characters (not counting the null terminating character).
static size_t stringLength(const CharacterType* characterString): Utility function for computing the length, in characters, of the string of CharacterType characters characterString.

OMCharacterStringProperty::assign

template <class CharacterType>
void OMCharacterStringProperty<CharacterType>::assign(const CharacterType* characterString)

Assign the string characterString to this OMCharacterStringProperty.

Defined in: OMCharacterStringPropertyT.h

Parameters

characterString: The string of CharacterType characters to assign.

Class Template Arguments

CharacterType: The type of the characters that comprise the string.

OMCharacterStringProperty::length

template <class CharacterType>
size_t OMCharacterStringProperty<CharacterType>::length(void) const

The length of this OMCharacterStringProperty in characters (not counting the null terminating character).

Defined in: OMCharacterStringPropertyT.h

Return Value

The length of this OMCharacterStringProperty.

Class Template Arguments

CharacterType: The type of the characters that comprise the string.

OMCharacterStringProperty::operator const CharacterType*

template <class CharacterType>
OMCharacterStringProperty<CharacterType>::operator const CharacterType*(void)

Type conversion. Convert an OMCharacterStringProperty into a string of CharacterType characters.

Defined in: OMCharacterStringPropertyT.h

Return Value

The result of the conversion as a value of type pointer to CharacterType.

Class Template Arguments

CharacterType: The type of the characters that comprise the string.

OMCharacterStringProperty::stringLength

template <class CharacterType>
size_t OMCharacterStringProperty<CharacterType>::stringLength(const CharacterType* characterString)

Utility function for computing the length, in characters, of the string of CharacterType characters characterString.

Defined in: OMCharacterStringPropertyT.h

Return Value

The length of the the string of CharacterType characters characterString.

Parameters

characterString: A string of CharacterType characters.

Class Template Arguments

CharacterType: The type of the characters that comprise the string.

OMClassFactory class

OMClassFactory class OMClassFactory

Abstract base class decribing the class factory used by the Object Manager and provided by Object Manager clients.

Defined in: OMClassFactory.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

virtual ~OMClassFactory(void): Destructor.
virtual OMStorable* create(const OMClassId& classId) const: Create an instance of the appropriate derived class, given the class id.

OMContainer class

OMContainer class OMContainer

Abstract base class for collections of elements.

Defined in: OMContainer.h

Class Template Arguments

Element: The type of an OMContainer element. This type must support = and ==.

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

virtual size_t count(void) const: The number of elements in this OMContainer. count returns the actual number of elements in the OMContainer.
virtual void clear(void): Remove all elements from this OMContainer.

OMContainerElement class

OMContainerElement class OMContainerElement

Elements of Object Manager reference containers.

Defined in: OMContainerElement.h

Class Template Arguments

ObjectReference: The type of the contained object reference

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMContainerElement(void): Constructor.
OMContainerElement(const ObjectReference& reference): Constructor.
OMContainerElement(const OMContainerElement<ObjectReference>& rhs): Copy constructor.
~OMContainerElement(void): Destructor.
OMContainerElement<ObjectReference>& operator=: Assignment. This operator provides value semantics for OMContainer. This operator does not provide assignment of object references.
bool operator==(const OMContainerElement<ObjectReference>& rhs) const: Equality. This operator provides value semantics for OMContainer. This operator does not provide equality of object references.
ObjectReference& reference(void): The contained ObjectReference.
void setReference(const ObjectReference& reference): Set the contained ObjectReference.
void save(void): Save this OMContainerElement.
void close(void): Close this OMContainerElement.
void detach(void): Detach this OMContainerElement.
void restore(void): Restore this OMContainerElement.
OMStorable* getValue(void) const: Get the value of this OMContainerElement.
OMStorable* pointer(void) const: The value of this OMContainerElement as a pointer. This function provides low-level access. If the object exits but has not yet been loaded then the value returned is 0.

Class Members

Protected members.

ObjectReference _reference: The actual object reference.

OMContainerElement::close

template <class ObjectReference>
void OMContainerElement<ObjectReference>::close(void)

Close this OMContainerElement.

Defined in: OMContainerElementT.h

Class Template Arguments

ObjectReference: The type of the contained object reference

Back to OMContainerElement

OMContainerElement::detach

template <class ObjectReference>
void OMContainerElement<ObjectReference>::detach(void)

Detach this OMContainerElement.

Defined in: OMContainerElementT.h

Class Template Arguments

ObjectReference: The type of the contained object reference

Back to OMContainerElement

OMContainerElement::getValue

template <class ObjectReference>
OMStorable* OMContainerElement<ObjectReference>::getValue(void) const

Get the value of this OMContainerElement.

Defined in: OMContainerElementT.h

Return Value

A pointer to the ReferencedObject.

Class Template Arguments

ObjectReference: The type of the contained object reference

Back to OMContainerElement

OMContainerElement::OMContainerElement

template <class ObjectReference>
OMContainerElement<ObjectReference>::OMContainerElement(const OMContainerElement<ObjectReference>& rhs)

Copy constructor.

Defined in: OMContainerElementT.h

Parameters

rhs: The OMContainerElement to copy.

Class Template Arguments

ObjectReference: The type of the contained object reference

Back to OMContainerElement

OMContainerElement::OMContainerElement

template <class ObjectReference>
OMContainerElement<ObjectReference>::OMContainerElement(const ObjectReference& reference)

Constructor.

Defined in: OMContainerElementT.h

Parameters

reference: The ObjectReference for this OMContainerElement.

Class Template Arguments

ObjectReference: The type of the contained object reference

Back to OMContainerElement

OMContainerElement::OMContainerElement

template <class ObjectReference>
OMContainerElement<ObjectReference>::OMContainerElement(void)

Constructor.

Defined in: OMContainerElementT.h

Class Template Arguments

ObjectReference: The type of the contained object reference

Back to OMContainerElement

OMContainerElement::operator=

template <class ObjectReference>
OMContainerElement<ObjectReference>& OMContainerElement<ObjectReference>::operator=(const OMContainerElement<ObjectReference>& rhs)

Assignment. This operator provides value semantics for OMContainer. This operator does not provide assignment of object references.

Defined in: OMContainerElementT.h

Return Value

The OMContainerElement resulting from the assignment.

Parameters

rhs: The OMContainerElement to be assigned.

Class Template Arguments

ObjectReference: The type of the contained object reference

Back to OMContainerElement

OMContainerElement::operator==

template <class ObjectReference>
bool OMContainerElement<ObjectReference>::operator==(const OMContainerElement<ObjectReference>& rhs)

Equality. This operator provides value semantics for OMContainer. This operator does not provide equality of object references.

Defined in: OMContainerElementT.h

Return Value

True if the values are the same, false otherwise.

Parameters

rhs: The OMContainerElement to be compared.

Class Template Arguments

ObjectReference: The type of the contained object reference

Back to OMContainerElement

OMContainerElement::pointer

template <class ObjectReference>
OMStorable* OMContainerElement<ObjectReference>::pointer(void)

The value of this OMContainerElement as a pointer. This function provides low-level access. If the object exits but has not yet been loaded then the value returned is 0.

Defined in: OMContainerElementT.h

Return Value

A pointer to the reference OMStorable, if loaded.

Class Template Arguments

ObjectReference: The type of the contained object reference

Back to OMContainerElement

OMContainerElement::reference

template <class ObjectReference>
ObjectReference& OMContainerElement<ObjectReference>::reference(void)

The contained ObjectReference.

Defined in: OMContainerElementT.h

Return Value

The contained ObjectReference.

Class Template Arguments

ObjectReference: The type of the contained object reference

Back to OMContainerElement

OMContainerElement::restore

template <class ObjectReference>
void OMContainerElement<ObjectReference>::restore(void)

Restore this OMContainerElement.

Defined in: OMContainerElementT.h

Class Template Arguments

ObjectReference: The type of the contained object reference

Back to OMContainerElement

OMContainerElement::save

template <class ObjectReference>
void OMContainerElement<ObjectReference>::save(void)

Save this OMContainerElement.

Defined in: OMContainerElementT.h

Class Template Arguments

ObjectReference: The type of the contained object reference

Back to OMContainerElement

OMContainerElement::setReference

template <class ObjectReference>
void OMContainerElement<ObjectReference>::setReference(const ObjectReference& reference)

Set the contained ObjectReference.

Defined in: OMContainerElementT.h

Parameters

reference: The new contained ObjectReference.

Class Template Arguments

ObjectReference: The type of the contained object reference

Back to OMContainerElement

OMContainerElement::~OMContainerElement

template <class ObjectReference>
OMContainerElement<ObjectReference>::~OMContainerElement(void)

Destructor.

Defined in: OMContainerElementT.h

Class Template Arguments

ObjectReference: The type of the contained object reference

Back to OMContainerElement

OMContainerIterator class

OMContainerIterator class OMContainerIterator

Abstract base class for iterators over Object Manager containers. The elements of an Object Manager container have a well defined order. An Object Manager container may be traversed in either the forward or reverse direction.

Defined in: OMContainerIterator.h

Class Template Arguments

Element: The type of the contained elements.

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

virtual void reset(OMIteratorPosition initialPosition): Reset this OMContainerIterator to the given initialPosition. If initialPosition is specified as OMBefore then this OMContainerIterator is made ready to traverse the associated OMContainer in the forward direction. If initialPosition is specified as OMAfter then this OMContainerIterator is made ready to traverse the associated OMContainer in the reverse direction.
virtual bool before(void) const: Is this OMContainerIterator positioned before the first Element ?
virtual bool after(void) const: Is this OMContainerIterator positioned after the last Element ?
virtual bool valid(void) const: Is this OMContainerIterator validly positioned on an Element ?
virtual bool operator++(): Advance this OMContainerIterator to the next Element, if any. If the end of the associated OMContainer is not reached then the result is true , valid becomes true and after becomes false . If the end of the associated OMContainer is reached then the result is false , valid becomes false and after becomes true .
virtual bool operator--(): Retreat this OMContainerIterator to the previous Element, if any. If the beginning of the associated OMContainer is not reached then the result is true , valid becomes true and before becomes false . If the beginning of the associated OMContainer is reached then the result is false , valid becomes false and before becomes true .
virtual Element& value(void) const: Return the Element in the associated OMContainer at the position currently designated by this OMContainerIterator.

OMContainerProperty class

OMContainerProperty class OMContainerProperty: public OMProperty

Abstract base class for persistent object reference container properties supported by the Object Manager.

Defined in: OMContainerProperty.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMContainerProperty(const OMPropertyId propertyId, const OMStoredForm storedForm, const wchar_t* name): Constructor.
virtual ~OMContainerProperty(void): Destructor.
virtual OMReferenceContainer* referenceContainer(void): Convert to OMReferenceContainer.
OMUInt32 localKey(void) const: The current local key.
void setLocalKey(OMUInt32 newLocalKey): Set the current local key. Used on restore to restart local key assignment.

Class Members

Protected members.

wchar_t* elementName(OMUInt32 localKey): Compute the name of an element in this OMContainter given the element's localKey.
OMUInt32 nextLocalKey(void): Obtain the next available local key.

Class Members

Private members.

OMUInt32 _localKey: The next available local key.

OMContainerProperty::elementName

wchar_t* OMContainerProperty::elementName(OMUInt32 localKey)

Compute the name of an element in this OMContainer given the element's localKey.

Defined in: OMContainerProperty.cpp

Parameters

localKey: The element's local key.

Back to OMContainerProperty

OMContainerProperty::~OMContainerProperty

OMContainerProperty::~OMContainerProperty(void)

Destructor.

Defined in: OMContainerProperty.cpp

Back to OMContainerProperty

OMDataStream class

OMDataStream class OMDataStream: public OMProperty.

Persistent data stream properties supported by the Object Manager.

Defined in: OMDataStream.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMDataStream(const OMPropertyId propertyId, const wchar_t* name): Constructor.
~OMDataStream(void): Destructor.
virtual OMUInt64 size(void) const: The size, in bytes, of the data in this OMDataStreamProperty.
virtual void setPosition(const OMUInt64 offset) const: Set the current position for read() and write(), as an offset in bytes from the begining of the data stream.
virtual void read(OMByte* buffer, const OMUInt32 bytes, OMUInt32& bytesRead) const: Attempt to read the number of bytes given by bytes from the data stream into the buffer at address buffer. The actual number of bytes read is returned in bytesRead.

OMDataStream::OMDataStream

OMDataStream::OMDataStream(void)

Constructor.

Defined in: OMDataStream.cpp

Back to OMDataStream

OMDataStream::~OMDataStream

OMDataStream::~OMDataStream(void)

Destructor.

Defined in: OMDataStream.cpp

Back to OMDataStream

OMDataStreamProperty class

OMDataStreamProperty class OMDataStreamProperty: public OMDataStream.

Persistent data stream properties supported by the Object Manager.

Defined in: OMDataStreamProperty.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMDataStreamProperty(const OMPropertyId propertyId, const wchar_t* name): Constructor.
virtual ~OMDataStreamProperty(void): Destructor.
virtual void save(void) const: Save this OMDataStreamProperty.
virtual void restore(size_t externalSize): Restore this OMDataStreamProperty, the size of the OMDataStreamProperty is externalSize.
virtual void close(void): Close this OMDataStreamProperty.
virtual OMUInt64 size(void) const: The size, in bytes, of the data in this OMDataStreamProperty.
void setSize(const OMUInt64 newSize): Set the size, in bytes, of the data in this OMDataStreamProperty.
OMUInt64 position(void) const: The current position for read() and write(), as an offset in bytes from the begining of the data stream.
virtual void setPosition(const OMUInt64 offset) const: Set the current position for read() and write(), as an offset in bytes from the begining of the data stream.
virtual void read(OMByte* buffer, const OMUInt32 bytes, OMUInt32& bytesRead) const: Attempt to read the number of bytes given by bytes from the data stream into the buffer at address buffer. The actual number of bytes read is returned in bytesRead.
void write(const OMByte* buffer, const OMUInt32 bytes, OMUInt32& bytesWritten): Attempt to write the number of bytes given by bytes to the data stream from the buffer at address buffer. The actual number of bytes written is returned in bytesWritten.
void readTypedElements(const OMType* elementType, size_t externalElementSize, OMByte* elements, OMUInt32 elementCount, OMUInt32& elementsRead) const: Attempt to read the number of elements given by elementCount and described by elementType and externalElementSize from the data stream into the buffer at address elements. The actual number of elements read is returned in elementsRead.
void writeTypedElements(const OMType* elementType, size_t internalElementSize, const OMByte* elements, OMUInt32 elementCount, OMUInt32& elementsWritten): Attempt to write the number of elements given by elementCount and described by elementType and internalElementSize to the data stream from the buffer at address elements. The actual number of elements written is returned in elementsWritten.
virtual size_t bitsSize(void) const: The size of the raw bits of this OMDataStreamProperty. The size is given in bytes.
virtual void getBits(OMByte* bits, size_t size) const: Get the raw bits of this OMDataStreamProperty. The raw bits are copied to the buffer at address bits which is size bytes in size.
virtual void setBits(const OMByte* bits, size_t size): Set the raw bits of this OMDataStreamProperty. The raw bits are copied from the buffer at address bits which is size bytes in size.
virtual bool hasByteOrder(void) const: Is a byte order specifed for this stream ?
virtual void setByteOrder(OMByteOrder byteOrder): Specify a byte order for this stream.
virtual OMByteOrder byteOrder(void) const: The byte order of this stream.
virtual void clearByteOrder(void): Clear the byte order of this stream

OMDataStreamProperty::bitsSize

size_t OMDataStreamProperty::bitsSize(void) const

The size of the raw bits of this OMDataStreamProperty. The size is given in bytes.

void OMDataStreamProperty::getBits(OMByte* bits, size_t size) const

Get the raw bits of this OMDataStreamProperty. The raw bits are copied to the buffer at address bits which is size bytes in size.

Defined in: OMDataStreamProperty.cpp

Parameters

bits: The address of the buffer into which the raw bits are copied.
size: The size of the buffer.

Back to OMDataStreamProperty

OMDataStreamProperty::hasByteOrder

bool OMDataStreamProperty::hasByteOrder(void)

Is a byte order specifed for this stream ?

externalSize: The size of the OMDataStreamProperty.

Back to OMDataStreamProperty

OMDataStreamProperty::save

void OMDataStreamProperty::save(void) const

Save this OMDataStreamProperty.

Defined in: OMDataStreamProperty.cpp

Back to OMDataStreamProperty

OMDataStreamProperty::setBits

void OMDataStreamProperty::setBits(const OMByte* bits, size_t size)

Set the raw bits of this OMDataStreamProperty. The raw bits are copied from the buffer at address bits which is size bytes in size.

Defined in: OMDataStreamProperty.cpp

Parameters

bits: The address of the buffer from which the raw bits are copied.
size: The size of the buffer.

Back to OMDataStreamProperty

OMDataStreamProperty::setByteOrder

void OMDataStreamProperty::setByteOrder(void)

Specify a byte order for this stream.

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

virtual ~OMDefinition(void): Destructor.
virtual const OMUniqueObjectIdentification& identification(void) const: The unique identification of the entity defined by this OMDefinition.
virtual const wchar_t* name(void) const: The name of the entity defined by this OMDefinition.

OMDiskRawStorage class

OMDiskRawStorage class OMDiskRawStorage: public OMRawStorage

Class supporting access to the raw bytes of disk files supported by the Object Manager.

This is an Object Manager built-in implementation of the OMRawStorage interface. The implementation uses ANSI file functions only.

Defined in: OMDiskRawStorage.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Static members.

static OMDiskRawStorage* openExistingRead(const wchar_t* fileName): Create an OMDiskRawStorage object by opening an existing file for read-only access, the file is named fileName. The file must already exist.
static OMDiskRawStorage* openExistingModify(const wchar_t* fileName): Create an OMDiskRawStorage object by opening an existing file for modify access, the file is named fileName. The file must already exist.
static OMDiskRawStorage* openNewModify(const wchar_t* fileName): Create an OMDiskRawStorage object by creating a new file for modify access, the file is named fileName. The file must not already exist.

Class Members

Public members.

virtual ~OMDiskRawStorage(void)

Destructor.

virtual bool isReadable(void) const

Is it possible to read from this OMDiskRawStorage ?

virtual void read(OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesRead) const

Attempt to read the number of bytes given by byteCount from the current position in this OMDiskRawStorage into the buffer at address bytes. The actual number of bytes read is returned in bytesRead. Reading from positions greater than size causes bytesRead to be less than byteCount. Reading bytes that have never been written returns undefined data in bytes.

virtual void readAt(OMUInt64 position, OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesRead) const

Attempt to read the number of bytes given by byteCount from offset position in this OMDiskRawStorage into the buffer at address bytes. The actual number of bytes read is returned in bytesRead. Reading from positions greater than size causes bytesRead to be less than byteCount. Reading bytes that have never been written returns undefined data in bytes.

preconditions

isReadable() && isPositionable()

virtual bool isWritable(void) const

Is it possible to write to this OMDiskRawStorage ?

virtual void write(const OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesWritten)

Attempt to write the number of bytes given by byteCount to the current position in this OMDiskRawStorage from the buffer at address bytes. The actual number of bytes written is returned in bytesWritten. Writing to positions greater than size causes this OMDiskRawStorage to be extended, however such extension can fail, causing bytesWritten to be less than byteCount.

virtual void writeAt(OMUInt64 position, const OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesWritten)

Attempt to write the number of bytes given by byteCount to offset position in this OMDiskRawStorage from the buffer at address bytes. The actual number of bytes written is returned in bytesWritten. Writing to positions greater than size causes this OMDiskRawStorage to be extended, however such extension can fail, causing bytesWritten to be less than byteCount.

preconditions

isWritable() && isPositionable()

Developer Notes

How is failure to extend indicated ?

virtual bool isExtendible(void) const: May this OMDiskRawStorage be changed in size ?
virtual OMUInt64 extent(void) const: The current extent of this OMDiskRawStorage in bytes. The extent() is the allocated size, while the size() is the valid size. precondition - isPositionable()
virtual void extend(OMUInt64 newSize): Set the size of this OMDiskRawStorage to newSize bytes. If newSize is greater than size then this OMDiskRawStorage is extended. If newSize is less than size then this OMDiskRawStorage is truncated. Truncation may also result in the current position for read() and write() being set to size. precondition - isExtendible()
virtual OMUInt64 size(void) const: The current size of this OMDiskRawStorage in bytes. The size() is the valid size, while the extent() is the allocated size. precondition - isPositionable()
virtual bool isPositionable(void) const: May the current position, for read() and write(), of this OMDiskRawStorage be changed ?
virtual OMUInt64 position(void) const: The current position for read() and write(), as an offset in bytes from the beginning of this OMDiskRawStorage. precondition - isPositionable()
virtual void setPosition(OMUInt64 newPosition) const: Set the current position for read() and write(), as an offset in bytes from the beginning of this OMDiskRawStorage. precondition - isPositionable()
virtual void synchronize(void): Synchronize this OMDiskRawStorage with its external representation.

Class Members

Protected members.

OMDiskRawStorage(FILE* file, OMFile::OMAccessMode accessMode): Constructor.

Class Members

Private members.

OMDiskRawStorage::extend

void OMDiskRawStorage::extend(OMUInt64 newSize)

Set the size of this OMDiskRawStorage to newSize bytes. If newSize is greater than size then this OMDiskRawStorage is extended. If newSize is less than size then this OMDiskRawStorage is truncated. Truncation may also result in the current position for read() and write() being set to size. precondition - isExtendible()

Defined in: OMDiskRawStorage.cpp

Parameters

newSize: The new size of this OMDiskRawStorage in bytes.

Return Value

The newly created OMDiskRawStorage object.

Parameters

fileName: The file name.

Back to OMDiskRawStorage

OMDiskRawStorage::openExistingRead

OMDiskRawStorage* OMDiskRawStorage::openExistingRead(const wchar_t* fileName)

Create an OMDiskRawStorage object by opening an existing file for read-only access, the file is named fileName. The file must already exist.

Defined in: OMDiskRawStorage.cpp

Return Value

The newly created OMDiskRawStorage object.

Parameters

fileName: The file name.

Back to OMDiskRawStorage

OMDiskRawStorage::openNewModify

OMDiskRawStorage* OMDiskRawStorage::openNewModify(const wchar_t* fileName)

Create an OMDiskRawStorage object by creating a new file for modify access, the file is named fileName. The file must not already exist.

Defined in: OMDiskRawStorage.cpp

Return Value

The newly created OMDiskRawStorage object.

Parameters

fileName: The file name.

Developer Notes

fseek takes a long int for offset this may not be sufficient for 64-bit offsets.

Back to OMDiskRawStorage

OMDiskRawStorage::size

OMUInt64 OMDiskRawStorage::size(void) const

The current size of this OMDiskRawStorage in bytes. precondition - isPositionable()

Defined in: OMDiskRawStorage.cpp

Return Value

The current size of this OMDiskRawStorage in bytes.

Back to OMDiskRawStorage

OMDiskRawStorage::synchronize

void OMDiskRawStorage::synchronize(void)

Synchronize this OMDiskRawStorage with its external representation.

Defined in: OMDiskRawStorage.cpp

Back to OMDiskRawStorage

OMDiskRawStorage::write

void OMDiskRawStorage::write(const OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesWritten)

Attempt to write the number of bytes given by byteCount to the current position in this OMDiskRawStorage from the buffer at address bytes. The actual number of bytes written is returned in bytesWritten. Writing to positions greater than size causes this OMDiskRawStorage to be extended, however such extension can fail, causing bytesWritten to be less than byteCount.

Defined in: OMDiskRawStorage.cpp

Parameters

bytes: The buffer from which the bytes are to be written.
byteCount: The number of bytes to write.
bytesWritten: The actual number of bytes written.

Back to OMDiskRawStorage

OMDiskRawStorage::writeAt

void OMDiskRawStorage::writeAt(OMUInt64 position, const OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesWritten)

Attempt to write the number of bytes given by byteCount to offset position in this OMDiskRawStorage from the buffer at address bytes. The actual number of bytes written is returned in bytesWritten. Writing to positions greater than size causes this OMDiskRawStorage to be extended, however such extension can fail, causing bytesWritten to be less than byteCount.

Defined in: OMDiskRawStorage.cpp

Parameters

position: The position to which the bytes are to be written.
bytes: The buffer from which the bytes are to be written.
byteCount: The number of bytes to write.
bytesWritten: The actual number of bytes written.

Back to OMDiskRawStorage

OMDiskRawStorage::~OMDiskRawStorage

OMDiskRawStorage::~OMDiskRawStorage(void)

Destructor.

Defined in: OMDiskRawStorage.cpp

Back to OMDiskRawStorage

OMFile class

OMFile class OMFile: public OMStorable

Files supported by the Object Manager.

Defined in: OMFile.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

enum OMAccessMode: File access modes.
enum OMLoadMode: Lazy loading modes (degrees of indolence).
enum OMFileEncoding: Supported file encodings.

Class Members

Static members.

static OMFile* openExistingRead(const wchar_t* fileName, const OMClassFactory* factory, void* clientOnRestoreContext, const OMLoadMode loadMode, OMDictionary* dictionary = 0): Open an existing OMFile for read-only access, the OMFile is named fileName, use the OMClassFactory factory to create the objects. The file must already exist.
static OMFile* openExistingModify(const wchar_t* fileName, const OMClassFactory* factory, void* clientOnRestoreContext, const OMLoadMode loadMode, OMDictionary* dictionary = 0): Open an existing OMFile for modify access, the OMFile is named fileName, use the OMClassFactory factory to create the objects. The file must already exist.
static OMFile* openNewModify(const wchar_t* fileName, const OMClassFactory* factory, void* clientOnRestoreContext, const OMByteOrder byteOrder, OMStorable* clientRoot, const OMFileSignature& signature, OMDictionary* dictionary = 0): Open a new OMFile for modify access, the OMFile is named fileName, use the OMClassFactory factory to create the objects. The file must not already exist. The byte ordering on the newly created file is given by byteOrder. The client root OMStorable in the newly created file is given by clientRoot.
static bool compatibleRawStorage(const OMRawStorage* rawStorage, const OMAccessMode accessMode, const OMFileSignature& signature): Is the given OMRawStorage compatible with the given file access mode and signature ? Can a file of the encoding specified by signature be created successfully on rawStorage and then accessed successfully in the mode specified by accessMode ?
static OMFile* openExistingRead(OMRawStorage* rawStorage, const OMClassFactory* factory, void* clientOnRestoreContext, const OMLoadMode loadMode, OMDictionary* dictionary = 0): Open an existing OMFile for read-only access.

Developer Notes

Will superceed openExistingRead() above.

static OMFile* openExistingModify(OMRawStorage* rawStorage, const OMClassFactory* factory, void* clientOnRestoreContext, const OMLoadMode loadMode, OMDictionary* dictionary = 0): Open an existing OMFile for modify access.

Developer Notes

Will superceed openExistingModify() above.

static OMFile* openNewWrite(OMRawStorage* rawStorage, const OMClassFactory* factory, void* clientOnRestoreContext, const OMByteOrder byteOrder, OMStorable* clientRoot, const OMFileSignature& signature, OMDictionary* dictionary = 0): Open a new OMFile for write access.
static OMFile* openNewModify(OMRawStorage* rawStorage, const OMClassFactory* factory, void* clientOnRestoreContext, const OMByteOrder byteOrder, OMStorable* clientRoot, const OMFileSignature& signature, OMDictionary* dictionary = 0): Open a new OMFile for modify access.

Developer Notes

Will superceed openNewModify() above.

static bool validSignature(const OMFileSignature& signature): Is signature a valid signature for an OMFile ?
static bool isRecognized(const wchar_t* fileName, OMFileSignature& signature, OMFileEncoding& encoding): Is the file named fileName a recognized file ? If so, the result is true, and the signature is returned in signature and the encoding in encoding.
static bool isRecognized(OMRawStorage* rawStorage, OMFileSignature& signature, OMFileEncoding& encoding): Does rawStorage contain a recognized file ? If so, the result is true, and the signature is returned in signature and the encoding in encoding.
static bool isRecognized(const OMFileSignature& signature, OMFileEncoding& encoding): Is signature recognized ? If so, the result is true, and the encoding is returned in encoding.

Class Members

Public members.

~OMFile(void)

Destructor.

void saveFile(void* clientOnSaveContext = 0)

Save all changes made to the contents of this OMFile. It is not possible to save read-only or transient files.

preconditions

isOpen()

void saveAsFile(OMFile* destFile) const

Save the entire contents of this OMFile as well as any unsaved changes in the new file destFile. destFile must be open, writeable and not yet contain any objects. saveAsFile may be called for files opened in modify mode and for files opened in read-only and transient modes.

void revert(void)

Discard all changes made to this OMFile since the last save or open.

OMStorable* restore(void)

Restore the client root OMStorable object from this OMFile.

preconditions

isOpen()

void open(void)

Open this OMFile.

preconditions

!isOpen()

!isClosed()

postconditions

isOpen()

void close(void)

Close this OMFile, any unsaved changes are discarded.

preconditions

isOpen()

postconditions

!isOpen()

isClosed()

bool isOpen(void) const

Is this OMFile open ?

bool isClosed(void) const

Is this OMFile closed ? Note that isClosed() is not the same as !isOpen() since before open() is called, isClosed() is false. That is, isClosed() means "was once open and is now closed".

OMStorable* clientRoot(void)

Retrieve the client root OMStorable from this OMFile.

OMStorable* root(void)

Retrieve the root OMStorable from this OMFile.

OMPropertyTable* referencedProperties(void)

Retrieve the OMPropertyTable from this OMFile.

OMObjectDirectory* objectDirectory(void)

Retrieve the OMObjectDirectory from this OMFile.

OMByteOrder byteOrder(void) const

The byte order of this OMFile.

OMLoadMode loadMode(void) const

The loading mode (eager or lazy) of this OMFile.

OMAccessMode accessMode(void) const

The access mode of this OMFile.

bool isReadable(void) const

Is it possible to read from this OMFile ?

bool isWritable(void) const

Is it possible to write to this OMFile ?

bool isOMFile(void) const

Is this file recognized by the Object Manager ?

const wchar_t* fileName(void) const

The name of this OMFile.

Developer Notes

Soon to be obsolete.

OMFileSignature signature(void) const: The signature of this OMFile.
OMFileEncoding encoding(void) const: The encoding of this OMFile.
OMRawStorage* rawStorage(void) const: The raw storage on which this OMFile is stored.
virtual OMProperty* findPropertyPath(const wchar_t* propertyPathName) const: Find the property instance in this OMFile named by propertyPathName.

Class Members

Private members.

OMFile(const wchar_t* fileName, void* clientOnRestoreContext, OMFileSignature signature, const OMAccessMode mode, OMStoredObject* store, const OMClassFactory* factory, OMDictionary* dictionary, const OMLoadMode loadMode): Constructor. Create an OMFile object representing an existing named external file.
OMFile(const wchar_t* fileName, void* clientOnRestoreContext, OMFileSignature signature, const OMAccessMode mode, OMStoredObject* store, const OMClassFactory* factory, OMDictionary* dictionary, OMRootStorable* root): Constructor. Create an OMFile object representing a new named external file.
OMFile(OMRawStorage* rawStorage, void* clientOnRestoreContext, const OMAccessMode mode, const OMClassFactory* factory, OMDictionary* dictionary, const OMLoadMode loadMode): Constructor. Create an OMFile object representing an existing external file on the given OMRawStorage.

Developer Notes

Will superceed OMFile::OMFile (for existing files) above.

OMFile(OMRawStorage* rawStorage, void* clientOnRestoreContext, OMFileSignature signature, const OMAccessMode mode, const OMClassFactory* factory, OMDictionary* dictionary, OMRootStorable* root, const OMByteOrder byteOrder): Constructor. Create an OMFile object representing a new external file on the given OMRawStorage.

Developer Notes

Will superceed OMFile::OMFile (for new files) above.

OMFile::accessMode

OMFile::OMAccessMode OMFile::accessMode(void) const

The access mode of this OMFile.

Defined in: OMFile.cpp

Return Value

The access mode of this OMFile.

True if this OMFile is readable, false otherwise.

True if this OMFile is writable, false otherwise.

Class Members

bool OMFile:: isReadable(void) const: Is it possible to read from this OMFile ?

Class Members

bool OMFile:: isWritable(void) const: Is it possible to write to this OMFile ?

postconditions

!isOpen()

isClosed()

Back to OMFile

OMFile::compatibleRawStorage

bool OMFile::compatibleRawStorage(const OMRawStorage* rawStorage, const OMAccessMode accessMode, const OMFileSignature& signature)

Is the given OMRawStorage compatible with the given file access mode and signature ? Can a file of the encoding specified by signature be created successfully on rawStorage and then accessed successfully in the mode specified by accessMode ?

Defined in: OMFile.cpp

Return Value

TBS

Parameters

rawStorage: The OMRawStorage on which the file is to be created.
accessMode: TBS
signature: TBS

Parameters

propertyPathName: The pathname to the desired property.

Back to OMFile

OMFile::isClosed

bool OMFile::isClosed(void)

Is this OMFile closed ? Note that isClosed() is not the same as !isOpen() since before open() is called, isClosed() is false. That is, isClosed() means "was once open and is now closed".

Defined in: OMFile.cpp

Back to OMFile

OMFile::isOMFile

bool OMFile::isOMFile(void) const

Is this file recognized by the Object Manager ?

Defined in: OMFile.cpp

Return Value

True if this file is recognized by the Object Manager, false otherwise.

Back to OMFile

OMFile::isOpen

bool OMFile::isOpen(void)

Is this OMFile open ?

signature: If recognized, the encoding.

Back to OMFile

OMFile::loadMode

OMFile::OMLoadMode OMFile::loadMode(void) const

The loading mode (eager or lazy) of this OMFile.

Defined in: OMFile.cpp

Return Value

The loading mode (eager or lazy) of this OMFile.

Back to OMFile

OMFile::objectDirectory

OMObjectDirectory* OMFile::objectDirectory(void)

Retrieve the OMObjectDirectory from this OMFile.

Defined in: OMFile.cpp

Return Value

The OMObjectDirectory associated with this file.

Back to OMFile

OMFile::OMFile

OMFile::OMFile(void)

Constructor. Create an OMFile object representing an existing external file on the given OMRawStorage.

Defined in: OMFile.cpp

Back to OMFile

OMFile::OMFile

OMFile::OMFile(const wchar_t* fileName, void* clientOnRestoreContext, OMFileSignature signature, const OMAccessMode mode, OMStoredObject* store)

Constructor. Create an OMFile object representing an existing named external file.

Defined in: OMFile.cpp

Parameters

fileName: The name of this OMFile.
clientOnRestoreContext: The access mode of this OMFile.
signature: The OMStoredObject containing the root OMStorable object.
mode: The OMClassFactory to use to restore objects from this OMFile.
store: The OMLoadMode for this OMFile.

Back to OMFile

OMFile::OMFile

OMFile::OMFile(const wchar_t* fileName, void* clientOnRestoreContext, OMFileSignature signature, const OMAccessMode mode, OMStoredObject* store, const OMClassFactory* factory)

Constructor. Create an OMFile object representing a new named external file.

Defined in: OMFile.cpp

Parameters

fileName: The name of this OMFile.
clientOnRestoreContext: The signature of this OMFile.
signature: The access mode of this OMFile.
mode: The OMStoredObject in which to store the root OMStorable object.
store: The OMClassFactory to use to restore objects from this OMFile.
factory: The root OMStorable object to save in this file.

Back to OMFile

OMFile::OMFile

OMFile::OMFile(void)

Constructor. Create an OMFile object representing a new external file on the given OMRawStorage.

Defined in: OMFile.cpp

Back to OMFile

OMFile::open

void OMFile::open(void)

Open this OMFile.

Defined in: OMFile.cpp

preconditions

!isOpen()

!isClosed()

postconditions

fileName: The name of the file to create.
factory: The factory to use for creating objects.
clientOnRestoreContext: The byte order to use for the newly created file.
byteOrder: The client root OMStorable in the newly created file.

preconditions

isOpen()

Back to OMFile

OMFile::revert

void OMFile::revert(void)

Discard all changes made to this OMFile since the last save or open.

Defined in: OMFile.cpp

Back to OMFile

OMFile::saveAsFile

void OMFile::saveAsFile(OMFile* destFile) const

Save the entire contents of this OMFile as well as any unsaved changes in the new file destFile. destFile must be open, writeable and not yet contain any objects. saveAsFile may be called for files opened in modify mode and for files opened in read-only and transient modes.

Defined in: OMFile.cpp

Parameters

destFile: The destination file.

Back to OMFile

OMFile::saveFile

void OMFile::saveFile(void* clientOnSaveContext)

Save all changes made to the contents of this OMFile. It is not possible to save read-only or transient files.

Defined in: OMFile.cpp

Parameters

clientOnSaveContext

Client context for callbacks.

preconditions

isOpen()

Back to OMFile

OMFile::signature

OMFileSignature OMFile::signature(void)

The signature of this OMFile.

Defined in: OMFile.cpp

Return Value

The signature of this OMFile.

Back to OMFile

OMFile::validSignature

bool OMFile::validSignature(const OMFileSignature& signature)

Is signature a valid signature for an OMFile ?

Defined in: OMFile.cpp

Return Value

True if signature is a valid signature for an OMFile, false otherwise.

Parameters

signature: The signature to check.

Back to OMFile

OMFile::~OMFile

OMFile::~OMFile(void)

Destructor.

Defined in: OMFile.cpp

Back to OMFile

OMFixedSizeProperty class

OMFixedSizeProperty class OMFixedSizeProperty: public OMSimpleProperty

Fixed size simple (data) persistent properties supported by the Object Manager.

Defined in: OMFixedSizeProperty.h

Class Template Arguments

PropertyType: The type of the property. This can be any type with well defined copy and assignment semantics.

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMFixedSizeProperty(const OMPropertyId propertyId, const wchar_t* name): Constructor.
virtual ~OMFixedSizeProperty(void): Destructor.
void getValue(PropertyType& value) const: Get the value of this OMFixedSizeProperty.
void setValue(const PropertyType& value): Set the value of this OMFixedSizeProperty.
OMFixedSizeProperty<PropertyType>& operator=(const PropertyType& value): Assignment operator.
operator PropertyType() const: Type conversion. Convert an OMFixedSizeProperty into a PropertyType.
PropertyType* operator&(void): "Address of" operator.
const PropertyType& reference(void) const: Convert this OMFixedSizeProperty into a const reference to a PropertyType.
virtual void restore(size_t externalSize): Restore this OMFixedSizeProperty, the external (persisted) size of the OMFixedSizeProperty is externalSize.

OMFixedSizeProperty::getValue

template <class PropertyType>
void OMFixedSizeProperty<PropertyType>::getValue(PropertyType& value) const

Get the value of this OMFixedSizeProperty.

Defined in: OMFixedSizePropertyT.h

Parameters

value: A value of PropertyType by reference.

Class Template Arguments

PropertyType: The type of the property. This can be any type with well defined copy and assignment semantics.

Back to OMFixedSizeProperty

OMFixedSizeProperty::operator PropertyType

template <class PropertyType>
OMFixedSizeProperty<PropertyType>::operator PropertyType(void) const

Type conversion. Convert an OMFixedSizeProperty into a PropertyType.

Defined in: OMFixedSizePropertyT.h

Return Value

The result of the conversion as a value of type PropertyType.

Class Template Arguments

PropertyType: The type of the property. This can be any type with well defined copy and assignment semantics.

Back to OMFixedSizeProperty

OMFixedSizeProperty::operator&

template <class PropertyType>
PropertyType* OMFixedSizeProperty<PropertyType>::operator&(void)

"Address of" operator.

Defined in: OMFixedSizePropertyT.h

Return Value

Pointer to a PropertyType

Class Template Arguments

PropertyType: The type of the property. This can be any type with well defined copy and assignment semantics.

OMFixedSizeProperty::operator=

template <class PropertyType>
OMFixedSizeProperty<PropertyType>& OMFixedSizeProperty<PropertyType>::operator=(const PropertyType& value)

Assignment operator.

Defined in: OMFixedSizePropertyT.h

Return Value

A value of OMFixedSizeProperty by reference.

Parameters

value: A value of PropertyType by reference.

Class Template Arguments

PropertyType: The type of the property. This can be any type with well defined copy and assignment semantics.

OMFixedSizeProperty::reference

template <class PropertyType>
const PropertyType& OMFixedSizeProperty<PropertyType>::reference(void) const

Convert this OMFixedSizeProperty into a const reference to a PropertyType.

Defined in: OMFixedSizePropertyT.h

Return Value

Const reference to a PropertyType.

Class Template Arguments

PropertyType: The type of the property. This can be any type with well defined copy and assignment semantics.

Back to OMFixedSizeProperty

OMFixedSizeProperty::restore

template <class PropertyType>
void OMFixedSizeProperty<PropertyType>::restore(size_t externalSize)

Restore this OMFixedSizeProperty, the external (persisted) size of the OMFixedSizeProperty is externalSize.

Defined in: OMFixedSizePropertyT.h

Parameters

externalSize: The external (persisted) size of the OMFixedSizeProperty.

Class Template Arguments

PropertyType: The type of the property. This can be any type with well defined copy and assignment semantics.

OMFixedSizeProperty::setValue

template <class PropertyType>
void OMFixedSizeProperty<PropertyType>::setValue(const PropertyType& value)

Set the value of this OMFixedSizeProperty.

Defined in: OMFixedSizePropertyT.h

Parameters

value: A value of PropertyType by reference.

Class Template Arguments

PropertyType: The type of the property. This can be any type with well defined copy and assignment semantics.

OMIdentitySet class

OMIdentitySet class OMIdentitySet: public OMContainer

Sets of unique elements. Duplicate elements are not allowed.

Defined in: OMIdentitySet.h

Class Template Arguments

Element: The type of the unique elements. This type must support operator =, operator !=, operator == and operator <.

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMIdentitySet()

Constructor.

virtual ~OMIdentitySet(void)

Destructor.

virtual void insert(const Element& element)

Insert element into this OMIdentitySet.

preconditions

!contains(element)

bool ensurePresent(const Element& element)

If it is not already present, insert element into this OMIdentitySet and return true, otherwise return false.

virtual bool contains(const Element& element) const

Does this OMIdentitySet contain element ?

size_t count(void) const

The number of elements in this OMIdentitySet.

virtual void remove(const Element& element)

Remove the element from this OMIdentitySet.

preconditions

contains(element)

virtual void clear(void)

Remove all elements from this OMIdentitySet.

bool ensureAbsent(const Element& element)

If it is present, remove element from this OMIdentitySet and return true, otherwise return false.

Class Members

Private members.

OMKLVStoredObject class

OMKLVStoredObject class OMKLVStoredObject

In-memory representation of an object persisted in a SMPTE (Society of Motion Picture and Television Engineers) Key Length Value (KLV) binary file.

Defined in: OMKLVStoredObject.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Static members.

static OMKLVStoredObject* openRead(OMRawStorage* rawStorage): Open the root OMKLVStoredObject in the raw storage rawStorage for reading only.
static OMKLVStoredObject* openModify(OMRawStorage* rawStorage): Open the root OMKLVStoredObject in the raw storage rawStorage for modification.
static OMKLVStoredObject* createWrite(OMRawStorage* rawStorage, const OMByteOrder byteOrder): Create a new root OMKLVStoredObject in the raw storage rawStorage. The byte order of the newly created root is given by byteOrder.
static OMKLVStoredObject* createModify(OMRawStorage* rawStorage, const OMByteOrder byteOrder): Create a new root OMKLVStoredObject in the raw storage rawStorage. The byte order of the newly created root is given by byteOrder.
static bool isRecognized(const wchar_t* fileName, OMFileSignature& signature): Is the file named fileName a recognized file ? If so, the result is true, and the signature is returned in signature.
static bool isRecognized(OMRawStorage* rawStorage, OMFileSignature& signature): Does rawStorage contain a recognized file ? If so, the result is true, and the signature is returned in signature.
static bool isRecognized(const OMFileSignature& signature): Is signature recognized ?

Class Members

Public members.

virtual ~OMKLVStoredObject(void): Destructor.
virtual OMStoredObject* create(const wchar_t* name): Create a new OMKLVStoredObject, named name, contained by this OMKLVStoredObject.

Developer Notes

The name argument to this member function doesn't make sense for all derived instances of OMStoredObject.

virtual OMStoredObject* open(const wchar_t* name): Open an exsiting OMKLVStoredObject, named name, contained by this OMKLVStoredObject.

Developer Notes

The name argument to this member function doesn't make sense for all derived instances of OMStoredObject.

virtual void close(void): Close this OMKLVStoredObject.
virtual OMByteOrder byteOrder(void) const: The byte order of this OMKLVStoredObject.

Developer Notes

This member function doesn't make sense for all derived instances of OMStoredObject.

virtual void save(const OMStoredObjectIdentification& id): Save the OMStoredObjectIdentification id in this OMKLVStoredObject.
virtual void save(const OMPropertySet& properties): Save the OMPropertySet properties in this OMKLVStoredObject.
virtual void save(const OMSimpleProperty& property): Save the OMSimpleProperty property in this OMKLVStoredObject.
virtual void save(const OMStrongReference& singleton): Save the OMStrongReference singleton in this OMKLVStoredObject.
virtual void save(const OMStrongReferenceVector& vector): Save the OMStrongReferenceVector vector in this OMKLVStoredObject.
virtual void save(const OMStrongReferenceSet& set): Save the OMStrongReferenceSet set in this OMKLVStoredObject.
virtual void save(const OMWeakReference& singleton): Save the OMWeakReference singleton in this OMKLVStoredObject.
virtual void save(const OMWeakReferenceVector& vector): Save the OMWeakReferenceVector vector in this OMKLVStoredObject.
virtual void save(const OMWeakReferenceSet& set): Save the OMWeakReferenceSet set in this OMKLVStoredObject.
virtual void save(const OMPropertyTable* table): Save the OMPropertyTable table in this OMKLVStoredObject.

Developer Notes

Does this member function make sense for all derived instances of OMStoredObject ?

virtual void save(const OMDataStream& stream): Save the OMDataStream stream in this OMKLVStoredObject.
virtual void restore(OMStoredObjectIdentification& id): Restore the OMStoredObjectIdentification of this OMKLVStoredObject into id.
virtual void restore(OMPropertySet& properties): Restore the OMPropertySet properties into this OMKLVStoredObject.
virtual void restore(OMSimpleProperty& property, size_t externalSize): Restore the OMSimpleProperty property into this OMKLVStoredObject.

Developer Notes

The externalSize argument to this member function doesn't make sense for all derived instances of OMStoredObject.

virtual void restore(OMStrongReference& singleton, size_t externalSize): Restore the OMStrongReference singleton into this OMKLVStoredObject.
virtual void restore(OMStrongReferenceVector& vector, size_t externalSize): Restore the OMStrongReferenceVector vector into this OMKLVStoredObject.
virtual void restore(OMStrongReferenceSet& set, size_t externalSize): Restore the OMStrongReferenceSet set into this OMKLVStoredObject.
virtual void restore(OMWeakReference& singleton, size_t externalSize): Restore the OMWeakReference singleton into this OMKLVStoredObject.
virtual void restore(OMWeakReferenceVector& vector, size_t externalSize): Restore the OMWeakReferenceVector vector into this OMKLVStoredObject.
virtual void restore(OMWeakReferenceSet& set, size_t externalSize): Restore the OMWeakReferenceSet set into this OMKLVStoredObject.
virtual void restore(OMPropertyTable*& table): Restore the OMPropertyTable in this OMKLVStoredObject.

Developer Notes

Does this member function make sense for all derived instances of OMStoredObject ?

virtual void restore(OMDataStream& stream, size_t externalSize): Restore the OMDataStream stream into this OMKLVStoredObject.
virtual OMStoredStream* openStoredStream(const OMDataStream& property): Open the OMStoredStream representing the property stream contained within this OMKLVStoredObject.
virtual OMStoredStream* createStoredStream(const OMDataStream& property): Create an OMStoredStream representing the property stream contained within this OMKLVStoredObject.

Class Members

Private members.

OMKLVStoredObject(OMRawStorage* s, OMByteOrder byteOrder): Constructor.

OMKLVStoredObject::byteOrder

OMByteOrder OMKLVStoredObject::byteOrder(void) const

The byte order of this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Return Value

The byte order.

Back to OMKLVStoredObject

OMKLVStoredObject::close

void OMKLVStoredObject::close(void)

Close this OMKLVStoredObject.

TRACE: The signature to check.

Back to OMKLVStoredObject

OMKLVStoredObject::OMKLVStoredObject

OMKLVStoredObject::OMKLVStoredObject(OMRawStorage* s, OMByteOrder byteOrder)

Constructor.

Defined in: OMKLVStoredObject.cpp

Parameters

s: The OMRawStorage on which this OMKLVStoredObject resides.
byteOrder: TBS

Back to OMKLVStoredObject

OMKLVStoredObject::open

OMStoredObject* OMKLVStoredObject::open(const wchar_t* { TRACE)

Open an exsiting OMKLVStoredObject, named name, contained by this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Return Value

The existing OMKLVStoredObject contained by this OMKLVStoredObject. name */)

Parameters

TRACE: The name of the existing OMKLVStoredObject.

Back to OMKLVStoredObject

OMKLVStoredObject::openModify

OMKLVStoredObject* OMKLVStoredObject::openModify(OMRawStorage* ANAME)

Open the root OMKLVStoredObject in the raw storage

Defined in: OMKLVStoredObject.cpp

Return Value

An OMKLVStoredObject representing the root object. rawStorage for modification.

Parameters

ANAME: The raw storage in which to open the file.

Back to OMKLVStoredObject

OMKLVStoredObject::openRead

OMKLVStoredObject* OMKLVStoredObject::openRead(OMRawStorage* ANAME)

Open the root OMKLVStoredObject in the raw storage rawStorage for reading only.

Defined in: OMKLVStoredObject.cpp

Return Value

An OMKLVStoredObject representing the root object.

Parameters

ANAME: The raw storage in which to open the file.

Back to OMKLVStoredObject

OMKLVStoredObject::openStoredStream

OMStoredStream* OMKLVStoredObject::openStoredStream(const OMDataStream& { TRACE)

Open the OMStoredStream representing the property stream contained within this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Return Value

The newly created OMStoredStream.

Parameters

TRACE: The OMDataStream to be opened.

Back to OMKLVStoredObject

OMKLVStoredObject::restore

void OMKLVStoredObject::restore(OMStrongReferenceSet& size_t { TRACE, OMKLVStoredObject:: restore)

Restore the OMStrongReferenceSet set into this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The newly restored OMStrongReferenceSet.
restore: The external size. set */,

Back to OMKLVStoredObject

OMKLVStoredObject::restore

void OMKLVStoredObject::restore(OMWeakReference& size_t { TRACE, OMKLVStoredObject:: restore)

Restore the OMWeakReference singleton into this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The newly restored OMWeakReference.
restore: The external size. singleton */,

Back to OMKLVStoredObject

OMKLVStoredObject::restore

void OMKLVStoredObject::restore(OMSimpleProperty& size_t { TRACE, OMKLVStoredObject:: restore)

Restore the OMSimpleProperty property into this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The newly restored OMSimpleProperty
restore: The external size. property */,

Back to OMKLVStoredObject

OMKLVStoredObject::restore

void OMKLVStoredObject::restore(OMStrongReference& size_t { TRACE, OMKLVStoredObject:: restore)

Restore the OMStrongReference singleton into this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The newly restored OMStrongReference.
restore: The external size. singleton */,

Back to OMKLVStoredObject

OMKLVStoredObject::restore

void OMKLVStoredObject::restore(OMWeakReferenceVector& size_t { TRACE, OMKLVStoredObject:: restore)

Restore the OMWeakReferenceVector vector into this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The newly restored OMWeakReferenceVector.
restore: The external size. vector */,

Back to OMKLVStoredObject

OMKLVStoredObject::restore

void OMKLVStoredObject::restore( TRACE)

Restore the OMPropertySet properties into this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The newly restored OMPropertySet. properties */)

Back to OMKLVStoredObject

OMKLVStoredObject::restore

void OMKLVStoredObject::restore( TRACE)

Restore the OMStoredObjectIdentification of this OMKLVStoredObject into id.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The newly restored OMStoredObjectIdentification. id */)

Back to OMKLVStoredObject

OMKLVStoredObject::restore

void OMKLVStoredObject::restore(OMWeakReferenceSet& size_t { TRACE, OMKLVStoredObject:: restore)

Restore the OMWeakReferenceSet set into this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The newly restored OMWeakReferenceSet.
restore: The external size. set */,

Back to OMKLVStoredObject

OMKLVStoredObject::restore

void OMKLVStoredObject::restore( TRACE)

Restore the OMPropertyTable in this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The newly restored OMPropertyTable. table */)

Back to OMKLVStoredObject

OMKLVStoredObject::restore

void OMKLVStoredObject::restore(OMStrongReferenceVector& size_t { TRACE, OMKLVStoredObject:: restore)

Restore the OMStrongReferenceVector vector into this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The newly restored OMStrongReferenceVector.
restore: The external size. vector */,

Back to OMKLVStoredObject

OMKLVStoredObject::restore

void OMKLVStoredObject::restore(OMDataStream& size_t { TRACE, OMKLVStoredObject:: restore)

Restore the OMDataStream stream into this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The newly restored OMDataStream.
restore: The external size. stream */,

Back to OMKLVStoredObject

OMKLVStoredObject::save

void OMKLVStoredObject::save( TRACE)

Save the OMStrongReferenceVector vector in this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The OMStrongReferenceVector to save. vector */)

Back to OMKLVStoredObject

OMKLVStoredObject::save

void OMKLVStoredObject::save( TRACE)

Save the OMStrongReference singleton in this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The OMStrongReference to save. singleton */)

Back to OMKLVStoredObject

OMKLVStoredObject::save

void OMKLVStoredObject::save( TRACE)

Save the OMStoredObjectIdentification id in this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The OMStoredObjectIdentification to save. id */)

Back to OMKLVStoredObject

OMKLVStoredObject::save

void OMKLVStoredObject::save( TRACE)

Save the OMPropertySet properties in this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The OMPropertySet to save. properties */)

Back to OMKLVStoredObject

OMKLVStoredObject::save

void OMKLVStoredObject::save( TRACE)

Save the OMSimpleProperty property in this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The OMSimpleProperty to save. property */)

Back to OMKLVStoredObject

OMKLVStoredObject::save

void OMKLVStoredObject::save( TRACE)

Save the OMPropertyTable table in this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The OMPropertyTable to save. table */)

Back to OMKLVStoredObject

OMKLVStoredObject::save

void OMKLVStoredObject::save( TRACE)

Save the OMDataStream stream in this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The OMDataStream to save. stream */)

Back to OMKLVStoredObject

OMKLVStoredObject::save

void OMKLVStoredObject::save( TRACE)

Save the OMWeakReferenceSet set in this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The OMWeakReferenceSet to save. set */)

Back to OMKLVStoredObject

OMKLVStoredObject::save

void OMKLVStoredObject::save( TRACE)

Save the OMStrongReferenceSet set in this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The OMStrongReference to save. set */)

Back to OMKLVStoredObject

OMKLVStoredObject::save

void OMKLVStoredObject::save( TRACE)

Save the OMWeakReference singleton in this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The OMWeakReference to save. singleton */)

Back to OMKLVStoredObject

OMKLVStoredObject::save

void OMKLVStoredObject::save( TRACE)

Save the OMWeakReferenceVector vector in this OMKLVStoredObject.

Defined in: OMKLVStoredObject.cpp

Parameters

TRACE: The OMWeakReferenceVector to save. vector */)

Back to OMKLVStoredObject

OMKLVStoredObject::~OMKLVStoredObject

OMKLVStoredObject::~OMKLVStoredObject(void)

Destructor.

Defined in: OMKLVStoredObject.cpp

Back to OMKLVStoredObject

OMKLVStoredStream class

OMKLVStoredStream class OMKLVStoredStream: public OMStoredStream

Implementation of OMStoredStream for SMPTE (Society of Motion Picture and Television Engineers) Key Length Value (KLV) binary files.

Defined in: OMKLVStoredStream.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMKLVStoredStream(OMRawStorage* store): Constructor.
~OMKLVStoredStream(void): Destructor.
virtual void read(void* data, size_t size) const: Read size bytes from this OMXMLStoredStream into the buffer at address data.
virtual void read(OMByte* data, const OMUInt32 bytes, OMUInt32& bytesRead) const: Attempt to read bytes bytes from this OMXMLStoredStream into the buffer at address data. The actual number of bytes read is returned in bytesRead.
virtual void write(void* data, size_t size): Write size bytes from the buffer at address data to this OMXMLStoredStream.
virtual void write(const OMByte* data, const OMUInt32 bytes, OMUInt32& bytesWritten): Attempt to write bytes bytes from the buffer at address data to this OMXMLStoredStream. The actual number of bytes written is returned in bytesWritten.
virtual OMUInt64 size(void) const: The size of this OMXMLStoredStream in bytes.
virtual void setSize(const OMUInt64 newSize): Set the size of this OMXMLStoredStream to bytes.
virtual OMUInt64 position(void) const: The current position for read() and write(), as an offset in bytes from the begining of this OMXMLStoredStream.
virtual void setPosition(const OMUInt64 offset): Set the current position for read() and write(), as an offset in bytes from the begining of this OMXMLStoredStream.
virtual void close(void): Close this OMXMLStoredStream.

Class Members

Private members.

OMMappedFileRawStorage class

OMMappedFileRawStorage class OMMappedFileRawStorage: public OMRawStorage

Class supporting access to the raw bytes of memory mapped disk files supported by the Object Manager.

This is an Object Manager built-in implementation of the OMRawStorage interface.

Defined in: OMMappedFileRawStorage.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Static members.

static OMMappedFileRawStorage* openExistingRead(const wchar_t* fileName): Create an OMMappedFileRawStorage object by opening an existing file for read-only access, the file is named fileName. The file must already exist.
static OMMappedFileRawStorage* openExistingModify(const wchar_t* fileName): Create an OMMappedFileRawStorage object by opening an existing file for modify access, the file is named fileName. The file must already exist.
static OMMappedFileRawStorage* openNewModify(const wchar_t* fileName): Create an OMMappedFileRawStorage object by creating a new file for modify access, the file is named fileName. The file must not already exist.

Class Members

Public members.

virtual ~OMMappedFileRawStorage(void)

Destructor.

virtual bool isReadable(void) const

Is it possible to read from this OMMappedFileRawStorage ?

virtual void read(OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesRead) const

Attempt to read the number of bytes given by byteCount from the current position in this OMMappedFileRawStorage into the buffer at address bytes. The actual number of bytes read is returned in bytesRead. Reading from positions greater than size causes bytesRead to be less than byteCount. Reading bytes that have never been written returns undefined data in bytes.

virtual void readAt(OMUInt64 position, OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesRead) const

Attempt to read the number of bytes given by byteCount from offset position in this OMMappedFileRawStorage into the buffer at address bytes. The actual number of bytes read is returned in bytesRead. Reading from positions greater than size causes bytesRead to be less than byteCount. Reading bytes that have never been written returns undefined data in bytes.

preconditions

isReadable() && isPositionable()

virtual bool isWritable(void) const

Is it possible to write to this OMMappedFileRawStorage ?

virtual void write(const OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesWritten)

Attempt to write the number of bytes given by byteCount to the current position in this OMMappedFileRawStorage from the buffer at address bytes. The actual number of bytes written is returned in bytesWritten. Writing to positions greater than size causes this OMMappedFileRawStorage to be extended, however such extension can fail, causing bytesWritten to be less than byteCount.

virtual void writeAt(OMUInt64 position, const OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesWritten)

Attempt to write the number of bytes given by byteCount to offset position in this OMMappedFileRawStorage from the buffer at address bytes. The actual number of bytes written is returned in bytesWritten. Writing to positions greater than size causes this OMMappedFileRawStorage to be extended, however such extension can fail, causing bytesWritten to be less than byteCount.

preconditions

isWritable() && isPositionable()

Developer Notes

How is failure to extend indicated ?

virtual bool isExtendible(void) const: May this OMMappedFileRawStorage be changed in size ?
virtual OMUInt64 extent(void) const: The current extent of this OMMappedFileRawStorage in bytes. The extent() is the allocated size, while the size() is the valid size. precondition - isPositionable()
virtual void extend(OMUInt64 newSize): Set the size of this OMMappedFileRawStorage to newSize bytes. If newSize is greater than size then this OMMappedFileRawStorage is extended. If newSize is less than size then this OMMappedFileRawStorage is truncated. Truncation may also result in the current position for read() and write() being set to size. precondition - isExtendible()
virtual OMUInt64 size(void) const: The current size of this OMMappedFileRawStorage in bytes. The size() is the valid size, while the extent() is the allocated size. precondition - isPositionable()
virtual bool isPositionable(void) const: May the current position, for read() and write(), of this OMMappedFileRawStorage be changed ?
virtual OMUInt64 position(void) const: The current position for read() and write(), as an offset in bytes from the beginning of this OMMappedFileRawStorage. precondition - isPositionable()
virtual void setPosition(OMUInt64 newPosition) const: Set the current position for read() and write(), as an offset in bytes from the beginning of this OMMappedFileRawStorage. precondition - isPositionable()
virtual void synchronize(void): Synchronize this OMMappedFileRawStorage with its external representation.

Class Members

Private members.

none OMMappedFileRawStorageaccessMode: Constructor. TBS */ OMFile::OMAccessMode accessMode);

OMMappedFileRawStorage::extend

void OMMappedFileRawStorage::extend(OMUInt64 { TRACE)

Set the size of this OMMappedFileRawStorage to newSize bytes. If newSize is greater than size then this OMMappedFileRawStorage is extended. If newSize is less than size then this OMMappedFileRawStorage is truncated. Truncation may also result in the current position for read() and write() being set to size. precondition - isExtendible()

Defined in: OMMappedFileRawStorage.cpp

Parameters

TRACE: The new size of this OMMappedFileRawStorage in bytes.

Return Value

The newly created OMMappedFileRawStorage object.

Parameters

TRACE: The file name.

Back to OMMappedFileRawStorage

OMMappedFileRawStorage::openExistingRead

OMMappedFileRawStorage* OMMappedFileRawStorage::openExistingRead(const wchar_t* { TRACE)

Create an OMMappedFileRawStorage object by opening an existing file for read-only access, the file is named fileName. The file must already exist.

Defined in: OMMappedFileRawStorage.cpp

Return Value

The newly created OMMappedFileRawStorage object.

Parameters

TRACE: The file name.

Back to OMMappedFileRawStorage

OMMappedFileRawStorage::openNewModify

OMMappedFileRawStorage* OMMappedFileRawStorage::openNewModify(const wchar_t* { TRACE)

Create an OMMappedFileRawStorage object by creating a new file for modify access, the file is named fileName. The file must not already exist.

Defined in: OMMappedFileRawStorage.cpp

Return Value

The newly created OMMappedFileRawStorage object.

Parameters

TRACE: The file name.

Developer Notes

fseek takes a long int for offset this may not be sufficient for 64-bit offsets. newPosition */) const

OMMappedFileRawStorage::size

OMUInt64 OMMappedFileRawStorage::size(void) const

The current size of this OMMappedFileRawStorage in bytes. precondition - isPositionable()

Defined in: OMMappedFileRawStorage.cpp

Return Value

The current size of this OMMappedFileRawStorage in bytes.

OMMappedFileRawStorage::synchronize

void OMMappedFileRawStorage::synchronize(void)

Synchronize this OMMappedFileRawStorage with its external representation.

Defined in: OMMappedFileRawStorage.cpp

OMMappedFileRawStorage::write

void OMMappedFileRawStorage::write(const OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesWritten)

Attempt to write the number of bytes given by byteCount to the current position in this OMMappedFileRawStorage from the buffer at address bytes. The actual number of bytes written is returned in bytesWritten. Writing to positions greater than size causes this OMMappedFileRawStorage to be extended, however such extension can fail, causing bytesWritten to be less than byteCount.

Defined in: OMMappedFileRawStorage.cpp

Parameters

bytes: The buffer from which the bytes are to be written.
byteCount: The number of bytes to write.
bytesWritten: The actual number of bytes written. bytes */,

Back to OMMappedFileRawStorage

OMMappedFileRawStorage::writeAt

void OMMappedFileRawStorage::writeAt(OMUInt64 position, OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesWritten)

Attempt to write the number of bytes given by byteCount to offset position in this OMMappedFileRawStorage from the buffer at address bytes. The actual number of bytes written is returned in bytesWritten. Writing to positions greater than size causes this OMMappedFileRawStorage to be extended, however such extension can fail, causing bytesWritten to be less than byteCount.

Defined in: OMMappedFileRawStorage.cpp

Parameters

position: The position to which the bytes are to be written.
bytes: The buffer from which the bytes are to be written.
byteCount: The number of bytes to write.
bytesWritten: The actual number of bytes written. position */,

Back to OMMappedFileRawStorage

OMMappedFileRawStorage::~OMMappedFileRawStorage

OMMappedFileRawStorage::~OMMappedFileRawStorage(void)

Destructor.

Defined in: OMMappedFileRawStorage.cpp

OMMemoryRawStorage class

OMMemoryRawStorage class OMMemoryRawStorage: public OMRawStorage

Class supporting access to the raw bytes of memory files supported by the Object Manager.

This is an Object Manager built-in implementation of the OMRawStorage interface.

Defined in: OMMemoryRawStorage.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Static members.

static OMMemoryRawStorage* openNewModify(void): Create an OMMemoryRawStorage object for modify access.

Class Members

Public members.

virtual ~OMMemoryRawStorage(void)

Destructor.

virtual bool isReadable(void) const

Is it possible to read from this OMMemoryRawStorage ?

virtual void read(OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesRead) const

Attempt to read the number of bytes given by byteCount from the current position in this OMMemoryRawStorage into the buffer at address bytes. The actual number of bytes read is returned in bytesRead. Reading from positions greater than size causes bytesRead to be less than byteCount. Reading bytes that have never been written returns undefined data in bytes.

virtual void readAt(OMUInt64 position, OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesRead) const

Attempt to read the number of bytes given by byteCount from offset position in this OMMemoryRawStorage into the buffer at address bytes. The actual number of bytes read is returned in bytesRead. Reading from positions greater than size causes bytesRead to be less than byteCount. Reading bytes that have never been written returns undefined data in bytes.

preconditions

isReadable() && isPositionable()

virtual bool isWritable(void) const

Is it possible to write to this OMMemoryRawStorage ?

virtual void write(const OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesWritten)

Attempt to write the number of bytes given by byteCount to the current position in this OMMemoryRawStorage from the buffer at address bytes. The actual number of bytes written is returned in bytesWritten. Writing to positions greater than size causes this OMMemoryRawStorage to be extended, however such extension can fail, causing bytesWritten to be less than byteCount.

virtual void writeAt(OMUInt64 position, const OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesWritten)

Attempt to write the number of bytes given by byteCount to offset position in this OMMemoryRawStorage from the buffer at address bytes. The actual number of bytes written is returned in bytesWritten. Writing to positions greater than size causes this OMMemoryRawStorage to be extended, however such extension can fail, causing bytesWritten to be less than byteCount.

preconditions

isWritable() && isPositionable()

Developer Notes

How is failure to extend indicated ?

virtual bool isExtendible(void) const: May this OMMemoryRawStorage be changed in size ?
virtual OMUInt64 extent(void) const: The current extent of this OMMemoryRawStorage in bytes. The extent() is the allocated size, while the size() is the valid size. precondition - isPositionable()
virtual void extend(OMUInt64 newSize): Set the size of this OMMemoryRawStorage to newSize bytes. If newSize is greater than size then this OMMemoryRawStorage is extended. If newSize is less than size then this OMMemoryRawStorage is truncated. Truncation may also result in the current position for read() and write() being set to size. precondition - isExtendible()
virtual OMUInt64 size(void) const: The current size of this OMMemoryRawStorage in bytes. The size() is the valid size, while the extent() is the allocated size. precondition - isPositionable()
virtual bool isPositionable(void) const: May the current position, for read() and write(), of this OMMemoryRawStorage be changed ?
virtual OMUInt64 position(void) const: The current position for read() and write(), as an offset in bytes from the beginning of this OMMemoryRawStorage. precondition - isPositionable()
virtual void setPosition(OMUInt64 newPosition) const: Set the current position for read() and write(), as an offset in bytes from the beginning of this OMMemoryRawStorage. precondition - isPositionable()
virtual void synchronize(void): Synchronize this OMMemoryRawStorage with its external representation.

Class Members

Private members.

OMMemoryRawStorage(void): Constructor.
virtual void write(size_t page, size_t offset, size_t byteCount, const OMByte* source): Write a page or partial page.
virtual void read(size_t page, size_t offset, size_t byteCount, OMByte* destination) const: Read a page or partial page.

OMMemoryRawStorage::extend

void OMMemoryRawStorage::extend(OMUInt64 newSize)

Set the size of this OMMemoryRawStorage to newSize bytes. If newSize is greater than size then this OMMemoryRawStorage is extended. If newSize is less than size then this OMMemoryRawStorage is truncated. Truncation may also result in the current position for read() and write() being set to size. precondition - isExtendible()

Defined in: OMMemoryRawStorage.cpp

Parameters

newSize: The new size of this OMMemoryRawStorage in bytes.

Developer Notes

fseek takes a long int for offset this may not be sufficient for 64-bit offsets.

Back to OMMemoryRawStorage

OMMemoryRawStorage::readAt

void OMMemoryRawStorage::readAt(OMUInt64 position, OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesRead) const

Attempt to read the number of bytes given by byteCount from offset position in this OMMemoryRawStorage into the buffer at address bytes. The actual number of bytes read is returned in bytesRead. Reading from positions greater than size causes bytesRead to be less than byteCount. Reading bytes that have never been written returns undefined data in bytes.

Defined in: OMMemoryRawStorage.cpp

Parameters

position: The position from which the bytes are to be read.
bytes: The buffer into which the bytes are to be read.
byteCount: The number of bytes to read.
bytesRead: The number of bytes actually read.

Back to OMMemoryRawStorage

OMMemoryRawStorage::setPosition

void OMMemoryRawStorage::setPosition(OMUInt64 newPosition) const

Set the current position for read() and write(), as an offset in bytes from the beginning of this OMMemoryRawStorage. precondition - isPositionable()

Defined in: OMMemoryRawStorage.cpp

Parameters

newPosition: The new position.

Developer Notes

fseek takes a long int for offset this may not be sufficient for 64-bit offsets.

Back to OMMemoryRawStorage

OMMemoryRawStorage::size

OMUInt64 OMMemoryRawStorage::size(void) const

The current size of this OMMemoryRawStorage in bytes. precondition - isPositionable()

Defined in: OMMemoryRawStorage.cpp

Return Value

The current size of this OMMemoryRawStorage in bytes.

Back to OMMemoryRawStorage

OMMemoryRawStorage::synchronize

void OMMemoryRawStorage::synchronize(void)

Synchronize this OMMemoryRawStorage with its external representation.

Defined in: OMMemoryRawStorage.cpp

Back to OMMemoryRawStorage

OMMemoryRawStorage::write

void OMMemoryRawStorage::write(const OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesWritten)

Attempt to write the number of bytes given by byteCount to the current position in this OMMemoryRawStorage from the buffer at address bytes. The actual number of bytes written is returned in bytesWritten. Writing to positions greater than size causes this OMMemoryRawStorage to be extended, however such extension can fail, causing bytesWritten to be less than byteCount.

Defined in: OMMemoryRawStorage.cpp

Parameters

bytes: The buffer from which the bytes are to be written.
byteCount: The number of bytes to write.
bytesWritten: The actual number of bytes written.

Back to OMMemoryRawStorage

OMMSSStoredObject class

OMMSSStoredObject class OMMSSStoredObject

In-memory representation of an object persisted in a Microsoft Structured Storage (MSS) binary file.

Defined in: OMMSSStoredObject.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Static members.

static OMMSSStoredObject* openRead(const wchar_t* fileName): Open the root OMMSSStoredObject in the disk file fileName for reading only.

Developer Notes

Soon to be obsolete.

static OMMSSStoredObject* openModify(const wchar_t* fileName): Open the root OMMSSStoredObject in the disk file fileName for modification.

Developer Notes

Soon to be obsolete.

static OMMSSStoredObject* createModify(const wchar_t* fileName, const OMByteOrder byteOrder): Create a new root OMMSSStoredObject in the disk file fileName. The byte order of the newly created root is given by byteOrder.

Developer Notes

Soon to be obsolete.

static OMMSSStoredObject* openRead(OMRawStorage* rawStorage): Open the root OMMSSStoredObject in the raw storage rawStorage for reading only.
static OMMSSStoredObject* openModify(OMRawStorage* rawStorage): Open the root OMMSSStoredObject in the raw storage rawStorage for modification.
static OMMSSStoredObject* createWrite(OMRawStorage* rawStorage, const OMByteOrder byteOrder): Create a new root OMMSSStoredObject in the raw storage rawStorage. The byte order of the newly created root is given by byteOrder.
static OMMSSStoredObject* createModify(OMRawStorage* rawStorage, const OMByteOrder byteOrder): Create a new root OMMSSStoredObject in the raw storage rawStorage. The byte order of the newly created root is given by byteOrder.
static bool isRecognized(const wchar_t* fileName, OMFileSignature& signature): Is the file named fileName a recognized file ? If so, the result is true, and the signature is returned in signature.
static bool isRecognized(OMRawStorage* rawStorage, OMFileSignature& signature): Does rawStorage contain a recognized file ? If so, the result is true, and the signature is returned in signature.
static bool isRecognized(const OMFileSignature& signature): Is signature recognized ?

Class Members

Public members.

virtual ~OMMSSStoredObject(void): Destructor.
virtual OMStoredObject* create(const wchar_t* name): Create a new OMMSSStoredObject, named name, contained by this OMMSSStoredObject.

Developer Notes

The name argument to this member function doesn't make sense for all derived instances of OMStoredObject.

virtual OMStoredObject* open(const wchar_t* name): Open an exsiting OMMSSStoredObject, named name, contained by this OMMSSStoredObject.

Developer Notes

The name argument to this member function doesn't make sense for all derived instances of OMStoredObject.

virtual void close(void): Close this OMMSSStoredObject.
virtual OMByteOrder byteOrder(void) const: The byte order of this OMMSSStoredObject.

Developer Notes

This member function doesn't make sense for all derived instances of OMStoredObject.

virtual void save(const OMStoredObjectIdentification& id): Save the OMStoredObjectIdentification id in this OMMSSStoredObject.
virtual void save(const OMPropertySet& properties): Save the OMPropertySet properties in this OMMSSStoredObject.
virtual void save(const OMSimpleProperty& property): Save the OMSimpleProperty property in this OMMSSStoredObject.
virtual void save(const OMStrongReference& singleton): Save the OMStrongReference singleton in this OMMSSStoredObject.
virtual void save(const OMStrongReferenceVector& vector): Save the OMStrongReferenceVector vector in this OMMSSStoredObject.
virtual void save(const OMStrongReferenceSet& set): Save the OMStrongReferenceSet set in this OMMSSStoredObject.
virtual void save(const OMWeakReference& singleton): Save the OMWeakReference singleton in this OMMSSStoredObject.
virtual void save(const OMWeakReferenceVector& vector): Save the OMWeakReferenceVector vector in this OMMSSStoredObject.
virtual void save(const OMWeakReferenceSet& set): Save the OMWeakReferenceSet set in this OMMSSStoredObject.
virtual void save(const OMPropertyTable* table): Save the OMPropertyTable table in this OMMSSStoredObject.

Developer Notes

Does this member function make sense for all derived instances of OMStoredObject ?

virtual void save(const OMDataStream& stream): Save the OMDataStream stream in this OMMSSStoredObject.
virtual void restore(OMStoredObjectIdentification& id): Restore the OMStoredObjectIdentification of this OMMSSStoredObject into id.
virtual void restore(OMPropertySet& properties): Restore the OMPropertySet properties into this OMMSSStoredObject.
virtual void restore(OMSimpleProperty& property, size_t externalSize): Restore the OMSimpleProperty property into this OMMSSStoredObject.

Developer Notes

The externalSize argument to this member function doesn't make sense for all derived instances of OMStoredObject.

virtual void restore(OMStrongReference& singleton, size_t externalSize): Restore the OMStrongReference singleton into this OMMSSStoredObject.
virtual void restore(OMStrongReferenceVector& vector, size_t externalSize): Restore the OMStrongReferenceVector vector into this OMMSSStoredObject.
virtual void restore(OMStrongReferenceSet& set, size_t externalSize): Restore the OMStrongReferenceSet set into this OMMSSStoredObject.
virtual void restore(OMWeakReference& singleton, size_t externalSize): Restore the OMWeakReference singleton into this OMMSSStoredObject.
virtual void restore(OMWeakReferenceVector& vector, size_t externalSize): Restore the OMWeakReferenceVector vector into this OMMSSStoredObject.
virtual void restore(OMWeakReferenceSet& set, size_t externalSize): Restore the OMWeakReferenceSet set into this OMMSSStoredObject.
virtual void restore(OMPropertyTable*& table): Restore the OMPropertyTable in this OMMSSStoredObject.

Developer Notes

Does this member function make sense for all derived instances of OMStoredObject ?

virtual void restore(OMDataStream& stream, size_t externalSize): Restore the OMDataStream stream into this OMMSSStoredObject.
virtual OMStoredStream* openStoredStream(const OMDataStream& property): Open the OMStoredStream representing the property stream contained within this OMMSSStoredObject.
virtual OMStoredStream* createStoredStream(const OMDataStream& property): Create an OMStoredStream representing the property stream contained within this OMMSSStoredObject.

Class Members

Protected members.

OMMSSStoredObject(IStorage* s): Constructor.
void validate(const OMPropertySet* propertySet, const OMStoredPropertySetIndex* propertySetIndex) const: Check that the OMPropertySet propertySet is consistent with the OMStoredPropertySetIndex propertySetIndex.
void save(const OMStoredVectorIndex* vector, const wchar_t* vectorName): Save the OMStoredVectorIndex vector in this OMMSSStoredObject, the vector is named vectorName.
void save(const OMStoredSetIndex* set, const wchar_t* setName): Save the OMStoredSetIndex set in this OMMSSStoredObject, the set is named setName.
void save(OMPropertyId propertyId, OMStoredForm storedForm, const OMUniqueObjectIdentification& id, OMPropertyTag tag, OMPropertyId keyPropertyId): Save a single weak reference.
void save(const wchar_t* collectionName, const OMUniqueObjectIdentification* index, size_t count, OMPropertyTag tag, OMPropertyId keyPropertyId): Save a collection (vector/set) of weak references.
void restore(OMStoredVectorIndex*& vector, const wchar_t* vectorName): Restore the vector named vectorName into this OMMSSStoredObject.
void restore(OMStoredSetIndex*& set, const wchar_t* setName): Restore the set named setName into this OMMSSStoredObject.
void restore(OMPropertyId propertyId, OMStoredForm storedForm, OMUniqueObjectIdentification& id, OMPropertyTag& tag, OMPropertyId& keyPropertyId): Restore a single weak reference.
void restore(const wchar_t* collectionName, OMUniqueObjectIdentification*& index, size_t &count, OMPropertyTag& tag, OMPropertyId& keyPropertyId): Restore a collection (vector/set) of weak references.
void write(OMPropertyId propertyId, OMStoredForm storedForm, void* start, size_t size): Write a property value to this OMMSSStoredObject. The property value to be written occupies size bytes at the address start. The property id is propertyId. The property type is type.
void read(OMPropertyId propertyId, OMStoredForm storedForm, void* start, size_t size): Read a property value from this OMMSSStoredObject. The property value is read into a buffer which occupies size bytes at the address start. The property id is propertyId. The property type is type.
IStream* openStream(const wchar_t* streamName): Open a stream called streamName contained within this OMMSSStoredObject.
IStream* createStream(const wchar_t* streamName): Create a stream called streamName contained within this OMMSSStoredObject.
void readFromStream(IStream* stream, void* data, size_t size): Read size bytes from stream into the buffer at address data.
void readFromStream(IStream* stream, OMByte* data, const OMUInt32 bytes, OMUInt32& bytesRead): Attempt to read bytes bytes from stream into the buffer at address data. The actual number of bytes read is returned in bytesRead.
void writeToStream(IStream* stream, void* data, size_t size): Write size bytes from the buffer at address data to stream.
void writeToStream(IStream* stream, const OMByte* data, const OMUInt32 bytes, OMUInt32& bytesWritten): Attempt to write bytes bytes from the buffer at address data to stream. The actual number of bytes written is returned in bytesWritten.
void readUInt8FromStream(IStream* stream, OMUInt8& i): Read an OMUInt8 from stream into i.
void writeUInt8ToStream(IStream* stream, OMUInt8& i): Write an OMUInt8 from i to stream.
void readUInt16FromStream(IStream* stream, OMUInt16& i, bool reorderBytes): Read an OMUInt16 from stream into i. If reorderBytes is true then the bytes are reordered.
void writeUInt16ToStream(IStream* stream, OMUInt16& i, bool reorderBytes): Write an OMUInt16 from i to stream. If reorderBytes is true then the bytes are reordered.
static void reorderUInt16(OMUInt16& i): Reorder the OMUInt16 i.
void readUInt32FromStream(IStream* stream, OMUInt32& i, bool reorderBytes): Read an OMUInt32 from stream into i. If reorderBytes is true then the bytes are reordered.
void writeUInt32ToStream(IStream* stream, OMUInt32& i, bool reorderBytes): Write an OMUInt32 from i to stream. If reorderBytes is true then the bytes are reordered.
static void reorderUInt32(OMUInt32& i): Reorder the OMUInt32 i.
void readUInt64FromStream(IStream* stream, OMUInt64& i, bool reorderBytes): Read an OMUInt64 from stream into i. If reorderBytes is true then the bytes are reordered.
void writeUInt64ToStream(IStream* stream, OMUInt64& i, bool reorderBytes): Write an OMUInt64 from i to stream. If reorderBytes is true then the bytes are reordered.
static void reorderUInt64(OMUInt64& i): Reorder the OMUInt64 i.
void readUniqueObjectIdentificationFromStream( IStream* stream, OMUniqueObjectIdentification& id, bool reorderBytes): Read a UniqueObjectIdentification from stream into id. If reorderBytes is true then the bytes are reordered.
void writeUniqueObjectIdentificationToStream( IStream* stream, OMUniqueObjectIdentification& id, bool reorderBytes): Write a UniqueObjectIdentification from id to stream. If reorderBytes is true then the bytes are reordered.
void readUniqueMaterialIdentificationFromStream( IStream* stream, OMUniqueMaterialIdentification& id, bool reorderBytes): Read a UniqueMaterialIdentification from stream into id. If reorderBytes is true then the bytes are reordered.
void writeUniqueMaterialIdentificationToStream( IStream* stream, OMUniqueMaterialIdentification& id, bool reorderBytes): Write a UniqueMaterialIdentification from id to stream. If reorderBytes is true then the bytes are reordered.
static void reorderUniqueObjectIdentification( OMUniqueObjectIdentification& id): Reorder the UniqueObjectIdentification id.
static void reorderUniqueMaterialIdentification( OMUniqueMaterialIdentification& id): Reorder the UniqueMaterialIdentification id.
OMUInt64 streamSize(IStream* stream) const: Size of stream in bytes.
void streamSetSize(IStream* stream, const OMUInt64 newSize): Set the size, in bytes, of stream
OMUInt64 streamPosition(IStream* stream) const: The current position for readFromStream() and writeToStream(), as an offset in bytes from the begining of the data stream.
void streamSetPosition(IStream* stream, const OMUInt64 offset): Set the current position for readFromStream() and writeToStream(), as an offset in bytes from the begining of the data stream.
void closeStream(IStream*& stream): Close stream.
void saveName(const OMProperty& property, const wchar_t* name): The persisted value of property is its name. Write the property name and enter it into the property index.
void restoreName(OMProperty& property, const wchar_t* name, size_t size): The persisted value of property is its name. Read (and check) the property name.

Class Members

Private members.

wchar_t* collectionIndexStreamName(const wchar_t* collectionName): The stream name for the index of a collection named collectionName.
static void writeSignature(OMRawStorage* rawStorage, const OMFileSignature& signature): Write the signature to the given raw storage.
static void writeSignature(const wchar_t* fileName, const OMFileSignature& signature): Write the signature to the given file.

Developer Notes

Soon to be obsolete.

OMMSSStoredObject::close

void OMMSSStoredObject::close(void)

Close this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Back to OMMSSStoredObject

OMMSSStoredObject::closeStream

void OMMSSStoredObject::closeStream(IStream*& stream)

Close stream.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The stream to close.

Back to OMMSSStoredObject

OMMSSStoredObject::collectionIndexStreamName

wchar_t* OMMSSStoredObject::collectionIndexStreamName(const wchar_t* collectionName)

The stream name for the index of a collection named collectionName.

Defined in: OMMSSStoredObject.cpp

Return Value

The stream name for the collection index.

Parameters

collectionName: The collection name.

Back to OMMSSStoredObject

OMMSSStoredObject::create

OMStoredObject* OMMSSStoredObject::create(const wchar_t* name)

Create a new OMMSSStoredObject, named name, contained by this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Return Value

A new OMMSSStoredObject contained by this OMMSSStoredObject.

Parameters

name: The name to be used for the new OMMSSStoredObject.

Back to OMMSSStoredObject

OMMSSStoredObject::createModify

OMMSSStoredObject* OMMSSStoredObject::createModify(const wchar_t* fileName, const OMByteOrder byteOrder)

Create a new root OMMSSStoredObject in the disk file fileName. The byte order of the newly created root is given by byteOrder.

Defined in: OMMSSStoredObject.cpp

Return Value

An OMMSSStoredObject representing the root object in the disk file.

Parameters

fileName: The name of the file to create. The file must not exist.
byteOrder: The desired byte ordering for the new file.

Back to OMMSSStoredObject

OMMSSStoredObject::createModify

OMMSSStoredObject* OMMSSStoredObject::createModify(OMRawStorage* rawStorage, const OMByteOrder byteOrder)

Create a new root OMMSSStoredObject in the raw storage rawStorage. The byte order of the newly created root is given by byteOrder.

Defined in: OMMSSStoredObject.cpp

Return Value

An OMMSSStoredObject representing the root object.

Parameters

rawStorage: The raw storage in which to create the file.
byteOrder: The desired byte ordering for the new file.

Back to OMMSSStoredObject

OMMSSStoredObject::createStoredStream

OMStoredStream* OMMSSStoredObject::createStoredStream(const OMDataStream& property)

Create an OMStoredStream representing the property stream contained within this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Return Value

TBS

Parameters

property: TBS

Back to OMMSSStoredObject

OMMSSStoredObject::createStream

IStream* OMMSSStoredObject::createStream(const wchar_t* streamName)

Create a stream called streamName contained within this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Return Value

An open stream.

Parameters

streamName: The name of the stream to create.

Back to OMMSSStoredObject

OMMSSStoredObject::createWrite

OMMSSStoredObject* OMMSSStoredObject::createWrite(OMRawStorage* rawStorage, const OMByteOrder byteOrder)

Create a new root OMMSSStoredObject in the raw storage rawStorage. The byte order of the newly created root is given by byteOrder.

Defined in: OMMSSStoredObject.cpp

Return Value

An OMMSSStoredObject representing the root object.

Parameters

rawStorage: The raw storage in which to create the file.
byteOrder: The desired byte ordering for the new file.

Back to OMMSSStoredObject

OMMSSStoredObject::isRecognized

bool OMMSSStoredObject::isRecognized(const wchar_t* fileName, OMFileSignature& signature)

Is the file named fileName a recognized file ? If so, the result is true, and the signature is returned in signature.

Defined in: OMMSSStoredObject.cpp

Return Value

True if the file is recognized, false otherwise.

Parameters

fileName: The name of the file to check.
signature: If recognized, the file signature.

Back to OMMSSStoredObject

OMMSSStoredObject::isRecognized

bool OMMSSStoredObject::isRecognized(OMRawStorage* rawStorage, OMFileSignature& signature)

Does rawStorage contain a recognized file ? If so, the result is true, and the signature is returned in signature.

Defined in: OMMSSStoredObject.cpp

Return Value

True if the OMRawStorage contains a recognized file, false otherwise.

Parameters

rawStorage: The OMRawStorage to check.
signature: If recognized, the file signature.

Back to OMMSSStoredObject

OMMSSStoredObject::isRecognized

bool OMMSSStoredObject::isRecognized(const OMFileSignature& signature)

Is signature recognized ? If so, the result is true.

Defined in: OMMSSStoredObject.cpp

Return Value

True if the signature is recognized, false otherwise.

Parameters

signature: The signature to check.

Back to OMMSSStoredObject

OMMSSStoredObject::OMMSSStoredObject

OMMSSStoredObject::OMMSSStoredObject(IStorage* s)

Constructor.

Defined in: OMMSSStoredObject.cpp

Parameters

s: The IStorage for the persistent representation of this OMMSSStoredObject.

Back to OMMSSStoredObject

OMMSSStoredObject::open

OMStoredObject* OMMSSStoredObject::open(const wchar_t* name)

Open an exsiting OMMSSStoredObject, named name, contained by this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Return Value

The existing OMMSSStoredObject contained by this OMMSSStoredObject.

Parameters

name: The name of the existing OMMSSStoredObject.

Back to OMMSSStoredObject

OMMSSStoredObject::openModify

OMMSSStoredObject* OMMSSStoredObject::openModify(const wchar_t* fileName)

Open the root OMMSSStoredObject in the disk file fileName for modification.

Defined in: OMMSSStoredObject.cpp

Return Value

An OMMSSStoredObject representing the root object in the disk file.

Parameters

fileName: The name of the file to open. The file must already exist.

Back to OMMSSStoredObject

OMMSSStoredObject::openModify

OMMSSStoredObject* OMMSSStoredObject::openModify(OMRawStorage* rawStorage)

Open the root OMMSSStoredObject in the raw storage rawStorage for modification.

Defined in: OMMSSStoredObject.cpp

Return Value

An OMMSSStoredObject representing the root object.

Parameters

rawStorage: The raw storage in which to open the file.

Back to OMMSSStoredObject

OMMSSStoredObject::openRead

OMMSSStoredObject* OMMSSStoredObject::openRead(OMRawStorage* rawStorage)

Open the root OMMSSStoredObject in the raw storage rawStorage for reading only.

Defined in: OMMSSStoredObject.cpp

Return Value

An OMMSSStoredObject representing the root object.

Parameters

rawStorage: The raw storage in which to open the file.

Back to OMMSSStoredObject

OMMSSStoredObject::openRead

OMMSSStoredObject* OMMSSStoredObject::openRead(const wchar_t* fileName)

Open the root OMMSSStoredObject in the disk file fileName for reading only.

Defined in: OMMSSStoredObject.cpp

Return Value

An OMMSSStoredObject representing the root object in the disk file.

Parameters

fileName: The name of the file to open. The file must already exist.

Back to OMMSSStoredObject

OMMSSStoredObject::openStoredStream

OMStoredStream* OMMSSStoredObject::openStoredStream(const OMDataStream& property)

Open the OMStoredStream representing the property property contained within this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Return Value

TBS

Parameters

property: TBS

Back to OMMSSStoredObject

OMMSSStoredObject::openStream

IStream* OMMSSStoredObject::openStream(const wchar_t* streamName)

Open a stream called streamName contained within this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Return Value

An open stream.

Parameters

streamName: The name of the stream to open.

Back to OMMSSStoredObject

OMMSSStoredObject::read

void OMMSSStoredObject::read(OMPropertyId propertyId, int type, void* start, size_t size)

Read a property value from this OMMSSStoredObject. The property value is read into a buffer which occupies size bytes at the address start. The property id is propertyId. The property type is type.

Defined in: OMMSSStoredObject.cpp

Parameters

propertyId: The property id.
type: The property type.
start: The start address of the buffer to hold the property value.
size: The size of the buffer in bytes.

Back to OMMSSStoredObject

OMMSSStoredObject::readFromStream

void OMMSSStoredObject::readFromStream(IStream* stream, void* data, size_t size)

Read size bytes from stream into the buffer at address data.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The stream from which to read.
data: The buffer into which the bytes are read.
size: The number of bytes to read.

Back to OMMSSStoredObject

OMMSSStoredObject::readFromStream

void OMMSSStoredObject::readFromStream(IStream* stream, OMByte* data, const OMUInt32 bytes, OMUInt32& bytesRead)

Attempt to read bytes bytes from stream into the buffer at address data. The actual number of bytes read is returned in bytesRead.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The stream from which to read.
data: The buffer into which the bytes are read.
bytes: The number of bytes to write
bytesRead: The actual number of bytes read.

Back to OMMSSStoredObject

OMMSSStoredObject::readUInt16FromStream

void OMMSSStoredObject::readUInt16FromStream(IStream* stream, OMUInt16& i, bool reorderBytes)

Read an OMUInt16 from stream into i. If reorderBytes is true then the bytes are reordered.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The stream from which to read.
i: The resulting OMUInt16.
reorderBytes: If true then reorder the bytes.

Back to OMMSSStoredObject

OMMSSStoredObject::readUInt32FromStream

void OMMSSStoredObject::readUInt32FromStream(IStream* stream, OMUInt32& i, bool reorderBytes)

Read an OMUInt32 from stream into i. If reorderBytes is true then the bytes are reordered.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The stream from which to read.
i: The resulting OMUInt32.
reorderBytes: If true then reorder the bytes.

Back to OMMSSStoredObject

OMMSSStoredObject::readUInt64FromStream

void OMMSSStoredObject::readUInt64FromStream(IStream* stream, OMUInt64& i, bool reorderBytes)

Read an OMUInt64 from stream into i. If reorderBytes is true then the bytes are reordered.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The stream from which to read.
i: The resulting OMUInt64.
reorderBytes: If true then reorder the bytes.

Back to OMMSSStoredObject

OMMSSStoredObject::readUInt8FromStream

void OMMSSStoredObject::readUInt8FromStream(IStream* stream, OMUInt8& i)

Read an OMUInt8 from stream into i.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The stream from which to read.
i: The resulting OMUInt8.

Back to OMMSSStoredObject

OMMSSStoredObject::readUniqueMaterialIdentificationFromStream

void OMMSSStoredObject::readUniqueMaterialIdentificationFromStream(IStream* stream, OMUniqueMaterialIdentification& id, bool reorderBytes)

Read a UniqueMaterialIdentification from stream into id. If reorderBytes is true then the bytes are reordered.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The stream from which to read.
id: The resulting OMUniqueMaterialIdentification.
reorderBytes: If true then reorder the bytes.

Back to OMMSSStoredObject

OMMSSStoredObject::readUniqueObjectIdentificationFromStream

void OMMSSStoredObject::readUniqueObjectIdentificationFromStream(IStream* stream, OMUniqueObjectIdentification& id, bool reorderBytes)

Read a UniqueObjectIdentification from stream into id. If reorderBytes is true then the bytes are reordered.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The stream from which to read.
id: The resulting OMUniqueObjectIdentification.
reorderBytes: If true then reorder the bytes.

Back to OMMSSStoredObject

OMMSSStoredObject::reorderUInt16

void OMMSSStoredObject::reorderUInt16(OMUInt16& i)

Reorder the OMUInt16 i.

Defined in: OMMSSStoredObject.cpp

Parameters

i: The OMUInt16 to reorder.

Back to OMMSSStoredObject

OMMSSStoredObject::reorderUInt32

void OMMSSStoredObject::reorderUInt32(OMUInt32& i)

Reorder the OMUInt32 i.

Defined in: OMMSSStoredObject.cpp

Parameters

i: The OMUInt32 to reorder.

Back to OMMSSStoredObject

OMMSSStoredObject::reorderUInt64

void OMMSSStoredObject::reorderUInt64(OMUInt64& i)

Reorder the OMUInt64 i.

Defined in: OMMSSStoredObject.cpp

Parameters

i: The OMUInt64 to reorder.

Back to OMMSSStoredObject

OMMSSStoredObject::reorderUniqueMaterialIdentification

void OMMSSStoredObject::reorderUniqueMaterialIdentification(OMUniqueMaterialIdentification& id)

Reorder the OMUniqueMaterialIdentification id.

Defined in: OMMSSStoredObject.cpp

Parameters

id: The OMUniqueMaterialIdentification to reorder.

Back to OMMSSStoredObject

OMMSSStoredObject::reorderUniqueObjectIdentification

void OMMSSStoredObject::reorderUniqueObjectIdentification(OMUniqueObjectIdentification& id)

Reorder the OMUniqueObjectIdentification id.

Defined in: OMMSSStoredObject.cpp

Parameters

id: The OMUniqueObjectIdentification to reorder.

Back to OMMSSStoredObject

OMMSSStoredObject::restore

void OMMSSStoredObject::restore(OMWeakReferenceSet& set, size_t externalSize)

Restore the OMWeakReferenceSet set into this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

set: TBS
externalSize: TBS

Back to OMMSSStoredObject

OMMSSStoredObject::restore

void OMMSSStoredObject::restore(const wchar_t* collectionName, OMUniqueObjectIdentification*& index, size_t & count, OMPropertyTag& tag, OMPropertyId& keyPropertyId)

Restore a collection (vector/set) of weak references.

Defined in: OMMSSStoredObject.cpp

Parameters

collectionName: The name of the collection.
index: The unique identifications of the targets.
count: Count of targets.
tag: A tag identifying the collection in which each of the targets reside.
keyPropertyId: The id of the property whose value is the unique identifier of objects in the target set.

Back to OMMSSStoredObject

OMMSSStoredObject::restore

void OMMSSStoredObject::restore(OMStrongReferenceSet& set, size_t externalSize)

Restore the OMStrongReferenceSet set into this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

set: TBS
externalSize: TBS

Back to OMMSSStoredObject

OMMSSStoredObject::restore

void OMMSSStoredObject::restore(OMDataStream& stream, size_t ANAME)

Restore the OMDataStream stream into this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: TBS
ANAME: TBS

Back to OMMSSStoredObject

OMMSSStoredObject::restore

void OMMSSStoredObject::restore(OMWeakReferenceVector& vector, size_t externalSize)

Restore the OMWeakReferenceVector vector into this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

vector: TBS
externalSize: TBS

Back to OMMSSStoredObject

OMMSSStoredObject::restore

void OMMSSStoredObject::restore(OMPropertyTable*& table)

Restore the OMPropertyTable in this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

table: A pointer to the newly restored OMPropertyTable by reference.

Back to OMMSSStoredObject

OMMSSStoredObject::restore

void OMMSSStoredObject::restore(OMStoredVectorIndex*& vector)

Restore the vector named vectorName into this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Return Value

The newly restored OMStoredVectorIndex.

Parameters

vector: The name of the vector.

Back to OMMSSStoredObject

OMMSSStoredObject::restore

void OMMSSStoredObject::restore(OMPropertySet& properties)

Restore the OMPropertySet properties into this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

properties: The OMPropertySet to restore.

Back to OMMSSStoredObject

OMMSSStoredObject::restore

void OMMSSStoredObject::restore(OMWeakReference& singleton, size_t ANAME)

Restore the OMWeakReference singleton into this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

singleton: TBS
ANAME: TBS

Back to OMMSSStoredObject

OMMSSStoredObject::restore

void OMMSSStoredObject::restore(OMSimpleProperty& property, size_t externalSize)

Restore the OMSimpleProperty property into this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

property: TBS
externalSize: TBS

Back to OMMSSStoredObject

OMMSSStoredObject::restore

void OMMSSStoredObject::restore(OMStrongReference& singleton, size_t externalSize)

Restore the OMStrongReference singleton into this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

singleton: TBS
externalSize: TBS

Back to OMMSSStoredObject

OMMSSStoredObject::restore

void OMMSSStoredObject::restore(OMStrongReferenceVector& vector, size_t externalSize)

Restore the OMStrongReferenceVector vector into this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

vector: TBS
externalSize: TBS

Back to OMMSSStoredObject

OMMSSStoredObject::restore

void OMMSSStoredObject::restore(OMPropertyId propertyId, OMStoredForm storedForm, OMUniqueObjectIdentification& id, OMPropertyTag& tag, OMPropertyId& keyPropertyId)

Restore a single weak reference.

Defined in: OMMSSStoredObject.cpp

Parameters

propertyId: The property id.
storedForm: The property type.
id: The unique identification of the target.
tag: A tag identifying the collection in which the target resides.
keyPropertyId: The id of the property whose value is the unique identifier of objects in the target set.

Back to OMMSSStoredObject

OMMSSStoredObject::restore

void OMMSSStoredObject::restore(OMStoredObjectIdentification& id)

Restore the OMStoredObjectIdentification of this OMMSSStoredObject into id.

Defined in: OMMSSStoredObject.cpp

Parameters

id: The OMStoredObjectIdentification of this OMMSSStoredObject.

Back to OMMSSStoredObject

OMMSSStoredObject::restore

void OMMSSStoredObject::restore(OMStoredSetIndex*& set)

Restore the set named setName into this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Return Value

The newly restored OMStoredSetIndex.

Parameters

set: The name of the set.

Back to OMMSSStoredObject

OMMSSStoredObject::restoreName

void OMMSSStoredObject::restoreName(OMProperty& property, const wchar_t* ANAME, name)

The persisted value of property is its name. Read (and check) the property name.

Defined in: OMMSSStoredObject.cpp

Parameters

property: The property.
ANAME: The expected property name.
name: The (expected) size of the property name.

Back to OMMSSStoredObject

OMMSSStoredObject::save

void OMMSSStoredObject::save(const OMStrongReference& singleton)

Save the OMStrongReference singleton in this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

singleton: TBS

Back to OMMSSStoredObject

OMMSSStoredObject::save

void OMMSSStoredObject::save(const OMStoredVectorIndex* vector, const wchar_t* vectorName)

Save the OMStoredVectorIndex vector in this OMMSSStoredObject, the vector is named vectorName.

Defined in: OMMSSStoredObject.cpp

Parameters

vector: The OMStoredVectorIndex to save.
vectorName: The name of the vector.

Back to OMMSSStoredObject

OMMSSStoredObject::save

void OMMSSStoredObject::save(const wchar_t* collectionName, const OMUniqueObjectIdentification* index, size_t count, OMPropertyTag tag, OMPropertyId keyPropertyId)

Save a collection (vector/set) of weak references.

Defined in: OMMSSStoredObject.cpp

Parameters

collectionName: The name of the collection.
index: The unique identifications of the targets.
count: Count of targets.
tag: A tag identifying the collection in which each of the targets reside.
keyPropertyId: The id of the property whose value is the unique identifier of objects in the target set.

Back to OMMSSStoredObject

OMMSSStoredObject::save

void OMMSSStoredObject::save(const OMWeakReferenceVector& vector)

Save the OMWeakReferenceVector vector in this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

vector: TBS

Back to OMMSSStoredObject

OMMSSStoredObject::save

void OMMSSStoredObject::save(const OMStrongReferenceSet& set)

Save the OMStrongReferenceSet set in this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

set: The set of strong references to save.

Back to OMMSSStoredObject

OMMSSStoredObject::save

void OMMSSStoredObject::save(const OMWeakReferenceSet& set)

Save the OMWeakReferenceSet set in this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

set: TBS

Back to OMMSSStoredObject

OMMSSStoredObject::save

void OMMSSStoredObject::save(OMPropertyId propertyId, OMStoredForm storedForm, const OMUniqueObjectIdentification& id, OMPropertyTag tag, OMPropertyId keyPropertyId)

Save a single weak reference.

Defined in: OMMSSStoredObject.cpp

Parameters

propertyId: The property id.
storedForm: The property type.
id: The unique identification of the target.
tag: A tag identifying the collection in which the target resides.
keyPropertyId: The id of the property whose value is the unique identifier of objects in the target set.

Back to OMMSSStoredObject

OMMSSStoredObject::save

void OMMSSStoredObject::save(const OMWeakReference& singleton)

Save the OMWeakReference singleton in this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

singleton: TBS

Back to OMMSSStoredObject

OMMSSStoredObject::save

void OMMSSStoredObject::save(const OMStrongReferenceVector& vector)

Save the OMStrongReferenceVector vector in this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

vector: The vector of strong references to save.

Back to OMMSSStoredObject

OMMSSStoredObject::save

void OMMSSStoredObject::save(const OMPropertyTable* table)

Save the OMPropertyTable table in this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

table: The table to save.

Back to OMMSSStoredObject

OMMSSStoredObject::save

void OMMSSStoredObject::save(const OMPropertySet& properties)

Save the OMPropertySet properties in this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

properties: The OMPropertySet to save.

Back to OMMSSStoredObject

OMMSSStoredObject::save

void OMMSSStoredObject::save(const OMStoredObjectIdentification& id)

Save the OMStoredObjectIdentification id in this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

id: The OMStoredObjectIdentification of this OMMSSStoredObject.

Back to OMMSSStoredObject

OMMSSStoredObject::save

void OMMSSStoredObject::save(const OMStoredSetIndex* set, const wchar_t* setName)

Save the OMStoredSetIndex set in this OMMSSStoredObject, the set is named setName.

Defined in: OMMSSStoredObject.cpp

Parameters

set: The OMStoredSetIndex to save.
setName: The name of the set.

Back to OMMSSStoredObject

OMMSSStoredObject::save

void OMMSSStoredObject::save(const OMDataStream& stream)

Save the OMDataStream stream in this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The OMDataStream to save.

Back to OMMSSStoredObject

OMMSSStoredObject::save

void OMMSSStoredObject::save(const OMSimpleProperty& property)

Save the OMSimpleProperty property in this OMMSSStoredObject.

Defined in: OMMSSStoredObject.cpp

Parameters

property: TBS

Back to OMMSSStoredObject

OMMSSStoredObject::saveName

void OMMSSStoredObject::saveName(const OMProperty& property, const wchar_t* name) const

The persisted value of property is its name. Write the property name and enter it into the property index.

Defined in: OMMSSStoredObject.cpp

Parameters

property: The property.
name: TBS

Parameters

stream: An open stream.

Back to OMMSSStoredObject

OMMSSStoredObject::validate

void OMMSSStoredObject::validate(const OMPropertySet* propertySet, const OMStoredPropertySetIndex* propertySetIndex)

Check that the OMPropertySet propertySet is consistent with the OMStoredPropertySetIndex propertySetIndex.

Defined in: OMMSSStoredObject.cpp

Parameters

propertySet: The OMPropertySet to validate.
propertySetIndex: The OMStoredPropertySetIndex to validate.

Back to OMMSSStoredObject

OMMSSStoredObject::write

void OMMSSStoredObject::write(OMPropertyId propertyId, OMStoredForm storedForm, void* start, size_t size)

Write a property value to this OMMSSStoredObject. The property value to be written occupies size bytes at the address start. The property id is propertyId. The property type is type.

Defined in: OMMSSStoredObject.cpp

Parameters

propertyId: The property id.
storedForm: The property type.
start: The start address of the property value.
size: The size of the property value in bytes.

Back to OMMSSStoredObject

OMMSSStoredObject::writeSignature

void OMMSSStoredObject::writeSignature(const wchar_t* fileName, const OMFileSignature& signature)

Write the signature to the given file.

Defined in: OMMSSStoredObject.cpp

Parameters

fileName: The file name.
signature: The signature.

Back to OMMSSStoredObject

OMMSSStoredObject::writeSignature

void OMMSSStoredObject::writeSignature(OMRawStorage* rawStorage, const OMFileSignature& signature)

Write the signature to the given raw storage.

Defined in: OMMSSStoredObject.cpp

Parameters

rawStorage: The raw storage.
signature: The signature.

Back to OMMSSStoredObject

OMMSSStoredObject::writeToStream

void OMMSSStoredObject::writeToStream(IStream* stream, void* data, size_t size)

Write size bytes from the buffer at address data to stream.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The stream on which to write.
data: The buffer to write.
size: The number of bytes to write.

Back to OMMSSStoredObject

OMMSSStoredObject::writeToStream

void OMMSSStoredObject::writeToStream(IStream* stream, const OMByte* data, const OMUInt32 bytes, OMUInt32& bytesWritten)

Attempt to write bytes bytes from the buffer at address data to stream. The actual number of bytes written is returned in bytesWritten.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The stream on which to write.
data: The buffer to write.
bytes: The number of bytes to write
bytesWritten: The actual number of bytes written.

Back to OMMSSStoredObject

OMMSSStoredObject::writeUInt16ToStream

void OMMSSStoredObject::writeUInt16ToStream(IStream* stream, OMUInt16& i, bool reorderBytes)

Write an OMUInt16 from i to stream. If reorderBytes is true then the bytes are reordered.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The stream to write to.
i: The OMUInt16 to write.
reorderBytes: If true then reorder the bytes.

Back to OMMSSStoredObject

OMMSSStoredObject::writeUInt32ToStream

void OMMSSStoredObject::writeUInt32ToStream(IStream* stream, OMUInt32& i, bool reorderBytes)

Write an OMUInt32 from i to stream. If reorderBytes is true then the bytes are reordered.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The stream to write to.
i: The OMUInt32 to write.
reorderBytes: If true then reorder the bytes.

Back to OMMSSStoredObject

OMMSSStoredObject::writeUInt64ToStream

void OMMSSStoredObject::writeUInt64ToStream(IStream* stream, OMUInt64& i, bool reorderBytes)

Write an OMUInt64 from i to stream. If reorderBytes is true then the bytes are reordered.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The stream to write to.
i: The OMUInt64 to write.
reorderBytes: If true then reorder the bytes.

Back to OMMSSStoredObject

OMMSSStoredObject::writeUInt8ToStream

void OMMSSStoredObject::writeUInt8ToStream(IStream* stream, OMUInt8& i)

Write an OMUInt8 from i to stream.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The stream to write to.
i: The OMUInt8 to write.

Back to OMMSSStoredObject

OMMSSStoredObject::writeUniqueMaterialIdentificationToStream

void OMMSSStoredObject::writeUniqueMaterialIdentificationToStream(IStream* stream, OMUniqueMaterialIdentification& id, bool reorderBytes)

Write a UniqueMaterialIdentification from id to stream. If reorderBytes is true then the bytes are reordered.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The stream to write to.
id: The OMUniqueMaterialIdentification to write.
reorderBytes: If true then reorder the bytes.

Back to OMMSSStoredObject

OMMSSStoredObject::writeUniqueObjectIdentificationToStream

void OMMSSStoredObject::writeUniqueObjectIdentificationToStream(IStream* stream, OMUniqueObjectIdentification& id, bool reorderBytes)

Write a UniqueObjectIdentification from id to stream. If reorderBytes is true then the bytes are reordered.

Defined in: OMMSSStoredObject.cpp

Parameters

stream: The stream to write to.
id: The OMUniqueObjectIdentification to write.
reorderBytes: If true then reorder the bytes.

Back to OMMSSStoredObject

OMMSSStoredObject::~OMMSSStoredObject

OMMSSStoredObject::~OMMSSStoredObject(void)

Destructor.

Defined in: OMMSSStoredObject.cpp

Back to OMMSSStoredObject

OMMSSStoredStream class

OMMSSStoredStream class OMMSSStoredStream: public OMStoredStream

Implementation of OMStoredStream for Microsoft Structured Storage.

Defined in: OMMSSStoredStream.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMMSSStoredStream(IStream* stream): Constructor.
~OMMSSStoredStream(void): Destructor.
virtual void read(void* data, size_t size) const: Read size bytes from this OMStoredStream into the buffer at address data.
virtual void read(OMByte* data, const OMUInt32 bytes, OMUInt32& bytesRead) const: Attempt to read bytes bytes from this OMStoredStream into the buffer at address data. The actual number of bytes read is returned in bytesRead.
virtual void write(void* data, size_t size): Write size bytes from the buffer at address data to this OMStoredStream.
virtual void write(const OMByte* data, const OMUInt32 bytes, OMUInt32& bytesWritten): Attempt to write bytes bytes from the buffer at address data to this OMStoredStream. The actual number of bytes written is returned in bytesWritten.
virtual OMUInt64 size(void) const: The size of this OMStoredStream in bytes.
virtual void setSize(const OMUInt64 newSize): Set the size of this OMStoredStream to bytes.
virtual OMUInt64 position(void) const: The current position for read() and write(), as an offset in bytes from the begining of this OMStoredStream.
virtual void setPosition(const OMUInt64 offset): Set the current position for read() and write(), as an offset in bytes from the begining of this OMStoredStream.
virtual void close(void): Close this OMStoredStream.

Class Members

Private members.

OMObject class

OMObject class OMObject

Abstract base class for all objects known to the Object Manager.

Defined in: OMObject.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

virtual ~OMObject(void): Destructor.

OMObjectDirectory class

OMObjectDirectory class OMObjectDirectory

Debug only data structure for tracking objects by name.

Defined in: OMObjectDirectory.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

OMObjectReference class

OMObjectReference class OMObjectReference

Persistent references to persistent objects.

Defined in: OMObjectReference.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMObjectReference(void): Constructor.
OMObjectReference(OMProperty* property): Constructor.
OMObjectReference(const OMObjectReference&): Copy constructor.
virtual ~OMObjectReference(void): Destructor.
virtual bool isVoid(void) const: Is this OMObjectReference void ?
OMObjectReference& operator=(const OMObjectReference& rhs): Assignment. This operator provides value semantics for OMContainer. This operator does not provide assignment of object references.
bool operator==(const OMObjectReference& rhs) const: Equality. This operator provides value semantics for OMContainer. This operator does not provide equality of object references.
virtual void save(void) const: Save this OMObjectReference.
virtual void close(void): Close this OMObjectReference.
virtual void detach(void): Detach this OMObjectReference.
virtual void restore(void): Restore this OMObjectReference.
virtual OMStorable* getValue(void) const: Get the value of this OMObjectReference. The value is a pointer to the referenced OMStorable.
virtual OMStorable* pointer(void) const: The value of this OMObjectReference as a pointer. This function provides low-level access. If the object exits but has not yet been loaded then the value returned is 0.

Class Members

Protected members.

OMProperty* _property: The containing property.
OMStorable* _pointer: A pointer to the actual object.

OMObjectReference::isVoid

bool OMObjectReference::isVoid(void) const

Is this OMObjectReference void ?

Defined in: OMObjectReference.cpp

Return Value

True if this OMObjectReference is void, false otherwise.

Back to OMObjectReference

OMObjectReference::OMObjectReference

OMObjectReference::OMObjectReference(void)

Constructor.

The OMObjectReference resulting from the assignment.

Parameters

rhs: The OMObjectReference to be assigned.

Back to OMObjectReference

OMObjectReference::operator==

bool OMObjectReference::operator==(const OMObjectReference& rhs) const

Equality. This operator provides value semantics for OMContainer. This operator does not provide equality of object references.

Defined in: OMObjectReference.cpp

Return Value

True if the values are the same, false otherwise.

Parameters

rhs: The OMObjectReference to be compared.

Back to OMObjectReference

OMObjectReference::pointer

OMStorable* OMObjectReference::pointer(void) const

The value of this OMObjectReference as a pointer. This function provides low-level access. If the object exits but has not yet been loaded then the value returned is 0.

Defined in: OMObjectReference.cpp

Return Value

A pointer to the referenced object, if any, otherwise 0.

Back to OMObjectReference

OMObjectReference::~OMObjectReference

OMObjectReference::~OMObjectReference(void)

Destructor.

Public members.

OMOStream& operator<<(const char* string): Insert a character string.
OMOStream& operator<<(OMUInt32 i): Insert an OMUInt32 in decimal.
OMOStream& operator<<(void* p): Insert a pointer in hex.
OMOStream& endLine(void): Insert a new line.
OMOStream& operator<<(OMOStream& (*manipulator)(OMOStream&)): Insert (call) a manipulator.

Class Members

Protected members.

OMOStream& put(const char* string): Put a character string.
OMOStream& put(OMUInt32 i): Put an OMUInt32 in decimal.
OMOStream& put(void* p): Put a pointer in hex.
OMOStream& putLine(void): Put a new line.

OMOStream::endLine

OMOStream& OMOStream::endLine(void)

Put a new line.

The modified OMOStream

Back to OMOStream

OMProperty class

OMProperty class OMProperty

Abstract base class for persistent properties supported by the Object Manager.

Defined in: OMProperty.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMProperty(const OMPropertyId propertyId, const OMStoredForm storedForm, const wchar_t* name): Constructor.
void initialize(const OMPropertyDefinition* definition): Temporary pseudo-constructor for clients which provide a property definition.
virtual ~OMProperty(void): Destructor.
virtual void save(void) const: Save this OMProperty.
virtual void close(void): Close this OMProperty.
virtual void detach(void): Detach this OMProperty.
virtual void restore(size_t externalSize): Restore this OMProperty, the external (persisted) size of the OMProperty is externalSize.
const OMPropertyDefinition* definition(void) const: The OMPropertyDefinition defining this OMProperty.
const wchar_t* name(void) const: The name of this OMProperty.
OMPropertyId propertyId(void) const: The property id of this OMProperty.
const OMPropertySet* propertySet(void) const: The OMPropertySet containing this OMProperty.
void setPropertySet(const OMPropertySet* propertySet): Inform this OMProperty that it is a member of the OMPropertySet propertySet.
OMProperty* address(void): The address of this OMProperty object.
virtual bool isVoid(void) const: Is this OMProperty void ?
bool isOptional(void) const: Is this an optional property ?
bool isPresent(void) const: Is this optional property present ?
virtual void removeProperty(void): Remove this optional OMProperty.
virtual size_t bitsSize(void) const: The size of the raw bits of this OMProperty. The size is given in bytes.
virtual void getBits(OMByte* bits, size_t size) const: Get the raw bits of this OMProperty. The raw bits are copied to the buffer at address bits which is size bytes in size.
virtual void setBits(const OMByte* bits, size_t size): Set the raw bits of this OMProperty. The raw bits are copied from the buffer at address bits which is size bytes in size.
virtual OMStorable* storable(void) const: The value of this OMProperty as an OMStorable. If this OMProperty does not represent an OMStorable then the value returned is 0.
OMStoredForm storedForm(void) const: The stored form of this OMProperty.
const OMType* type(void) const: The type of this OMProperty.

Class Members

Protected members.

void setPresent(void): Set the bit that indicates that this optional OMProperty is present.
void clearPresent(void): Clear the bit that indicates that this optional OMProperty is present.
OMStorable* container(void) const: The OMStorable that contains this OMProperty.
OMStoredObject* store(void) const: The OMStoredObject that contains the persisted representation of this OMProperty.
OMFile* file(void) const: The OMFile that contains the persisted representation of this OMProperty.

OMProperty::address

OMProperty* OMProperty::address(void)

The address of this OMProperty object. This function is defined so that descendants may override "operator &" to obtain the address of the contained property value. This function can then be used to obtain the address of this OMProperty.

OMStorable* OMProperty::container(void) const

The OMStorable that contains this OMProperty.

Defined in: OMProperty.cpp

Return Value

The containing OMStorable.

Back to OMProperty

OMProperty::definition

const OMPropertyDefinition* OMProperty::definition(void) const

The OMPropertyDefinition defining this OMProperty.

Defined in: OMProperty.cpp

Return Value

The defining OMPropertyDefinition.

Back to OMProperty

OMProperty::detach

void OMProperty::detach(void)

Detach this OMProperty.

OMProperty::setPresent

void OMProperty::setPresent(void)

Set the bit that indicates that this optional OMProperty is present.

OMPropertyDefinition class

OMPropertyDefinition class OMPropertyDefinition

Abstract base class used to define persistent properties supported by the Object Manager.

Defined in: OMPropertyDefinition.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

virtual ~OMPropertyDefinition(void): Destructor.
virtual const OMType* type(void) const: The type of the OMProperty defined by this OMPropertyDefinition.
virtual const wchar_t* name(void) const: The name of the OMProperty defined by this OMPropertyDefinition.
virtual OMPropertyId localIdentification(void) const: The locally unique identification of the OMProperty defined by this OMPropertyDefinition.
virtual bool isOptional(void) const: Is the OMProperty defined by this OMPropertyDefinition optional?

OMPropertySet class

OMPropertySet class OMPropertySet

Container class for OMProperty objects.

Defined in: OMPropertySet.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMPropertySet(void): Constructor.
~OMPropertySet(void): Destructor.
OMProperty* get(const OMPropertyId propertyId) const: Get the OMProperty associated with the property id propertyId.
OMProperty* get(const wchar_t* propertyName) const: Get the OMProperty named propertyName.
void put(OMProperty* property): Insert the OMProperty property into this OMPropertySet.
bool isPresent(const OMPropertyId propertyId) const: Is an OMProperty with property id propertyId present in this OMPropertySet ?
bool isPresent(const wchar_t* propertyName) const: Is an OMProperty with name propertyName present in this OMPropertySet ?
bool isAllowed(const OMPropertyId propertyId) const: Is an OMProperty with property id propertyId allowed in this OMPropertySet ?
bool isRequired(const OMPropertyId propertyId) const: Is an OMProperty with property id propertyId a required member of this OMPropertySet ?
size_t count(void) const: The number of OMProperty objects in this OMPropertySet.
void setContainer(const OMStorable* container): This OMPropertySet is contained by the given OMStorable object container. The OMProperty objects in this OMPropertySet are the properties of the given OMStorable object container.
OMStorable* container(void) const: The OMStorable object that contains this OMPropertySet.

OMPropertySet::container

OMStorable* OMPropertySet::container(void) const

The OMStorable object that contains this OMPropertySet.

Defined in: OMPropertySet.cpp

Return Value

The OMStorable object that contains this OMPropertySet.

Back to OMPropertySet

OMPropertySet::count

size_t OMPropertySet::count(void) const

The number of OMProperty objects in this OMPropertySet.

property: OMProperty to insert.

Back to OMPropertySet

OMPropertySet::setContainer

void OMPropertySet::setContainer(const OMStorable* container)

This OMPropertySet is contained by the given OMStorable object container. The OMProperty objects in this OMPropertySet are the properties of the given OMStorable object container.

Defined in: OMPropertySet.cpp

Parameters

container: The OMStorable object that contains this OMPropertySet.

Back to OMPropertySet

OMPropertySetIterator class

OMPropertySetIterator class OMPropertySetIterator

Iterators over OMPropertySets.

Defined in: OMPropertySetIterator.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMPropertySetIterator(const OMPropertySet& set, OMIteratorPosition initialPosition): Create an OMPropertySetIterator over the given OMPropertySet set and initialize it to the given initialPosition. If initialPosition is specified as OMBefore then this OMPropertySetIterator is made ready to traverse the associated OMPropertySet in the forward direction (increasing OMPropertyIds). If initialPosition is specified as OMAfter then this OMPropertySetIterator is made ready to traverse the associated OMPropertySet in the reverse direction (decreasing OMPropertyIds).
virtual ~OMPropertySetIterator(void): Destroy this OMPropertySetIterator.
virtual void reset(OMIteratorPosition initialPosition): Reset this OMPropertySetIterator to the given initialPosition. If initialPosition is specified as OMBefore then this OMPropertySetIterator is made ready to traverse the associated OMPropertySet in the forward direction (increasing OMPropertyIds). If initialPosition is specified as OMAfter then this OMPropertySetIterator is made ready to traverse the associated OMPropertySet in the reverse direction (decreasing OMPropertyIds).
virtual bool before(void) const: Is this OMPropertySetIterator positioned before the first OMProperty ?
virtual bool after(void) const: Is this OMPropertySetIterator positioned after the last OMProperty ?
virtual bool valid(void) const: Is this OMPropertySetIterator validly positioned on an OMProperty ?
virtual size_t count(void) const: The number of OMPropertys in the associated OMPropertySet.
virtual bool operator++(): Advance this OMPropertySetIterator to the next OMProperty, if any. If the end of the associated OMPropertySet is not reached then the result is true , valid becomes true and after becomes false . If the end of the associated OMPropertySet is reached then the result is false , valid becomes false and after becomes true .
virtual bool operator--(): Retreat this OMPropertySetIterator to the previous OMProperty, if any. If the beginning of the associated OMPropertySet is not reached then the result is true , valid becomes true and before becomes false . If the beginning of the associated OMPropertySet is reached then the result is false , valid becomes false and before becomes true .
virtual OMProperty* property(void) const: Return the OMProperty in the associated OMPropertySet at the position currently designated by this OMPropertySetIterator.
OMPropertyId propertyId(void) const: Return the OMPropertyId of the OMProperty in the associated OMPropertySet at the position currently designated by this OMPropertySetIterator.

OMPropertySetIterator::~OMPropertySetIterator

OMPropertySetIterator::~OMPropertySetIterator(void)

Destroy this OMPropertySetIterator.

Defined in: OMPropertySetIterator.cpp

Back to OMPropertySetIterator

OMPropertyTable class

OMPropertyTable class OMPropertyTable

Persistent tables of property instance names.

Defined in: OMPropertyTable.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMPropertyTable(void): Constructor.
~OMPropertyTable(void): Destructor.
OMPropertyTag insert(const OMPropertyId* propertyPath): If propertyPath is not already present then insert it (by copying) into the table and return its tag, otherwise just return its tag. Tags are allocated sequentially.
const OMPropertyId* valueAt(OMPropertyTag tag) const: The property path corresponding to tag in the table.
size_t count(void) const: The count of entries in the table.
bool isValid(OMPropertyTag tag) const: Is tag valid ?

OMPropertyTable::count

size_t OMPropertyTable::count(void) const

The count of entries in the table.

Defined in: OMPropertyTable.cpp

Return Value

The count of entries.

Back to OMPropertyTable

OMPropertyTable::insert

OMPropertyTag OMPropertyTable::insert(const OMPropertyId* propertyPath)

If propertyPath is not already present then insert it (by copying) into the table and return its tag, otherwise just return its tag. Tags are allocated sequentially.

Defined in: OMPropertyTable.cpp

Return Value

The assigned index.

Parameters

propertyPath: The property path to insert.

Back to OMPropertyTable

OMPropertyTable::isValid

bool OMPropertyTable::isValid(OMPropertyTag tag) const

Is tag valid ?

Defined in: OMPropertyTable.cpp

Return Value

True if the tag is valid, false otherwise.

Parameters

tag: The tag to check.

Back to OMPropertyTable

OMPropertyTable::OMPropertyTable

OMPropertyTable::OMPropertyTable(void)

Constructor.

Defined in: OMPropertyTable.cpp

Back to OMPropertyTable

OMPropertyTable::valueAt

const OMPropertyId* OMPropertyTable::valueAt(OMPropertyTag tag) const

The property path corresponding to tag in the table.

Defined in: OMPropertyTable.cpp

Return Value

The property path.

Parameters

tag: The index.

Back to OMPropertyTable

OMPropertyTable::~OMPropertyTable

OMPropertyTable::~OMPropertyTable(void)

Destructor.

Defined in: OMPropertyTable.cpp

Back to OMPropertyTable

OMRawStorage class

OMRawStorage class OMRawStorage

Abstract base class supporting access to the raw bytes of files supported by the Object Manager.

Object Manager clients use this interface, after a file has been saved and closed, to access the raw bytes of a file, or, before a file has been opened, to supply the raw bytes to be used for that file.

Object Manager clients implement this interface to allow files to be stored in locations not known to the Object Manager.

For example, Object Manager clients may wish to store files in a proprietary file system, this could be done by providing an implementation of this interface for that file system.

Additionally a number of built-in implementations of this interface are provided -

OMDiskRawStorage - an implementation of OMRawStorage for disk files. Uses ANSI file functions only.

OMMemoryRawStorage - an implementation of OMRawStorage that stores the file in memory.

OMMappedFileRawStorage - an implementation of OMRawStorage for files mapped into memory.

Defined in: OMRawStorage.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

virtual ~OMRawStorage(void)

Destructor.

virtual bool isReadable(void) const

Is it possible to read from this OMRawStorage ?

virtual void read(OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesRead) const

Attempt to read the number of bytes given by byteCount from the current position in this OMRawStorage into the buffer at address bytes. The actual number of bytes read is returned in bytesRead. Reading from positions greater than size causes bytesRead to be less than byteCount. Reading bytes that have never been written returns undefined data in bytes.

preconditions

isReadable()

virtual void readAt(OMUInt64 position, OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesRead) const

Attempt to read the number of bytes given by byteCount from offset position in this OMRawStorage into the buffer at address bytes. The actual number of bytes read is returned in bytesRead. Reading from positions greater than size causes bytesRead to be less than byteCount. Reading bytes that have never been written returns undefined data in bytes.

preconditions

isReadable() && isPositionable()

virtual bool isWritable(void) const

Is it possible to write to this OMRawStorage ?

virtual void write(const OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesWritten)

Attempt to write the number of bytes given by byteCount to the current position in this OMRawStorage from the buffer at address bytes. The actual number of bytes written is returned in bytesWritten. Writing to positions greater than size causes this OMRawStorage to be extended, however such extension can fail, causing bytesWritten to be less than byteCount.

preconditions

isWritable()

Developer Notes

How is failure to extend indicated ?

virtual void writeAt(OMUInt64 position, const OMByte* bytes, OMUInt32 byteCount, OMUInt32& bytesWritten)

Attempt to write the number of bytes given by byteCount to offset position in this OMRawStorage from the buffer at address bytes. The actual number of bytes written is returned in bytesWritten. Writing to positions greater than size causes this OMRawStorage to be extended, however such extension can fail, causing bytesWritten to be less than byteCount.

preconditions

isWritable() && isPositionable()

Developer Notes

How is failure to extend indicated ?

virtual bool isExtendible(void) const

May this OMRawStorage be changed in size ? An implementation of OMRawStorage for disk files would most probably return true. An implemetation for network streams would return false. An implementation for fixed size contiguous memory files (avoiding copying) would return false.

virtual OMUInt64 extent(void) const

The current extent of this OMRawStorage in bytes. The extent() is the allocated size, while the size() is the valid size.

preconditions

isPositionable()

virtual void extend(OMUInt64 newSize)

Set the size of this OMRawStorage to newSize bytes. If newSize is greater than size then this OMRawStorage is extended. If newSize is less than size then this OMRawStorage is truncated. Truncation may also result in the current position for read() and write() being set to size.

preconditions

isExtendible()

Developer Notes

How is failure to extend indicated ?

virtual OMUInt64 size(void) const

The current size of this OMRawStorage in bytes. The size() is the valid size, while the extent() is the allocated size.

preconditions

isPositionable()

virtual bool isPositionable(void) const

May the current position, for read() and write(), of this OMRawStorage be changed ? An implementation of OMRawStorage for disk files would most probably return true. An implemetation for network streams would return false. An implementation for memory files would return true.

virtual void synchronize(void)

Synchronize this OMRawStorage with its external representation. An implementation of OMRawStorage for disk files would most probably implement this virtual function as a flush. This virtual function would probably be implemented as a noop in implemetations for network streams and for memory files.

OMRawStorageLockBytes class

OMRawStorageLockBytes class OMRawStorageLockBytes: public ILockBytes

An implementation of the Microsoft Structured Storage interface ILockBytes in terms of OMRawStorage. This class is an adapter from the ILockBytes interface to the exported OMRawStorage interface. Object Manager clients may use the OMRawStorage interface to access or to control the storage of the raw bytes of a file.

Defined in: OMRawStorageLockBytes.h

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMRawStorageLockBytes(OMRawStorage* rawStorage): Constructor.
virtual ~OMRawStorageLockBytes(void): Destructor.
virtual HRESULT STDMETHODCALLTYPE ReadAt(ULARGE_INTEGER ulOffset, void *pv, ULONG cb, ULONG *pcbRead): Read bytes (see Microsoft documentation for details).
virtual HRESULT STDMETHODCALLTYPE WriteAt(ULARGE_INTEGER ulOffset, const void *pv, ULONG cb, ULONG *pcbWritten): Write bytes (see Microsoft documentation for details).
virtual HRESULT STDMETHODCALLTYPE Flush(void): Flush any buffered bytes (see Microsoft documentation for details).
virtual HRESULT STDMETHODCALLTYPE SetSize(ULARGE_INTEGER cb): Set the size, either grow or shrink (see Microsoft documentation for details).
virtual HRESULT STDMETHODCALLTYPE LockRegion(ULARGE_INTEGER libOffset, ULARGE_INTEGER cb, DWORD dwLockType): See Microsoft documentation for details.
virtual HRESULT STDMETHODCALLTYPE UnlockRegion(ULARGE_INTEGER libOffset, ULARGE_INTEGER cb, DWORD dwLockType): See Microsoft documentation for details.
virtual HRESULT STDMETHODCALLTYPE Stat(STATSTG *pstatstg, DWORD grfStatFlag): See Microsoft documentation for details.

Defined in: OMRedBlackTree.h

Class Template Arguments

Key: The type of the unique key used to identify elements. This type must support operator =, operator != and operator <.
Value: The type of the value carried in an OMRedBlackTree item. This type must support operator =.

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMRedBlackTree(void): Constructor.
virtual ~OMRedBlackTree(void): Destructor.
bool insert(const Key k, Value v): Insert the Value v into this OMRedBlackTree and associate it with Key k. If this the first instance of an item identified by Key k in this OMRedBlackTree, the result is true, otherwise the result is false.
bool find(const Key k, Value& v) const: Find the item in this OMRedBlackTree identified k. If the item is found it is returned in v and the result is true. If the element is not found the result is false.
bool find(const Key k, Value** v) const: Find the item in this OMRedBlackTree identified k. If the item is found it is returned in v and the result is true. If the element is not found the result is false.
bool contains(const Key k) const: Does this OMRdBlackTree contain an item identified by k?
bool remove(const Key k): Remove the item assciated with Key k from this OMRedBlackTree.
virtual void clear(void): Remove all items from this OMRedBlackTree.
size_t count(void) const: The number of items in this OMRedBlackTree. count returns the actual number of items in the OMRedBlackTree.
void traverseInOrder(void (*f)(size_t height, Key k, const Value& v)) const: Traverse this OMRedBlackTree in order, the function f is called for each item in the tree.
void traverseInPreOrder(void (*f)(size_t height, Key k, const Value& v)) const: Traverse this OMRedBlackTree in pre-order, the function f is called for each item in the tree.
void traverseInPostOrder(void (*f)(size_t height, Key k, const Value& v)) const: Traverse this OMRedBlackTree in post-order, the function f is called for each item in the tree.
size_t height(void) const: The height of this OMRedBlackTree.

OMRedBlackTree::clear

template <class Key, class Value>
void OMRedBlackTree<Key, Value>::clear(void)

Remove all items from this OMRedBlackTree.

Defined in: OMRedBlackTreeT.h

Class Template Arguments

Key: The type of the unique key used to identify elements. This type must support operator =, operator != and operator <.
Value: The type of the value carried in an OMRedBlackTree item. This type must support operator =.

Back to OMRedBlackTree

OMRedBlackTree::contains

template <class Key, class Value>
bool OMRedBlackTree<Key, Value>::contains(const Key k) const

Does this OMRdBlackTree contain an item identified by k?

Defined in: OMRedBlackTreeT.h

Return Value

True if k was found in this OMRedBlackTree, false otherwise.

Parameters

k: The Key for which to search.

Class Template Arguments

Key: The type of the unique key used to identify elements. This type must support operator =, operator != and operator <.
Value: The type of the value carried in an OMRedBlackTree item. This type must support operator =.

Back to OMRedBlackTree

OMRedBlackTree::count

template <class Key, class Value>
size_t OMRedBlackTree<Key, Value>::count(void) const

The number of items in this OMRedBlackTree. count returns the actual number of items in the OMRedBlackTree.

Defined in: OMRedBlackTreeT.h

Return Value

The number of items in the OMRedBlackTree.

Class Template Arguments

Key: The type of the unique key used to identify elements. This type must support operator =, operator != and operator <.
Value: The type of the value carried in an OMRedBlackTree item. This type must support operator =.

Back to OMRedBlackTree

OMRedBlackTree::find

template <class Key, class Value>
bool OMRedBlackTree<Key, Value>::find(const Key k, Value** v) const

Find the item in this OMRedBlackTree identified by k. If the item is found it is returned in v and the result is true. If the element is not found the result is false.

Defined in: OMRedBlackTreeT.h

Return Value

True if k was found in this OMRedBlackTree, false otherwise.

Parameters

k: The Key for which to search.
v: The Value associated with k, if any, by pointer.

Class Template Arguments

Key: The type of the unique key used to identify elements. This type must support operator =, operator != and operator <.
Value: The type of the value carried in an OMRedBlackTree item. This type must support operator =.

Back to OMRedBlackTree

OMRedBlackTree::find

template <class Key, class Value>
bool OMRedBlackTree<Key, Value>::find(const Key k, Value& v) const

Find the item in this OMRedBlackTree identified by k. If the item is found it is returned in v and the result is true. If the element is not found the result is false.

Defined in: OMRedBlackTreeT.h

Return Value

True if k was found in this OMRedBlackTree, false otherwise.

Parameters

k: The Key for which to search.
v: The Value associated with k, if any, by reference.

Class Template Arguments

Key: The type of the unique key used to identify elements. This type must support operator =, operator != and operator <.
Value: The type of the value carried in an OMRedBlackTree item. This type must support operator =.

Back to OMRedBlackTree

OMRedBlackTree::height

template <class Key, class Value>
size_t OMRedBlackTree<Key, Value>::height( void) const

The height of this OMRedBlackTree.

Defined in: OMRedBlackTreeT.h

Parameters

void: The hiight of this OMRedBlackTree.

Class Template Arguments

Key: The type of the unique key used to identify elements. This type must support operator =, operator != and operator <.
Value: The type of the value carried in an OMRedBlackTree item. This type must support operator =.

Back to OMRedBlackTree

OMRedBlackTree::insert

template <class Key, class Value>
bool OMRedBlackTree<Key, Value>::insert(const Key k, Value v)

Insert the Value v into this OMRedBlackTree and associate it with Key k. If this the first instance of an item identified by Key k in this OMRedBlackTree, the result is true, otherwise the result is false.

Defined in: OMRedBlackTreeT.h

Return Value

True if this is the first instance of an item identified by Key k in this OMRedBlackTree, false otherwise.

Parameters

k: The key.
v: The value.

Class Template Arguments

Key: The type of the unique key used to identify elements. This type must support operator =, operator != and operator <.
Value: The type of the value carried in an OMRedBlackTree item. This type must support operator =.

Back to OMRedBlackTree

OMRedBlackTree::remove

template <class Key, class Value>
bool OMRedBlackTree<Key, Value>::remove(const Key k)

Remove the item assciated with Key k from this OMRedBlackTree.

Defined in: OMRedBlackTreeT.h

Return Value

True if an item identified by Key k was found, false otherwise.

Parameters

k: The Key of the item to remove.

Class Template Arguments

Key: The type of the unique key used to identify elements. This type must support operator =, operator != and operator <.
Value: The type of the value carried in an OMRedBlackTree item. This type must support operator =.

Back to OMRedBlackTree

OMRedBlackTree::traverseInOrder

template <class Key, class Value>
void OMRedBlackTree<Key, Value>::traverseInOrder( void (*f))

Traverse this OMRedBlackTree in order, the function f is called for each item.

Defined in: OMRedBlackTreeT.h

Parameters

void (*f): The function to apply to each item.

Class Template Arguments

Key: The type of the unique key used to identify elements. This type must support operator =, operator != and operator <.
Value: The type of the value carried in an OMRedBlackTree item. This type must support operator =.

Back to OMRedBlackTree

OMRedBlackTree::traverseInPostOrder

template <class Key, class Value>
void OMRedBlackTree<Key, Value>::traverseInPostOrder( void (*f)) const

Traverse this OMRedBlackTree in post-order, the function f is called for each item.

Defined in: OMRedBlackTreeT.h

Parameters

void (*f): The function to apply to each item.

Class Template Arguments

Key: The type of the unique key used to identify elements. This type must support operator =, operator != and operator <.
Value: The type of the value carried in an OMRedBlackTree item. This type must support operator =.

Back to OMRedBlackTree

OMRedBlackTree::traverseInPreOrder

template <class Key, class Value>
void OMRedBlackTree<Key, Value>::traverseInPreOrder( void (*f)) const

Traverse this OMRedBlackTree in pre-order, the function f is called for each item.

Defined in: OMRedBlackTreeT.h

Parameters

void (*f): The function to apply to each item.

Class Template Arguments

Key: The type of the unique key used to identify elements. This type must support operator =, operator != and operator <.
Value: The type of the value carried in an OMRedBlackTree item. This type must support operator =.

Back to OMRedBlackTree

OMRedBlackTreeIterator class

OMRedBlackTreeIterator class OMRedBlackTreeIterator: public OMContainerIterator

Iterators over OMRedBlackTrees.

Defined in: OMRedBlackTreeIterator.h

Class Template Arguments

Key: The type of the unique key that identifies the contained values.
Value: The type of the contained values.

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMRedBlackTreeIterator(const OMRedBlackTree<Key, Value>& redBlackTree, OMIteratorPosition initialPosition): Create an OMRedBlackTreeIterator over the given OMRedBlackTree redBlackTree and initialize it to the given initialPosition. If initialPosition is specified as OMBefore then this OMRedBlackTreeIterator is made ready to traverse the associated OMRedBlackTree in the forward direction (increasing Keys). If initialPosition is specified as OMAfter then this OMRedBlackTreeIterator is made ready to traverse the associated OMRedBlackTree in the reverse direction (decreasing Keys).
virtual ~OMRedBlackTreeIterator(void): Destroy this OMRedBlackTreeIterator.
virtual void reset(OMIteratorPosition initialPosition): Reset this OMRedBlackTreeIterator to the given initialPosition. If initialPosition is specified as OMBefore then this OMRedBlackTreeIterator is made ready to traverse the associated OMRedBlackTree in the forward direction (increasing Keys). If initialPosition is specified as OMAfter then this OMRedBlackTreeIterator is made ready to traverse the associated OMRedBlackTree in the reverse direction (decreasing Keys).
virtual bool before(void) const: Is this OMRedBlackTreeIterator positioned before the first Value ?
virtual bool after(void) const: Is this OMRedBlackTreeIterator positioned after the last Value ?
virtual size_t count(void) const: The number of Values in the associated OMRedBlackTree.
virtual bool operator++(): Advance this OMRedBlackTreeIterator to the next Value, if any. If the end of the associated OMRedBlackTree is not reached then the result is true , valid becomes true and after becomes false . If the end of the associated OMRedBlackTree is reached then the result is false , valid becomes false and after becomes true .
virtual bool operator--(): Retreat this OMRedBlackTreeIterator to the previous Value, if any. If the beginning of the associated OMRedBlackTree is not reached then the result is true , valid becomes true and before becomes false . If the beginning of the associated OMRedBlackTree is reached then the result is false , valid becomes false and before becomes true .
virtual Value& value(void) const: Return the Value in the associated OMRedBlackTree at the position currently designated by this OMRedBlackTreeIterator.
virtual Value setValue(const Key k, Value newValue): Set the Value in the associated OMRedBlackTree at the position currently designated by this OMRedBlackTreeIterator to newValue. The previous Value is returned. To preserve the ordering of Keys, the Key of newValue must be the same as that of the existing Value.
Key key(void) const: Return the Key of the Value in the associated OMRedBlackTree at the position currently designated by this OMRedBlackTreeIterator.

OMRedBlackTreeIterator::after

template <class Key, class Value>
bool OMRedBlackTreeIterator<Key, Value>::after(void) const

Is this OMRedBlackTreeIterator positioned after the last Value ?

Defined in: OMRedBlackTreeIteratorT.h

Return Value

true if this OMRedBlackTreeIterator is positioned after the last Value, false otherwise.

Class Template Arguments

Key: The type of the unique key that identifies the contained values.
Value: The type of the contained values.

Back to OMRedBlackTreeIterator

OMRedBlackTreeIterator::before

template <class Key, class Value>
bool OMRedBlackTreeIterator<Key, Value>::before(void) const

Is this OMRedBlackTreeIterator positioned before the first Value ?

Defined in: OMRedBlackTreeIteratorT.h

Return Value

true if this OMRedBlackTreeIterator is positioned before the first Value, false otherwise.

Class Template Arguments

Key: The type of the unique key that identifies the contained values.
Value: The type of the contained values.

Back to OMRedBlackTreeIterator

OMRedBlackTreeIterator::count

template <class Key, class Value>
size_t OMRedBlackTreeIterator<Key, Value>::count(void) const

The number of Values in the associated OMRedBlackTree.

Defined in: OMRedBlackTreeIteratorT.h

Return Value

The number of Values.

Class Template Arguments

Key: The type of the unique key that identifies the contained values.
Value: The type of the contained values.

Back to OMRedBlackTreeIterator

OMRedBlackTreeIterator::key

template <class Key, class Value>
Key OMRedBlackTreeIterator<Key, Value>::key(void) const

Return the Key of the Value in the associated OMRedBlackTree at the position currently designated by this OMRedBlackTreeIterator.

Defined in: OMRedBlackTreeIteratorT.h

Return Value

The Key at the current position.

Class Template Arguments

Key: The type of the unique key that identifies the contained values.
Value: The type of the contained values.

Back to OMRedBlackTreeIterator

OMRedBlackTreeIterator::OMRedBlackTreeIterator

template <class Key, class Value>
OMRedBlackTreeIterator<Key, Value>::OMRedBlackTreeIterator(const OMRedBlackTree<Key, Value>& redBlackTree, OMIteratorPosition initialPosition)

Create an OMRedBlackTreeIterator over the given OMRedBlackTree redBlackTree and initialize it to the given initialPosition. If initialPosition is specified as OMBefore then this OMRedBlackTreeIterator is made ready to traverse the associated OMRedBlackTree in the forward direction (increasing Keys). If initialPosition is specified as OMAfter then this OMRedBlackTreeIterator is made ready to traverse the associated OMRedBlackTree in the reverse direction (decreasing Keys).

Defined in: OMRedBlackTreeIteratorT.h

Parameters

redBlackTree: The OMRedBlackTree over which to iterate.
initialPosition: The initial position for this OMRedBlackTreeIterator.

Class Template Arguments

Key: The type of the unique key that identifies the contained values.
Value: The type of the contained values.

OMRedBlackTreeIterator::operator++

template <class Key, class Value>
bool OMRedBlackTreeIterator<Key, Value>::operator++(void)

Advance this OMRedBlackTreeIterator to the next Value, if any. If the end of the associated OMRedBlackTree is not reached then the result is true , valid becomes true and after becomes false . If the end of the associated OMRedBlackTree is reached then the result is false , valid becomes false and after becomes true .

Defined in: OMRedBlackTreeIteratorT.h

Return Value

false if this OMRedBlackTreeIterator has passed the last Value, true otherwise.

Class Template Arguments

Key: The type of the unique key that identifies the contained values.
Value: The type of the contained values.

OMRedBlackTreeIterator::operator--

template <class Key, class Value>
bool OMRedBlackTreeIterator<Key, Value>::operator--(void)

Retreat this OMRedBlackTreeIterator to the previous Value, if any. If the beginning of the associated OMRedBlackTree is not reached then the result is true , valid becomes true and before becomes false . If the beginning of the associated OMRedBlackTree is reached then the result is false , valid becomes false and before becomes true .

Defined in: OMRedBlackTreeIteratorT.h

Return Value

false if this OMRedBlackTreeIterator has passed the first Value, true otherwise.

Class Template Arguments

Key: The type of the unique key that identifies the contained values.
Value: The type of the contained values.

OMRedBlackTreeIterator::reset

template <class Key, class Value>
void OMRedBlackTreeIterator<Key, Value>::reset(OMIteratorPosition initialPosition)

Reset this OMRedBlackTreeIterator to the given initialPosition. If initialPosition is specified as OMBefore then this OMRedBlackTreeIterator is made ready to traverse the associated OMRedBlackTree in the forward direction (increasing Keys). If initialPosition is specified as OMAfter then this OMRedBlackTreeIterator is made ready to traverse the associated OMRedBlackTree in the reverse direction (decreasing Keys).

Defined in: OMRedBlackTreeIteratorT.h

Parameters

initialPosition: The position to which this OMRedBlackTreeIterator should be reset.

Class Template Arguments

Key: The type of the unique key that identifies the contained values.
Value: The type of the contained values.

OMRedBlackTreeIterator::setValue

template <class Key, class Value>
Value OMRedBlackTreeIterator<Key, Value>::setValue(const Key ANAME, k)

Set the Value in the associated OMRedBlackTree at the position currently designated by this OMRedBlackTreeIterator to newValue. The previous Value is returned. To preserve the ordering of Keys, the Key of newValue must be the same as that of the existing Value.

Defined in: OMRedBlackTreeIteratorT.h

Return Value

The previous Value.

Parameters

ANAME: The key Key.
k: The new Value.

Class Template Arguments

Key: The type of the unique key that identifies the contained values.
Value: The type of the contained values.

OMRedBlackTreeIterator::value

template <class Key, class Value>
Value& OMRedBlackTreeIterator<Key, Value>::value(void) const

Return the Value in the associated OMRedBlackTree at the position currently designated by this OMRedBlackTreeIterator.

Defined in: OMRedBlackTreeIteratorT.h

Return Value

The Value at the current position.

Class Template Arguments

Key: The type of the unique key that identifies the contained values.
Value: The type of the contained values.

Back to OMRedBlackTreeIterator

OMRedBlackTreeIterator::~OMRedBlackTreeIterator

template <class Key, class Value>
OMRedBlackTreeIterator<Key, Value>::~OMRedBlackTreeIterator(void)

Destroy this OMRedBlackTreeIterator.

Defined in: OMRedBlackTreeIteratorT.h

Class Template Arguments

Key: The type of the unique key that identifies the contained values.
Value: The type of the contained values.

OMReferenceProperty(const OMPropertyId propertyId, const OMStoredForm storedForm, const wchar_t* name): Constructor.
virtual ~OMReferenceProperty(void): Destructor.
virtual size_t bitsSize(void) const: The size of the raw bits of this OMReferenceProperty. The size is given in bytes.
virtual OMObject* getObject(void) const: Get the value of this OMReferenceProperty.
virtual OMObject* setObject(const OMObject* object): set the value of this OMReferenceProperty.

OMReferenceProperty::bitsSize

size_t OMReferenceProperty::bitsSize(void) const

The size of the raw bits of this OMReferenceProperty. The size is given in bytes.

Defined in: OMRefProperty.cpp

Return Value

The size of the raw bits of this OMReferenceProperty in bytes.

Back to OMReferenceProperty

OMReferenceSet class

OMReferenceSet class OMReferenceSet: public OMReferenceContainer

Sets of uniquely identified objects supported by the Object Manager. Objects are accessible by unique identifier (the key). The objects are not ordered. Duplicates objects are not allowed.

Defined in: OMReferenceSet.h

Class Template Arguments

ReferencedObject: The type of the referenced objects.
UniqueIdentification: The type of the unique key used to identify the referenced objects.

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMReferenceSet(void): Constructor.
virtual ~OMReferenceSet(void): Destructor.
size_t count(void) const: The number of ReferencedObjects in this OMReferenceSet.
void insert(const ReferencedObject* object): Insert object into this OMReferenceSet.
bool ensurePresent(const ReferencedObject* object): If it is not already present, insert object into this OMReferenceSet and return true, otherwise return false.
void appendValue(const ReferencedObject* object): Append the given ReferencedObject object to this OMReferenceSet.
ReferencedObject* remove(const UniqueIdentification& identification): Remove the ReferencedObject identified by identification from this OMReferenceSet.
bool ensureAbsent(const UniqueIdentification& identification): If it is present, remove the ReferencedObject identified by identification from this OMReferenceSet and return true, otherwise return false.
void removeValue(const ReferencedObject* object): Remove object from this OMReferenceSet.
bool ensureAbsent(const ReferencedObject* object): If it is present, remove object from this OMReferenceSet and return true, otherwise return false.
bool containsValue(const ReferencedObject* object) const: Does this OMReferenceSet contain object ?
virtual bool contains(const UniqueIdentification& identification) const: Does this OMReferenceSet contain a ReferencedObject identified by identification?
ReferencedObject* value(const UniqueIdentification& identification) const: The ReferencedObject in this OMReferenceSet identified by identification.
virtual bool find(const UniqueIdentification& identification, ReferencedObject*& object) const: Find the ReferencedObject in this OMReferenceSet identified by identification. If the object is found it is returned in object and the result is true. If the element is not found the result is false.
virtual void insertObject(const OMObject* object): Insert object into this OMReferenceSet.
virtual bool containsObject(const OMObject* object) const: Does this OMReferenceSet contain object ?
virtual void removeObject(const OMObject* object): Remove object from this OMReferenceSet.
virtual void removeAllObjects(void): Remove all objects from this OMReferenceSet.
virtual OMReferenceContainerIterator* createIterator(void) const: Create an OMReferenceContainerIterator over this OMReferenceSet.
virtual OMObject* remove(void* identification): Remove the OMObject identified by identification from this OMReferenceSet.
virtual bool contains(void* identification) const: Does this OMReferenceSet contain an OMObject identified by identification ?
virtual bool findObject(void* identification, OMObject*& object) const: Find the OMObject in this OMReferenceSet identified by identification. If the object is found it is returned in object and the result is true . If the object is not found the result is false .

OMReferenceSet::appendValue

template <class UniqueIdentification, class ReferencedObject>
void OMReferenceSet<UniqueIdentification, ReferencedObject>::appendValue(const ReferencedObject* object)

Append the given ReferencedObject object to this OMReferenceSet.

Defined in: OMReferenceSetT.h

Parameters

object: A pointer to a ReferencedObject.

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::contains

template <class UniqueIdentification, class ReferencedObject>
bool OMReferenceSet<UniqueIdentification, ReferencedObject>::contains(const UniqueIdentification& identification)

Does this OMReferenceSet contain a ReferencedObject identified by identification?

Defined in: OMReferenceSetT.h

Return Value

True if the object is found, false otherwise.

Parameters

identification: The unique identification of the desired object, the search key.

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::contains

template <class UniqueIdentification, class ReferencedObject>
bool OMReferenceSet<UniqueIdentification, ReferencedObject>::contains(void* identification)

Does this OMReferenceSet contain an OMObject identified by identification ?

Defined in: OMReferenceSetT.h

Return Value

TBS

Parameters

identification: TBS

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::containsObject

template <class UniqueIdentification, class ReferencedObject>
bool OMReferenceSet<UniqueIdentification, ReferencedObject>::containsObject(const OMObject* object)

Does this OMReferenceSet contain object ?

Defined in: OMReferenceSetT.h

Return Value

TBS

Parameters

object: TBS

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::containsValue

template <class UniqueIdentification, class ReferencedObject>
bool OMReferenceSet<UniqueIdentification, ReferencedObject>::containsValue(const ReferencedObject* object)

Does this OMReferenceSet contain object ?

Defined in: OMReferenceSetT.h

Parameters

object: A pointer to a ReferencedObject.

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::count

size_t OMReferenceSet::count(void) const

The number of ReferencedObjects in this OMReferenceSet.

Defined in: OMReferenceSetT.h

Back to OMReferenceSet

OMReferenceSet::createIterator

template <class UniqueIdentification, class ReferencedObject>
OMReferenceContainerIterator* OMReferenceSet<UniqueIdentification, ReferencedObject>::createIterator(void)

Create an OMReferenceContainerIterator over this OMReferenceSet.

Defined in: OMReferenceSetT.h

Return Value

TBS

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::ensureAbsent

template <class UniqueIdentification, class ReferencedObject>
bool OMReferenceSet<UniqueIdentification, ReferencedObject>::ensureAbsent(const ReferencedObject* object)

If it is present, remove object from this OMReferenceSet and return true, otherwise return false.

Defined in: OMReferenceSetT.h

Return Value

True if the object was removed, false if it was already absent.

Parameters

object: The object to remove.

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::ensureAbsent

template <class UniqueIdentification, class ReferencedObject>
bool OMReferenceSet<UniqueIdentification, ReferencedObject>::ensureAbsent(const UniqueIdentification& identification)

If it is present, remove the ReferencedObject identified by identification from this OMReferenceSet and return true, otherwise return false.

Defined in: OMReferenceSetT.h

Return Value

True if the object was removed, false if it was already absent.

Parameters

identification: The object to remove.

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::ensurePresent

template <class UniqueIdentification, class ReferencedObject>
bool OMReferenceSet<UniqueIdentification, ReferencedObject>::ensurePresent(const ReferencedObject* object)

If it is not already present, insert object into this OMReferenceSet and return true, otherwise return false.

Defined in: OMReferenceSetT.h

Return Value

True if the object was inserted, false if it was already present.

Parameters

object: The object to insert.

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::find

template <class UniqueIdentification, class ReferencedObject>
bool OMReferenceSet<UniqueIdentification, ReferencedObject>::find(const UniqueIdentification& identification, ReferencedObject*& object) const

Find the ReferencedObject in this OMReferenceSet identified by identification. If the object is found it is returned in object and the result is true. If the element is not found the result is false.

Defined in: OMReferenceSetT.h

Return Value

True if the object is found, false otherwise.

Parameters

identification: The unique identification of the desired object, the search key.
object: A pointer to a ReferencedObject by reference.

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::findObject

template <class UniqueIdentification, class ReferencedObject>
bool OMReferenceSet<UniqueIdentification, ReferencedObject>::findObject(void* identification, OMObject*& object)

Find the OMObject in this OMReferenceSet identified by identification. If the object is found it is returned in object and the result is true . If the object is not found the result is false .

Defined in: OMReferenceSetT.h

Return Value

TBS

Parameters

identification: TBS
object: TBS

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::insert

template <class UniqueIdentification, class ReferencedObject>
void OMReferenceSet<UniqueIdentification, ReferencedObject>::insert(const ReferencedObject* object)

Insert object into this OMReferenceSet.

Defined in: OMReferenceSetT.h

Parameters

object: The object to insert.

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::insertObject

template <class UniqueIdentification, class ReferencedObject>
void OMReferenceSet<UniqueIdentification, ReferencedObject>::insertObject(const OMObject* object)

Insert object into this OMReferenceSet.

Defined in: OMReferenceSetT.h

Parameters

object: TBS

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::OMReferenceSet

OMReferenceSet::OMReferenceSet(void)

Constructor.

Defined in: OMReferenceSetT.h

Back to OMReferenceSet

OMReferenceSet::remove

template <class UniqueIdentification, class ReferencedObject>
OMObject* OMReferenceSet<UniqueIdentification, ReferencedObject>::remove(void* identification)

Remove the OMObject identified by identification from this OMReferenceSet.

Defined in: OMReferenceSetT.h

Return Value

TBS

Parameters

identification: TBS

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::remove

template <class UniqueIdentification, class ReferencedObject>
ReferencedObject* OMReferenceSet<UniqueIdentification, ReferencedObject>::remove(const UniqueIdentification& identification)

Remove the ReferencedObject identified by identification from this OMReferenceSet.

Defined in: OMReferenceSetT.h

Return Value

A pointer to the removed ReferencedObject. If lazy loading is enabled and the referenced object was never loaded the value returned is 0.

Parameters

identification: The unique identification of the object to be removed, the search key.

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::removeAllObjects

template <class UniqueIdentification, class ReferencedObject>
void OMReferenceSet<UniqueIdentification, ReferencedObject>::removeAllObjects(void)

Remove all objects from this OMReferenceSet.

Defined in: OMReferenceSetT.h

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::removeObject

template <class UniqueIdentification, class ReferencedObject>
void OMReferenceSet<UniqueIdentification, ReferencedObject>::removeObject(const OMObject* object)

Remove object from this OMReferenceSet.

Defined in: OMReferenceSetT.h

Parameters

object: TBS

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::removeValue

template <class UniqueIdentification, class ReferencedObject>
void OMReferenceSet<UniqueIdentification, ReferencedObject>::removeValue(const ReferencedObject* object)

Remove object from this OMReferenceSet.

Defined in: OMReferenceSetT.h

Parameters

object: A pointer to a ReferencedObject.

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::value

template <class UniqueIdentification, class ReferencedObject>
ReferencedObject* OMReferenceSet<UniqueIdentification, ReferencedObject>::value(const UniqueIdentification& identification) const

The ReferencedObject in this OMReferenceSet identified by identification.

Defined in: OMReferenceSetT.h

Return Value

A pointer to the ReferencedObject.

Parameters

identification: The unique identification of the desired object, the search key.

Class Template Arguments

UniqueIdentification: The type of the unique key used to identify the referenced objects.
ReferencedObject: The type of the referenced objects.

Back to OMReferenceSet

OMReferenceSet::~OMReferenceSet

OMReferenceSet::~OMReferenceSet(void)

Destructor.

Defined in: OMReferenceSetT.h

Back to OMReferenceSet

OMReferenceSetIterator class

OMReferenceSetIterator class OMReferenceSetIterator

Iterators over OMReferenceSets.

Defined in: OMReferenceSetIter.h

Class Template Arguments

ReferencedObject: The type of the contained objects.

Author

Tim Bingham - tjb - (Avid Technology, Inc.)

Class Members

Public members.

OMReferenceSetIterator(const OMReferenceSet<UniqueIdentification, ReferencedObject>& set, OMIteratorPosition initialPosition = OMBefore): Create an OMReferenceSetIterator over the given OMReferenceSet set and initialize it to the given initialPosition. If initialPosition is specified as OMBefore then this OMReferenceSetIterator is made ready to traverse the associated OMReferenceSet in the forward direction (increasing Keys). If initialPosition is specified as OMAfter then this OMReferenceSetIterator is made ready to traverse the associated OMReferenceSet in the reverse direction (decreasing Keys).
virtual ~OMReferenceSetIterator(void): Destroy this OMReferenceSetIterator.
virtual OMReferenceContainerIterator* copy(void) const: Create a copy of this OMReferenceSetIterator.
virtual void reset(OMIteratorPosition initialPosition = OMBefore): Reset this OMReferenceSetIterator to the given initialPosition. If initialPosition is specified as OMBefore then this OMReferenceSetIterator is made ready to traverse the associated OMReferenceSet in the forward direction (increasing Keys). If initialPosition is specified as OMAfter then this OMReferenceSetIterator is made ready to traverse the associated OMReferenceSet in the reverse direction (decreasing Keys).
virtual bool before(void) const: Is this OMReferenceSetIterator positioned before the first ReferencedObject ?
virtual bool after(void) const: Is this OMReferenceSetIterator positioned after the last ReferencedObject ?
virtual bool valid(void) const: Is this OMReferenceSetIterator validly positioned on a ReferencedObject ?
virtual size_t count(void) const: The number of ReferencedObjects in the associated OMReferenceSet.
virtual bool operator++(): Advance this OMReferenceSetIterator to the next ReferencedObject, if any. If the end of the associated OMReferenceSet is not reached then the result is true , valid becomes true and after becomes false . If the end of the associated OMReferenceSet is reached then the result is false , valid becomes false and after becomes true .
virtual bool operator--(): Retreat this OMReferenceSetIterator to the previous ReferencedObject, if any. If the beginning of the associated OMReferenceSet is not reached then the result is true , valid becomes true and before becomes false . If the beginning of the associated OMReferenceSet is reached then the result is false , valid becomes false and before becomes true .
virtual ReferencedObject* value(void) const: Return the ReferencedObject in the associated OMReferenceSet at the position currently designated by this OMReferenceSetIterator.
virtual ReferencedObject* setValue(const ReferencedObject* newObject): Set the ReferencedObject in the associated OMReferenceSet at the position currently designated by this OMReferenceSetIterator to newObject. The previous ReferencedObject, if any, is returned. To preserve the ordering of Keys, the Key of newObject must be the same as that of the existing ReferencedObject.
virtual OMObject* currentObject(void) const: Return the OMObject in the associated reference container at the position currently designated by this OMReferenceSetIterator.
UniqueIdentification identification(void) const: Return the Key of the ReferencedObject in the associated OMReferenceSet at the position currently designated by this OMReferenceSetIterator.
OMReferenceSetIterator(const SetIterator& iter): Create an OMReferenceSetIterator given an underlying OMSetIterator.

OMReferenceSetIterator::after

template <class ReferencedObject>
bool OMReferenceSetIterator<ReferencedObject>::after(void) const

Is this OMReferenceSetIterator positioned after the last ReferencedObject ?

Defined in: OMReferenceSetIterT.h

Return Value

true if this OMReferenceSetIterator is positioned after the last ReferencedObject, false otherwise.

Class Template Arguments

ReferencedObject: The type of the contained objects.

Back to OMReferenceSetIterator

OMReferenceSetIterator::before

template <class ReferencedObject>
bool OMReferenceSetIterator<ReferencedObject>::before(void) const

Is this OMReferenceSetIterator positioned before the first ReferencedObject ?

Defined in: OMReferenceSetIterT.h

Return Value

true if this OMReferenceSetIterator is positioned before the first ReferencedObject, false otherwise.

Class Template Arguments

ReferencedObject: The type of the contained objects.

Back to OMReferenceSetIterator

OMReferenceSetIterator::copy

template <class ReferencedObject>
OMReferenceContainerIterator* OMReferenceSetIterator<ReferencedObject>::copy(void) const

Create a copy of this OMReferenceSetIterator.

Defined in: OMReferenceSetIterT.h

Return Value

The new OMReferenceSetIterator.

Class Template Arguments

ReferencedObject: The type of the contained objects.

Back to OMReferenceSetIterator

OMReferenceSetIterator::count

template <class ReferencedObject>
size_t OMReferenceSetIterator<ReferencedObject>::count(void) const

The number of ReferencedObjects in the associated OMReferenceSet.

Defined in: OMReferenceSetIterT.h

Return Value

The number of ReferencedObjects

Class Template Arguments

ReferencedObject: The type of the contained objects.

Back to OMReferenceSetIterator

OMReferenceSetIterator::currentObject

template <class ReferencedObject>
OMObject* OMReferenceSetIterator<ReferencedObject>::currentObject(void) const

Return the OMObject in the associated reference container at the position currently designated by this OMReferenceSetIterator.

Defined in: OMReferenceSetIterT.h

Return Value

The OMObject at the current position.

Class Template Arguments

ReferencedObject: The type of the contained objects.

Back to OMReferenceSetIterator

OMReferenceSetIterator::identification

template <class ReferencedObject>
UniqueIdentification OMReferenceSetIterator<ReferencedObject>::identification(void) const

Return the Key of the ReferencedObject in the associated OMReferenceSet at the position currently designated by this OMReferenceSetIterator.

Defined in: OMReferenceSetIterT.h

Return Value

The Key at the current position.

Class Template Arguments

ReferencedObject: The type of the contained objects.

Back to OMReferenceSetIterator

OMReferenceSetIterator::OMReferenceSetIterator

template <class ReferencedObject>
OMReferenceSetIterator<ReferencedObject>::OMReferenceSetIterator(const SetIterator& iter)

Create an OMReferenceSetIterator given an underlying OMSetIterator.

Defined in: OMReferenceSetIterT.h

Parameters

iter: The underlying OMSetIterator.

Class Template Arguments

ReferencedObject: The type of the contained objects.

OMReferenceSetIterator::OMReferenceSetIterator

template <class ReferencedObject>
OMReferenceSetIterator<ReferencedObject>::OMReferenceSetIterator(const OMReferenceSet< UniqueIdentification, ReferencedObject>& set)

Create an OMStrongReferenceSetIterator over the given OMReferenceSet set and initialize it to the given initialPosition. If initialPosition is specified as OMBefore then this OMStrongReferenceSetIterator is made ready to traverse the associated OMReferenceSet in the forward direction (increasing Keys). If initialPosition is specified as OMAfter then this OMStrongReferenceSetIterator is made ready to traverse the associated OMReferenceSet in the reverse direction (decreasing Keys).

Defined in: OMReferenceSetIterT.h

Parameters

UniqueIdentification: The OMStrongReferenceSet over which to iterate.
set: The initial position for this OMReferenceSetIterator.

Class Template Arguments

ReferencedObject: The type of the contained objects.

OMReferenceSetIterator::operator++

template <class ReferencedObject>
bool OMReferenceSetIterator<ReferencedObject>::operator++(void)

Advance this OMReferenceSetIterator to the next ReferencedObject, if any. If the end of the associated OMReferenceSet is not reached then the result is true , valid becomes true and after becomes false . If the end of the associated OMReferenceSet is reached then the result is false , valid becomes false and after becomes true .

Defined in: OMReferenceSetIterT.h

Return Value

false if this OMReferenceSetIterator has passed the last ReferencedObject, true otherwise.

Class Template Arguments

ReferencedObject: The type of the contained objects.

OMReferenceSetIterator::operator--

template <class ReferencedObject>
bool OMReferenceSetIterator<ReferencedObject>::operator--(void)

Retreat this OMReferenceSetIterator to the previous ReferencedObject, if any. If the beginning of the associated OMReferenceSet is not reached then the result is true , valid becomes true and before becomes false . If the beginning of the associated OMReferenceSet is reached then the result is false , valid becomes false and before becomes true .

Defined in: OMReferenceSetIterT.h

Return Value

false if this OMReferenceSetIterator has passed the first ReferencedObject, true otherwise.

Class Template Arguments

ReferencedObject: The type of the contained objects.

OMReferenceSetIterator::reset

template <class ReferencedObject>
void OMReferenceSetIterator<ReferencedObject>::reset(OMIteratorPosition initialPosition)

Reset this OMReferenceSetIterator to the given initialPosition. If initialPosition is specified as OMBefore then this OMReferenceSetIterator is made ready to traverse the associated OMReferenceSet in the forward direction (increasing Keys). If initialPosition is specified as OMAfter then this OMReferenceSetIterator is made ready to traverse the associated OMReferenceSet in the reverse direction (decreasing Keys).

Defined in: OMReferenceSetIterT.h

Parameters

initialPosition: The position to which this OMReferenceSetIterator should be reset.

Class Template Arguments

ReferencedObject: The type of the contained objects.

OMReferenceSetIterator::setValue

template <class ReferencedObject>
ReferencedObject* OMReferenceSetIterator<ReferencedObject>::setValue(const ReferencedObject* newObject)

Set the ReferencedObject in the associated OMReferenceSet at the position currently designated by this OMReferenceSetIterator to newObject. The previous ReferencedObject, if any, is returned. To preserve the ordering of Keys, the Key of newObject must be the same as that of the existing ReferencedObject.

Defined in: OMReferenceSetIterT.h

Return Value

The previous ReferencedObject if any, otherwise 0.

Parameters

newObject: The new ReferencedObject.

Class Template Arguments

ReferencedObject: The type of the contained objects.

OMReferenceSetIterator::valid

template <class ReferencedObject>
bool OMReferenceSetIterator<ReferencedObject>::valid(void) const

Is this OMReferenceSetIterator validly positioned on a ReferencedObject ?

Defined in: OMReferenceSetIterT.h

Return Value

true if this OMReferenceSetIterator is positioned on a ReferencedObject, false otherwise.

Class Template Arguments

ReferencedObject: The type of the contained objects.

Back to OMReferenceSetIterator

OMReferenceSetIterator::value

template <class ReferencedObject>
ReferencedObject* OMReferenceSetIterator<ReferencedObject>::value(void) const

Return the ReferencedObject in the associated OMReferenceSet at the position currently designated by this OMReferenceSetIterator.

Defined in: OMReferenceSetIterT.h

Return Value

The ReferencedObject at the current position.

Class Template Arguments

ReferencedObject: The type of the contained objects.

Back to OMReferenceSetIterator

OMReferenceSetIterator::~OMReferenceSetIterator

template <class ReferencedObject>
OMReferenceSetIterator<ReferencedObject>::~OMReferenceSetIterator(void)

Destroy this OMReferenceSetIterator.

Defined in: OMReferenceSetIterT.h

Class Template Arguments

ReferencedObject: The type of the contained objects.