All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATAnalysisInterfaces Interface CATISamGroup
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATISamGroup
Usage: you can reimplement this interface by deriving the supplied CATEAnalysisGroup adapter class.
interface CATISamGroup
Provides methods to manipulate groups of finite element entities.
This interface provides simple methods for Grouping (nodes, edge, face, element) behaviour.
BOA information: this interface can be implemented
using the BOA (Basic Object Adapter).
To know more about the BOA, refer to the CAA Encyclopedia home page.
Click Middleware at the bottom left, then click the Object Modeler tab page.
Several articles deal with the BOA.
Method Index
- o
GetContent(CATSamValue,CATString,CATAnalysisEntityCollector*&)
- Gets a collection of objects defined by a particular category and position.
- o
GetGroupAvailableContents(int&,CATSamValue*&)
- Retrieves the list of the different contents of the group defined by their category.
- o
GetGroupAvailablePositions(CATSamValue,int&,CATString*&)
- Retrieves the list of the different contents of the group defined by their category and position.
- o
GetGroupType(CATSamGroupType&)
- Retrieves the type of the Group.
- o
IsGroupOf(CATSamValue,CATString,CATBoolean&)
- Tests if the group can return a collection of objects defined by a particular category and position.
- o
Update()
- Allows to update internal data.
Methods
o GetContent
-
Gets a collection of objects defined by a particular category and position.
- Parameters:
-
- iContent
- The category of the content.
- iPosition
- The position of the content.
- oCollector
- [out , CATBaseUnknown#Release] The entity collector
- See also:
- CATAnalysisEntityCollector
o GetGroupAvailableContents
public virtual HRESULT GetGroupAvailableContents( | int& | oNumber, |
| const CATSamValue*& | oContents) const = 0 |
-
Retrieves the list of the different contents of the group defined by their category.
- Parameters:
-
- oNumber
- The number of different categories.
- oContents[oNumber]
- A pointer to the table of categories.
o GetGroupAvailablePositions
-
Retrieves the list of the different contents of the group defined by their category and position.
- Parameters:
-
- iContent
- The category for which we are looking for different available positions.0
- oNumber
- The number of different positions.
- oPositions[oNumber]
- A pointer to the table of positions.
o GetGroupType
-
Retrieves the type of the Group.
- Parameters:
-
- oType
- The type of the Group. CATSamGroupTypeImplicit
CATSamGroupTypeSpecified
CATSamGroupTypeFiltered
CATSamGroupTypeFree
CATSamGroupTypeAssembly
CATSamGroupTypeCombined
o IsGroupOf
-
Tests if the group can return a collection of objects defined by a particular category and position.
- Parameters:
-
- iContent
- The category of the content.
- iPosition
- The position of the content.
- oRes
-
Legal values:
- TRUE if the group can return objects.
- FALSE otherwise.
o Update
-
Allows to update internal data.
This object is included in the file: CATISamGroup.h
If needed, your Imakefile.mk should include the module: CATAnalysisInterface