IDOMResource Class Reference

Provides an interface to an EDL DOM node representing a generalised resource. A resource represents non-markup document content such as images, fonts and profiles. Resources are generally stream based. This class provides the base class for interfaces to more specialized resource node types. More...

#include <edl/idomresources.h>

Inheritance diagram for IDOMResource:

Public Member Functions
virtual IInputStreamPtr	getStream () const =0
	Retrieves the resource stream.
virtual void	setStream (const IInputStreamPtr &stream)=0
	Sets the resource stream for the node.
virtual uint64	getStreamLength () const =0
	Retrieves the stream length, if it is available.
virtual const EDLSysString &	getUri () const =0
	Retrieves the resource URI.
virtual void	setUri (const EDLSysString &uri)=0
	Sets the resource URI.
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.

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

Detailed Description

Provides an interface to an EDL DOM node representing a generalised resource. A resource represents non-markup document content such as images, fonts and profiles. Resources are generally stream based. This class provides the base class for interfaces to more specialized resource node types.

Member Function Documentation

getStream()

virtual IInputStreamPtr IDOMResource::getStream ( ) const

pure virtual

Retrieves the resource stream.

Returns

IInputStreamPtr. A smart pointer to the resource stream. Can be NULL if there is no stream.

Implemented in IDOMTrivialImage.

getStreamLength()

virtual uint64 IDOMResource::getStreamLength ( ) const

pure virtual

Retrieves the stream length, if it is available.

Returns

uint64. The stream length.

getUri()

virtual const EDLSysString & IDOMResource::getUri ( ) const

pure virtual

Retrieves the resource URI.

Returns

bool. Returns a constant reference to the resource URI.

setStream()

virtual void IDOMResource::setStream ( const IInputStreamPtr & stream )

pure virtual

Sets the resource stream for the node.

Parameters

stream

Smart pointer to the new resource stream.

Implemented in IDOMCachedImage, IDOMCompositeImage, IDOMFilteredImage, IDOMRecombineAlphaImage, IDOMRecombineImage, and IDOMTrivialImage.

setUri()

virtual void IDOMResource::setUri ( const EDLSysString & uri )

pure virtual

Sets the resource URI.

Parameters

uri	The new resource URI.

---

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

• edl/idomresources.h