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

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, DWFGoogleDesktopCrawl/DWFCrawlHandler.cpp, GlobalSectionWriter/GlobalSectionWriter.cpp, ObjectDefinitionReader/ObjectDefinitionReader.cpp, SimpleEnumReader/SimpleEnumReader.cpp, and SimpleEPlotWriter/SimpleEPlotWriter_UTF8.cpp.

Definition at line 54 of file Property.h.

Public Types

typedef vector< DWFProperty * > tList
 This type defines a list of DWFProperty pointers.
typedef DWFStringKeyChainedSkipList<
DWFProperty * > 
tMap
 This type defines a mapped collection of DWFProperty pointers.

Public Member Functions

_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 void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )


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 const DWFString& DWFToolkit::DWFProperty::category  )  const throw () [inline]
 

Returns the property category.

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

Definition at line 191 of file Property.h.

_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:
DWFGoogleDesktopCrawl/DWFCrawlHandler.cpp, ObjectDefinitionReader/ObjectDefinitionReader.cpp, and SimpleEnumReader/SimpleEnumReader.cpp.

Definition at line 139 of file Property.h.

_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::parseAttributeList const char **  ppAttributeList  )  throw ( DWFException ) [virtual]
 

Receives and processes an attribute list from the parser; using it to initialize class members.

Example:

                 size_t iAttrib = 0;
       
                 for(; ppAttributeList[iAttrib]; iAttrib += 2)
                 {
                    //
                    // dump attribute 
                    //
                    cout << "Attribute Name: " << ppAttributeList[iAttrib] << " ";
                    cout << "Attribute Value: " << ppAttributeList[iAttrib+1] << endl;
                }

Parameters:
ppAttributeList An array of null-terminated atribute name, value string pairs. The array itself is zero-terminated.
Exceptions:
None 

Implements DWFToolkit::DWFXMLBuildable.

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

Writes an XML representation of the object into a stream.

Parameters:
rSerializer The object that accepts the serialization of the object.
nFlags An implementation-defined set of options for altering the serialization process of this object.

Implements DWFToolkit::DWFXMLSerializable.

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

Modifies the property category.

Parameters:
zCategory The new category.
Exceptions:
None 

Definition at line 204 of file Property.h.

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

Modifies the property name.

Parameters:
zName The new name.
Exceptions:
None 

Definition at line 152 of file Property.h.

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

Modifies the property value type.

Parameters:
zType The new type.
Exceptions:
None 

Definition at line 230 of file Property.h.

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

Modifies the property value units.

Parameters:
zUnits The new units.
Exceptions:
None 

Definition at line 256 of file Property.h.

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

Modifies the property value.

Parameters:
zValue The new value.
Exceptions:
None 

Definition at line 178 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 217 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 243 of file Property.h.

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

Returns the property value.

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

Definition at line 165 of file Property.h.


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