DWFToolkit::DWFProperty Class Reference
[DWF Package API]

#include "dwf/package/Property.h"

Inheritance diagram for DWFToolkit::DWFProperty:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

This class represents a categorized name-value data pair.

Since:
7.0.1
Properties are available for use with the DWFPropertyContainer utility class and those that specialize it.
Examples:

3DPublish/3DPublish_UTF8.cpp, GlobalSectionWriter/GlobalSectionWriter.cpp, ReadContentDefinition/ReadContentDefinition.cpp, SimpleEnumReader/SimpleEnumReader.cpp, and SimpleEPlotWriter/SimpleEPlotWriter_UTF8.cpp.

Definition at line 58 of file Property.h.

Public Types

typedef DWFVectorIterator<
DWFProperty *, _DWFTK_STL_ALLOCATOR<
DWFProperty * > > 
tListIterator
 This type defines a DWFIterator on the list of DWFProperty pointers.
typedef DWFOrderedVector<
DWFProperty * > 
tOrderedList
 This type defines an ordered list of DWFProperty pointers.
typedef DWFStringKeyChainedSkipList<
DWFProperty * > 
tMap
 This type defines a mapped collection of DWFProperty pointers.
typedef DWFCachingIterator<
DWFProperty * > 
tCachingIterator
 This type defines a caching iterator on a collection of DWFProperty pointers, that caches the pointers in its own container.
typedef DWFIterator< DWFProperty * > tIterator
 This type defines a basic iterator on a collection of DWFProperty pointers.
typedef pair< DWFString, DWFStringtAttributePair
 This definitions are for return the attributes set of this DWFProperty.
typedef std::map< DWFString,
tAttributeList > 
tAttributeMap

Public Member Functions

typedef _DWFTK_STD_VECTOR (DWFProperty *) tList
 This type defines a list of DWFProperty pointers.
_DWFTK_API DWFProperty () throw ()
_DWFTK_API DWFProperty (const DWFString &zName, const DWFString &zValue, const DWFString &zCategory=L"", const DWFString &zType=L"", const DWFString &zUnits=L"") throw ()
virtual _DWFTK_API ~DWFProperty () throw ()
_DWFTK_API DWFProperty (const DWFProperty &rProperty) throw ()
_DWFTK_API DWFPropertyoperator= (const DWFProperty &rProperty) throw ()
_DWFTK_API const DWFStringname () const throw ()
_DWFTK_API void setName (const DWFString &zName) throw ()
_DWFTK_API const DWFStringvalue () const throw ()
_DWFTK_API void setValue (const DWFString &zValue) throw ()
_DWFTK_API const DWFStringcategory () const throw ()
_DWFTK_API void setCategory (const DWFString &zCategory) throw ()
_DWFTK_API const DWFStringtype () const throw ()
_DWFTK_API void setType (const DWFString &zType) throw ()
_DWFTK_API const DWFStringunits () const throw ()
_DWFTK_API void setUnits (const DWFString &zUnits) throw ()
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList) throw ( DWFException )
_DWFTK_API const tAttributeMapgetCustomizedAttributeList () throw ()
virtual _DWFTK_API void own (DWFOwner &rOwner) throw ( DWFException )
virtual _DWFTK_API bool disown (DWFOwner &rOwner, bool bForget) throw ( DWFException )
virtual _DWFTK_API DWFOwnerowner () throw ( DWFException )
virtual _DWFTK_API void observe (DWFOwner &rObserver) throw ( DWFException )
virtual _DWFTK_API bool unobserve (DWFOwner &rObserver) throw ( DWFException )
_DWFTK_API void _notifyDelete () throw ()
_DWFTK_API void addXMLAttribute (const DWFXMLNamespace &rNamespace, const DWFString &zName, const DWFString &zValue) throw ( DWFException )
_DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )
DWFOwnabletoOwnable ()

Friends

class tPropertyArchive


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFProperty::DWFProperty  )  throw ()
 

Constructor

Exceptions:
None 

_DWFTK_API DWFToolkit::DWFProperty::DWFProperty const DWFString zName,
const DWFString zValue,
const DWFString zCategory = L"",
const DWFString zType = L"",
const DWFString zUnits = L""
throw ()
 

Constructor

Parameters:
zName Identifies the property within its zCategory.
zValue The data associated with the property.
zCategory An optional grouping of properties.
zType An optional type defining the data.
zUnits An optional type defining the data.
Exceptions:
None 

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

Destructor

Exceptions:
None 

_DWFTK_API DWFToolkit::DWFProperty::DWFProperty const DWFProperty rProperty  )  throw ()
 

Copy Constructor

Parameters:
rProperty The source property from which to copy.
Exceptions:
None 


Member Function Documentation

_DWFTK_API void DWFToolkit::DWFProperty::_notifyDelete  )  throw ()
 

_DWFTK_API void DWFToolkit::DWFProperty::addXMLAttribute const DWFXMLNamespace rNamespace,
const DWFString zName,
const DWFString zValue
throw ( DWFException )
 

This method can be used by publishers to add extra data to property elements. These data are not part of the DWF format schema and must therefore be scoped by a unique namespace.

Parameters:
rNamespace The publisher-specific (non DWF) namespace for the attribute. This object is obtained from only those classes that support and implement the DWFXMLSerializable::addNamespace() method. This parameter is required; this method will thrown an exception if this parameter is not provided.
zName The name of the attribute. This parameter is required; this method will thrown an exception if this parameter is not provided.
zValue The attribute value. This parameter is required; this method will thrown an exception if this parameter is not provided.

_DWFTK_API const DWFString& DWFToolkit::DWFProperty::category  )  const throw () [inline]
 

Returns the property category.

Returns:
A string identifying an optional grouping.
Exceptions:
None 
Examples:
ReadContentDefinition/ReadContentDefinition.cpp, and SimpleEnumReader/SimpleEnumReader.cpp.

Definition at line 212 of file Property.h.

virtual _DWFTK_API bool DWFToolkit::DWFProperty::disown DWFOwner rOwner,
bool  bForget
throw ( DWFException ) [virtual]
 

_DWFTK_API const tAttributeMap& DWFToolkit::DWFProperty::getCustomizedAttributeList  )  throw ()
 

Returns:
the customer defined attributes

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

Returns the property name.

Returns:
A string identifying the property with a category.
Exceptions:
None 
Examples:
ReadContentDefinition/ReadContentDefinition.cpp, and SimpleEnumReader/SimpleEnumReader.cpp.

Definition at line 166 of file Property.h.

virtual _DWFTK_API void DWFToolkit::DWFProperty::observe DWFOwner rObserver  )  throw ( DWFException ) [virtual]
 

_DWFTK_API DWFProperty& DWFToolkit::DWFProperty::operator= const DWFProperty rProperty  )  throw ()
 

Assignment Operator

Parameters:
rProperty The source property from which to copy.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFProperty::own DWFOwner rOwner  )  throw ( DWFException ) [virtual]
 

virtual _DWFTK_API DWFOwner* DWFToolkit::DWFProperty::owner  )  throw ( DWFException ) [virtual]
 

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

Implements DWFCore::DWFXMLBuildable.

_DWFTK_API void DWFToolkit::DWFProperty::serializeXML DWFXMLSerializer rSerializer,
unsigned int  nFlags
throw ( DWFException ) [virtual]
 

Implements DWFCore::DWFXMLSerializableBase.

_DWFTK_API void DWFToolkit::DWFProperty::setCategory const DWFString zCategory  )  throw ()
 

Modifies the property category.

Parameters:
zCategory The new category.
Exceptions:
None 
Examples:
GlobalSectionWriter/GlobalSectionWriter.cpp.

_DWFTK_API void DWFToolkit::DWFProperty::setName const DWFString zName  )  throw ()
 

Modifies the property name.

Parameters:
zName The new name.
Exceptions:
None 
Examples:
GlobalSectionWriter/GlobalSectionWriter.cpp.

_DWFTK_API void DWFToolkit::DWFProperty::setType const DWFString zType  )  throw ()
 

Modifies the property value type.

Parameters:
zType The new type.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFProperty::setUnits const DWFString zUnits  )  throw ()
 

Modifies the property value units.

Parameters:
zUnits The new units.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFProperty::setValue const DWFString zValue  )  throw ()
 

Modifies the property value.

Parameters:
zValue The new value.
Exceptions:
None 
Examples:
GlobalSectionWriter/GlobalSectionWriter.cpp.

DWFOwnable& DWFToolkit::DWFProperty::toOwnable  )  [inline]
 

Convert to DWFOwnable& type

Returns:
The reference of DWFOwnable.
Exceptions:
None 

Definition at line 439 of file Property.h.

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

Returns the property value type.

Returns:
A string identifying the value type.
Exceptions:
None 

Definition at line 235 of file Property.h.

_DWFTK_API const DWFString& DWFToolkit::DWFProperty::units  )  const throw () [inline]
 

Returns the property value units.

Returns:
A string identifying the data units.
Exceptions:
None 

Definition at line 258 of file Property.h.

virtual _DWFTK_API bool DWFToolkit::DWFProperty::unobserve DWFOwner rObserver  )  throw ( DWFException ) [virtual]
 

_DWFTK_API const DWFString& DWFToolkit::DWFProperty::value  )  const throw () [inline]
 

Returns the property value.

Returns:
A string identifying the property data.
Exceptions:
None 
Examples:
ReadContentDefinition/ReadContentDefinition.cpp, and SimpleEnumReader/SimpleEnumReader.cpp.

Definition at line 189 of file Property.h.


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