InteractiveInterfaces Interface CATISelectionSet
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISelectionSet
Interface to manage the elements of a Selection Set.
Role: A Selection Set is created, found and deleted with .
A Selection Set contains elements (
). An element is a feature or a sub-element (face, edge, vertex, ...) and is refered by a CATPathElement.
Method Index
- o
AddElement(CATPathElement*,CATISelectionSetElement*&,int)
- Adds a new element.
- o
FindElement(CATPathElement*,CATISelectionSetElement*&)
- Finds an element in the Selection Set.
- o
GetElementPath(CATISelectionSetElement*&,CATPathElement*&)
- Computes the CATPathElement of the Selection Set element.
- o
GetSize()
- Returns the count of elements in the Selection Set.
- o
IsMember(CATPathElement*)
- Returns a status about the presence of the element in the Selection Set.
- o
IsMember(CATISelectionSetElement*)
- Returns a status about the presence of the Selection Set element in the Selection Set.
- o
ListElement(CATListOfCATISelectionSetElement_var*&)
- Retrieves the list of elements.
- o
RemoveAllElements()
- Removes all elements.
- o
RemoveElement(CATISelectionSetElement*)
- Removes an element.
Methods
o AddElement
| public virtual AddElement( | const | iElementPath, |
| | oSetElement, |
| | iCheckUnicity | =1) |
-
Adds a new element.
- Parameters:
-
- iElementPath
- The path of the Element to be added.
- oSetElement
- The created element, release is needed.
- iCheckUnicity
-
Legal values:
- 1 to check if the element is already present in set
- 0 not to check if the element is already present in set
- Returns:
- The error code of function :
- S_OK if the element is added
- E_FAIL if the element is not added
o FindElement
| public virtual FindElement( | const | iElementPath, |
| | oSetElement) |
-
Finds an element in the Selection Set.
- Parameters:
-
- iElementPath
- The path of the element to look for.
- oSetElement
- The Selection Set element corresponding to the path in the Selection Set.
- Returns:
- The error code of function :
- S_OK if the element is found
- E_FAIL if the element is not found
o GetElementPath
| public virtual GetElementPath( | const | iSetElement, |
| | oElementPath) |
-
Computes the CATPathElement of the Selection Set element.
- Parameters:
-
- oSetElement
- The element in the current Selection Set.
- oElementPath
- The path of the Selection Set element.
- Returns:
- The error code of function.
- S_OK if the path is computed
- E_FAIL if the path is not computed
o GetSize
-
Returns the count of elements in the Selection Set.
- Returns:
- The size of the set.
o IsMember
| public virtual IsMember( | const | iElementPath) |
-
Returns a status about the presence of the element in the Selection Set.
- Parameters:
-
- iElementPath
- The path of the element to look for.
- Returns:
- The status
Legal values:
- 1 if the Selection Set element is already present in the Selection Set
- 0 the Selection Set element is not present in the Selection Set
o IsMember
| public virtual IsMember( | const | iSetElement) |
-
Returns a status about the presence of the Selection Set element in the Selection Set.
- Parameters:
-
- iSetElement
- The Selection Set element to look for.
- Returns:
- The status
Legal values:
- 1 if the Selection Set element is already present in the Selection Set
- 0 the Selection Set element is not present in the Selection Set
o ListElement
| public virtual ListElement( | | oListOfSetElement) |
-
Retrieves the list of elements.
- Parameters:
-
- oListOfSetElement
- The list of elements
- Returns:
- The error code of function :
- S_OK if the method succeeded
- E_FAIL if an error occured
o RemoveAllElements
| public virtual RemoveAllElements( | ) |
-
Removes all elements.
- Returns:
- The error code of function :
- S_OK if all the elements are removed
- E_FAIL if all the elements are not removed
o RemoveElement
| public virtual RemoveElement( | const | iSetElement) |
-
Removes an element.
- Parameters:
-
- iSetElement
- The element to remove.
- Returns:
- The error code of function :
- S_OK if the element is removed
- S_FALSE if the element is not removed
This object is included in the file: CATISelectionSet.h
If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.