FeatureModelerExt CATFmPointingFeatureIterator

Usage: you must use this class as is. You should never derive it.

public class CATFmPointingFeatureIterator

Class representing a set of (Feature + Attribute Name) couples.
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 CATFmPointingFeatureIterator()

Constructs an empty (Feature + Attribute Name) Iterator.

o CATFmPointingFeatureIterator(CATFmPointingFeatureIterator&)

Copy constructor.

o ~CATFmPointingFeatureIterator()

Destructor.

Method Index

o GetCurrentPointingAttributeName(CATFmAttributeName&)

Retrieves the Attribute Name of the current (Feature + Attribute Name) couple.

o Next(CATFmFeatureFacade&)

Iterates to the next (Feature + Attribute Name) couple.

o Next(CATFmAttributeValue&)

Iterates to the next Feature.

o operator=(CATFmPointingFeatureIterator&)

Assignment operator.

Constructor and Destructor

Constructs an empty (Feature + Attribute Name) Iterator.
Role: Creates an iterator that will be used as an output argument of a method.

See also:

Copy constructor.
Role: This method creates an exact copy of a (Feature + Attribute Name) Iterator.

Parameters:

iIterator

[in] The Iterator to copy.

Destructor.

Methods

Retrieves the Attribute Name of the current (Feature + Attribute Name) couple.

Parameters:

oPointingAttribute

[out] A (caller provided) AttributeName object that will contain the Attribute Name.
If the method fails oPointingAttribute is not modified, it is otherwise overwritten with the retrieved value.

Returns:

An HRESULT value.
Legal values:

S_OK

The Attribute Name has been retrieved.

E_ACCESSDENIED

Credentials did not grant sufficient access to the current pointing Feature.

E_FAIL

The iteration is over.

Iterates to the next (Feature + Attribute Name) couple.

Parameters:

oFeature

[out] A (caller provided) Facade that will contain the Feature of the next (Feature + Attribute Name) couple.
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.

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.

Assignment operator.
Role: This method transforms this Iterator to an exact copy of another (Feature + Attribute Name) Iterator.

Parameters:

iIterator

[in] The Iterator to copy.

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.