Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages | Examples

DWFToolkit::DWFPublishedObject Class Reference
[DWF Publisher API]

#include "dwf/publisher/PublishedObject.h"

Inheritance diagram for DWFToolkit::DWFPublishedObject:

Inheritance graph
[legend]
Collaboration diagram for DWFToolkit::DWFPublishedObject:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class is used to capture the elationship between a graphics element/node and some publishable structure and metadata.
Since:
7.0.1.

Definition at line 57 of file PublishedObject.h.

Public Types

typedef long tKey
 Defines the data type used for object keys.
typedef int tIndex
 Defines the data type used for object indices.
typedef vector< tReference * > tReferenceList
 This type defines a list of tReference pointers.
typedef vector< DWFPublishedObject * > tList
 This type defines a list of DWFPublishedObject pointers.
typedef DWFSkipList< tKey,
DWFPublishedObject * > 
tMap
 This type defines a mapped collection of DWFPublishedObject pointers.

Public Member Functions

_DWFTK_API DWFPublishedObject (tKey nKey, const DWFString &zName) throw ()
_DWFTK_API DWFPublishedObject (DWFPublishedObject &rSource) throw ()
_DWFTK_API DWFPublishedObjectoperator= (DWFPublishedObject &rSource) throw ()
virtual _DWFTK_API ~DWFPublishedObject () throw ()
_DWFTK_API const DWFStringname () const throw ()
_DWFTK_API void path (DWFString &zPath) throw ()
_DWFTK_API tKey key () const throw ()
_DWFTK_API tIndex index () const throw ()
_DWFTK_API void setIndex (tIndex nIndex) throw ()
_DWFTK_API DWFPublishedObjectparent () const throw ()
_DWFTK_API void setParent (DWFPublishedObject *pParentObject) throw ()
_DWFTK_API void referenced () throw ()
_DWFTK_API bool isReferenced () throw ()
_DWFTK_API void addReference (DWFPublishedObject *pObject, DWFPublishedObject::tKey nKey, const DWFString *zInstanceName=NULL, bool bPropertiesOnly=false) throw ( DWFException )
_DWFTK_API tReferenceListreferences () throw ( DWFException )
_DWFTK_API void accept (DWFPublishedObject::Visitor &rVisitor) throw ( DWFException )
_DWFTK_API void accept (DWFPropertyVisitor &rVisitor) throw ( DWFException )

Classes

class  Factory
struct  tReference
 Data structure used for capturing cross-object references. More...
class  Visitor
 Base implementation and interface defintion for objects (visitors) that that extract structure and metadata from the published objects.
Since:
7.0.1.
More...


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFPublishedObject::DWFPublishedObject tKey  nKey,
const DWFString zName
throw ()
 

Constructor

Parameters:
nKey Unique identifier for the object.
zName Descriptive name for the object.
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFPublishedObject::DWFPublishedObject DWFPublishedObject rSource  )  throw ()
 

Copy Constructor

Parameters:
rSource The object to copy.
Exceptions:
None 

virtual _DWFTK_API DWFToolkit::DWFPublishedObject::~DWFPublishedObject  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API void DWFToolkit::DWFPublishedObject::accept DWFPropertyVisitor rVisitor  )  throw ( DWFException )
 

Receives a property visitor and provides itself to its interface.

Parameters:
rVisitor The property visitor.
Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFPublishedObject::accept DWFPublishedObject::Visitor rVisitor  )  throw ( DWFException )
 

Receives an object visitor and provides itself to its interface.

Parameters:
rVisitor The published object visitor.
Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFPublishedObject::addReference DWFPublishedObject pObject,
DWFPublishedObject::tKey  nKey,
const DWFString zInstanceName = NULL,
bool  bPropertiesOnly = false
throw ( DWFException )
 

Creates a reference to an existing object.

Parameters:
pObject The object to reference.
nKey The unique identifier of the object to which the association is being made.
zInstanceName An optional name for the reference relationship.
bPropertiesOnly The reference is non-structural; only copy the properties to the referencing (this) object.
Exceptions:
DWFException 

_DWFTK_API tIndex DWFToolkit::DWFPublishedObject::index  )  const throw () [inline]
 

Returns the object's graphic index.

An object is associated with some graphic node or element. One of these nodes itself is a marker than associates a collection of visual elements with some identifier. This index value is used to

Returns:
An indentifier that associates this object with the graphic node or element.
Exceptions:
None 

Definition at line 347 of file PublishedObject.h.

_DWFTK_API bool DWFToolkit::DWFPublishedObject::isReferenced  )  throw () [inline]
 

Returns a flag indicating whether or not this is a reference object.

Returns:
A flag indicating whether or not this is a reference object.
Exceptions:
None 

Definition at line 424 of file PublishedObject.h.

_DWFTK_API tKey DWFToolkit::DWFPublishedObject::key  )  const throw () [inline]
 

Returns the object's unique key.

The key is used to bind the object to a data structure that itself defines the graphic element or entry point to it. This data structure then provides the index of (the association to) the actual graphics.

Returns:
The unique object identifier.
Exceptions:
None 

Definition at line 329 of file PublishedObject.h.

_DWFTK_API const DWFString& DWFToolkit::DWFPublishedObject::name  )  const throw () [inline]
 

Returns the object's name

Objects may exist in a hierachy and the full path of one branch may be expressed as a concatenation of object names. Names are not necessarily unique among all objects in the same set.

Returns:
The descriptive name.
Exceptions:
None 

Definition at line 298 of file PublishedObject.h.

_DWFTK_API DWFPublishedObject& DWFToolkit::DWFPublishedObject::operator= DWFPublishedObject rSource  )  throw ()
 

Assignment Operator

Parameters:
rSource The object to copy.
Exceptions:
None 

_DWFTK_API DWFPublishedObject* DWFToolkit::DWFPublishedObject::parent  )  const throw () [inline]
 

Returns the object's parent (if applicable.)

Returns:
A pointer to the parent. This pointer must not be deleted by the caller.
Exceptions:
None 

Definition at line 373 of file PublishedObject.h.

_DWFTK_API void DWFToolkit::DWFPublishedObject::path DWFString zPath  )  throw ()
 

Returns the full path of the object expressed as a concatenation of hierachical object names (including it's own) and some separation character.

Parameters:
zPath A string object to receive the path.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFPublishedObject::referenced  )  throw () [inline]
 

Indicates that this object is a reference object.

A reference object is one that indicates reuse of graphics in the scene and has additional considerations when visited for reporting it's metadata [structure].

For example, in the 3D model (DWFModel), published objects refer to "interesting" segments in the scene graph that the publisher wishes to identify as navigable entities and defined object instances (DWFDefinedObjectInstance) from which to hang object properties (DWFProperty). The 3D API allows for graphics to be defined once and applied many times in the scene resulting in smaller files. These are DWFIncludeSegment classes.

Exceptions:
None 

Definition at line 411 of file PublishedObject.h.

_DWFTK_API tReferenceList& DWFToolkit::DWFPublishedObject::references  )  throw ( DWFException )
 

Returns the list of objects that this object makes reference to.

Returns:
A reference to the internal list of object references.
Exceptions:
DWFException 
Todo:
Don't return the internal collection. Use a DWFIterator instead.

_DWFTK_API void DWFToolkit::DWFPublishedObject::setIndex tIndex  nIndex  )  throw () [inline]
 

Assigns an graphic index to the object.

Parameters:
nIndex An indentifier that associates this object with the graphic node or element.
Exceptions:
None 

Definition at line 360 of file PublishedObject.h.

_DWFTK_API void DWFToolkit::DWFPublishedObject::setParent DWFPublishedObject pParentObject  )  throw () [inline]
 

Assigns another as this object's parent.

Parameters:
pParentObject A pointer to another object. This pointer remains the responsibility of the caller to delete.
Exceptions:
None 

Definition at line 387 of file PublishedObject.h.


The documentation for this class was generated from the following file:
Generated on Tue May 17 12:39:16 2005 for Autodesk DWF Toolkit by  doxygen 1.4.1