IDOMImageProperties Class Reference

The IDOMImageProperties interface provides access to an underlying implementation which stores miscellaneous information about the associated image. More...

#include <edl/idomimageresource.h>

Inheritance diagram for IDOMImageProperties:

Public Member Functions
virtual void	setProperty (const EDLString &name, const EDLString &value)=0
	Registers the name of a property and a string value for the property.
virtual bool	getProperty (const EDLString &name, EDLString &value)=0
	Retrieves the value of a named property as a string value.
virtual void	setBoolProperty (const EDLString &name, bool value)=0
	Registers the name of a property and a Boolean value for the property.
virtual bool	getBoolProperty (const EDLString &name, bool &value)=0
	Retrieves the value of a named property as a Boolean value.
virtual void	setIntProperty (const EDLString &name, int value)=0
	Registers the name of a property and an integer value for the property.
virtual bool	getIntProperty (const EDLString &name, int &value)=0
	Retrieves the value of a named property as an integer value.
virtual void	setObjectProperty (const EDLString &name, const IRCObjectPtr &object)=0
	Registers the name of a property and an IRCObject value for the property.
virtual bool	getObjectProperty (const EDLString &name, IRCObjectPtr &value)=0
	Retrieves the value of a named property as an IRCObject value.
Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.
virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.
virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static const CClassID &	classID ()
	Retrieves class id of IDOMImageProperties.
static EDL_API IDOMImagePropertiesPtr	create ()
	Create an empty image properties.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

The IDOMImageProperties interface provides access to an underlying implementation which stores miscellaneous information about the associated image.

IDOMImageProperties holds a collection of name-value pairs which can be used to store arbitrary information about the image. The name must be unique within the collection, as it provides a key into it.

Methods are provided to allow the storage of integer, Boolean and string values.

A typical use would be to store information which would be expensive to compute-for example, whether or not the image is a noisy mask.

Instances of these objects may throw IEDLError exceptions on failure.

Member Function Documentation

classID()

const CClassID & IDOMImageProperties::classID ( )

inlinestatic

Retrieves class id of IDOMImageProperties.

Returns

CClassID Class id of the element.

create()

EDL_API IDOMImagePropertiesPtr IDOMImageProperties::create ( )

static

Create an empty image properties.

Returns

IDOMImagePropertiesPtr The properties.

getBoolProperty()

virtual bool IDOMImageProperties::getBoolProperty ( const EDLString & name, bool & value )

pure virtual

Retrieves the value of a named property as a Boolean value.

Parameters

name	Property name.
value	Reference parameter to receive the property value.

Returns

bool True on success, false if property does not exist or is a different type. The value parameter will contain the property value.

getIntProperty()

virtual bool IDOMImageProperties::getIntProperty ( const EDLString & name, int & value )

pure virtual

Retrieves the value of a named property as an integer value.

Parameters

name	Property name.
value	Reference parameter to receive the property value.

Returns

bool True on success, false if property does not exist or is a different type. The value parameter will contain the property value.

getObjectProperty()

virtual bool IDOMImageProperties::getObjectProperty ( const EDLString & name, IRCObjectPtr & value )

pure virtual

Retrieves the value of a named property as an IRCObject value.

Parameters

name	Property name.
value	An IRCObject reference to receive the property value.

Returns

bool True on success, false if property does not exist or is a different type. The value parameter will contain the property value.

getProperty()

virtual bool IDOMImageProperties::getProperty ( const EDLString & name, EDLString & value )

pure virtual

Retrieves the value of a named property as a string value.

Parameters

name	Property name.
value	Reference parameter to receive the property value.

Returns

bool True on success, false if property does not exist. The value parameter will contain the property value.

setBoolProperty()

virtual void IDOMImageProperties::setBoolProperty ( const EDLString & name, bool value )

pure virtual

Registers the name of a property and a Boolean value for the property.

Parameters

name	Property name.
value	The Boolean value for the property.

setIntProperty()

virtual void IDOMImageProperties::setIntProperty ( const EDLString & name, int value )

pure virtual

Registers the name of a property and an integer value for the property.

Parameters

name	Property name.
value	The integer value for the property.

setObjectProperty()

virtual void IDOMImageProperties::setObjectProperty ( const EDLString & name, const IRCObjectPtr & object )

pure virtual

Registers the name of a property and an IRCObject value for the property.

Parameters

name	Property name.
object	An IRCObject reference to the value for the property.

setProperty()

virtual void IDOMImageProperties::setProperty ( const EDLString & name, const EDLString & value )

pure virtual

Registers the name of a property and a string value for the property.

Parameters

name	Property name.
value	The string value for the property.

---

The documentation for this class was generated from the following file:

• edl/idomimageresource.h