DWFToolkit::DWFResourceRelationship Class Reference

#include "dwf/package/Resource.h"

Collaboration diagram for DWFToolkit::DWFResourceRelationship:

Collaboration graph
[legend]
List of all members.

Detailed Description

Resource to resource relationship.

Since:
7.3
This class defines relationships between DWFResource objects. A relationship is specified by a pointer to a DWFResource object and a string describing the type of the relationship.

Definition at line 63 of file package/Resource.h.

Public Types

typedef DWFOrderedVector<
DWFResourceRelationship * > 
tList
 This type defines a list of Relationship pointers.

Public Member Functions

_DWFTK_API DWFResourceRelationship (DWFPackageReader *) throw ()
_DWFTK_API DWFResourceRelationship (const DWFResource *pResource, const DWFString &zType) throw ()
virtual _DWFTK_API ~DWFResourceRelationship () throw ()
_DWFTK_API const DWFStringresourceID () const throw (DWFException)
_DWFTK_API const DWFStringtype () const throw ()
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList) throw ( DWFException )


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFResourceRelationship::DWFResourceRelationship DWFPackageReader  )  throw () [inline]
 

Constructor

This constructor is generally only used by the parsing process when the DWFPackageReader associated with (and providing read access to) the DWF package file is available. The subsequent binding makes it possible to read resource content data from the DWF package.

Parameters:
pPackageReader Provides access to resource content in the DWF package.
Exceptions:
None 

Definition at line 86 of file package/Resource.h.

_DWFTK_API DWFToolkit::DWFResourceRelationship::DWFResourceRelationship const DWFResource pResource,
const DWFString zType
throw () [inline]
 

Constructor

Parameters:
pResource A to the related resource.
zType A description of the relationship.
Exceptions:
None 

Definition at line 103 of file package/Resource.h.

virtual _DWFTK_API DWFToolkit::DWFResourceRelationship::~DWFResourceRelationship  )  throw () [inline, virtual]
 

Destructor

Definition at line 114 of file package/Resource.h.


Member Function Documentation

virtual _DWFTK_API void DWFToolkit::DWFResourceRelationship::parseAttributeList const char **  ppAttributeList  )  throw ( DWFException ) [virtual]
 

_DWFTK_API const DWFString& DWFToolkit::DWFResourceRelationship::resourceID  )  const throw (DWFException)
 

Returns the object ID of the related resource held by this relationship.

An empty string will be returned if the resource does not yet have an object ID.

Returns:
Returns the object ID of the related resource held by this relationship.
Exceptions:
DWFException - if no resource/objectID was set.

_DWFTK_API const DWFString& DWFToolkit::DWFResourceRelationship::type  )  const throw () [inline]
 

Returns the description of this relationship.

Returns:
Returns the description of this relationship.
Exceptions:
None 

Definition at line 137 of file package/Resource.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:40:33 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5