DWFToolkit::OPCPartContainer Class Reference

#include "dwf/opc/PartContainer.h"

Inheritance diagram for DWFToolkit::OPCPartContainer:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

A OPCPartContainer stores and manages the life time of package parts.

Since:
7.4.0
A OPCPartContainer stores and manages the life time of package parts.

Definition at line 48 of file PartContainer.h.

Public Member Functions

_DWFTK_API OPCPartContainer () throw ()
virtual _DWFTK_API ~OPCPartContainer () throw ()
_DWFTK_API void addPart (OPCPart *pPart, bool bOwn=false) throw ()
_DWFTK_API bool insertPart (OPCPart *pPart, OPCPart *pAfterPart, bool bOwn=false) throw ()
_DWFTK_API bool removePart (OPCPart *pPart, bool bOwnerDelete=true) throw ()


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::OPCPartContainer::OPCPartContainer  )  throw ()
 

Constructor

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

Destructor


Member Function Documentation

_DWFTK_API void DWFToolkit::OPCPartContainer::addPart OPCPart pPart,
bool  bOwn = false
throw ()
 

Add the externally created part to the part container. The part container will take ownership of the part and manage it's lifetime.

Parameters:
pPart The new part being added to the container.
bOwn Does the Container own this object.
Exceptions:
None 

_DWFTK_API bool DWFToolkit::OPCPartContainer::insertPart OPCPart pPart,
OPCPart pAfterPart,
bool  bOwn = false
throw ()
 

Add the part to the part container, such that it is located after pAfterPart. The part container will take ownership of the part and manage it's lifetime. If pAfterPart is NULL then the part will be added at the beginning. If pAfterPart is non-null and is not found the new part will not be added and the call will return false.

Parameters:
pPart The new part being added to the container.
pAfterPart The part after which the new part will be added. If this is NULL the new part will be added to the beginning of the list.
bOwn Does the Container own this object.
Returns:
True if the part was added to the container, false otherwise.
Exceptions:
None 

_DWFTK_API bool DWFToolkit::OPCPartContainer::removePart OPCPart pPart,
bool  bOwnerDelete = true
throw ()
 

Remove a part from the container. If the container is the owner of the part by default it will be deleted.

Parameters:
pPart The part being removed from the container.
bOwnerDelete If true, the removed part will be deleted if this is the owner of the part. If the container is not the owner, this flag is ignored.
Returns:
True if the part was found and removed from the container, false otherwise.
Exceptions:
None 


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