FeatureModelerExt CATFmFeatureIterator
Usage: you must use this class as is. You should never derive it.
public class CATFmFeatureIterator
Class representing a set of Features.
Role: Iterators are used as output arguments by methods that return a variable number of objects, like the scanning methods.
is an example of such use.
LifeCycle information.
The logical Life Cycle of many objects, such as Features or Containers, is not managed using strong (
,
) reference. Features can be deleted in several ways (for instance using
) no matter how many AddRef'd pointers reference it. Inversly releasing all available pointers to a Feature or a Container does not
induce their logical deletion. They can disappear either by explicit deleteion or because their container (Container, 3D Shape, Technological
Representation...) is unloaded or closed.
Iterators are not intended to take any active part in the logical Life Cycle of the objects they reference.
They however use weak references to ensure safe operation, attempts to access deleted objects will safely fail.
They are consequently not intended to be used as class member data.
Constructor and Destructor Index
- o
CATFmFeatureIterator()
- Constructs an empty Feature Iterator.
- o
CATFmFeatureIterator(CATFmFeatureIterator&)
- Copy constructor.
- o
~CATFmFeatureIterator()
- Destructor.
Method Index
- o
Next(CATFmFeatureFacade&)
- Iterates to the next Feature.
- o
Next(CATFmAttributeValue&)
- Iterates to the next Feature.
- o
operator=(CATFmFeatureIterator&)
- Assignment operator.
Constructor and Destructor
o CATFmFeatureIterator
| public CATFmFeatureIterator( | ) |
-
Constructs an empty Feature Iterator.
Role: Creates an iterator that will be used as an output argument of a method.
- See also:
- ,
o CATFmFeatureIterator
| public CATFmFeatureIterator( | const | iIterator) |
-
Copy constructor.
Role: This method creates an exact copy of a Feature Iterator.
- Parameters:
-
- iIterator
- [in] The Iterator to copy.
o ~CATFmFeatureIterator
| public ~CATFmFeatureIterator( | ) |
-
Destructor.
Methods
o Next
-
Iterates to the next Feature.
- Parameters:
-
- oFeature
- [out] A (caller provided) Facade that will contain the next Feature.
Notice that the Credentials of the provided Facade will not be used nor be modified.
If the method fails oFeature is not modified, it is otherwise overwritten with the retrieved value.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The Facade is now bound to next Feature.
- E_FAIL
- The iteration is over.
o Next
-
Iterates to the next Feature.
- Parameters:
-
- oFeature
- [out] A (caller provided) value that will contain the next Feature.
If the method fails oFeature is not modified, it is otherwise overwritten with the retrieved value.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The Facade is now bound to next Feature.
- E_FAIL
- The iteration is over.
o operator=
| public operator=( | const | iIterator) |
-
Assignment operator.
Role: This method transforms this Iterator to an exact copy of another Feature Iterator.
- Parameters:
-
- iIterator
- [in] The Iterator to copy.
This object is included in the file: CATFmFeatureIterator.h
If needed, your Imakefile.mk should include the module: FeatureModelerExt
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.