All Frameworks Class Hierarchy This Framework Indexes
CATAnalysisInterfaces Interface CATISamAnalysisSupport
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISamAnalysisSupport
Interface to Analysis Support.
Role: Interface designed to manage Analysis Support.
This interfaces is implemented on AnalysisEntity, and some basic components like:
SAMSingleGeomPtr, SAMMultiGeomPtr. It allows to setup, valuate, retrieve and remove the connectors
to the pointed objects.
- See also:
- CATISamAnalysisConnector
Method Index
- o
AddEntity(CATILinkableObject*,CATISpecObject*,CATUnicodeString&)
- Adds an entity to the definition of the Analysis support.
- o
CheckSupport(CATILinkableObject*,CATISpecObject*)
- Check if a support can be added in an entity.
- o
GetAuthorizedSupports(SAM_SupportId&)
- Retrieves the authorized types.
- o
GetAvailableSupport(SAM_SupportId&)
- Retrieves an enumerations combination describing the kind of defined entities.
- o
GetBodyControl(CATBoolean&)
- Retrieves if boundary representations of a MechanicalTool-Body can be selected.
- o
GetConnectorType()
- Retrieves the default connector type.
- o
GetEntitiesNumber(int&)
- Returns the number of bound entities in the support.
- o
GetEntities(CATLISTV(CATBaseUnknown_var)&)
- Retrieves the list of analysis connectors.
- o
GetEntities(CATLISTV(CATBaseUnknown_var)&,IID&)
- Retrieves the entities corresponding to the given interface identifier.
- o
GetMinAndMaxEntitiesNumber(int&,int&)
- Returns the minimum and the maximum numbers of entities needed to have
a consistent definition of the support.
- o
GetUpdateMode(int&)
- Retrieves update behaviour.
- o
RemoveAllSupports()
- Removes all the support defined on an Analysis Entity.
- o
RemoveConnector(CATISamAnalysisConnector*)
- Removes a connector.
- o
RemoveEntity(CATILinkableObject*,CATISpecObject*,CATUnicodeString&)
- Removes an entity from the definition of the Analysis support.
- o
SetAuthorizedSupports(SAM_SupportId,int)
- Setups the authorized types.
- o
SetBodyControl(CATBoolean)
- Sets if boundary representations of a MechanicalTool-Body can be selected.
- o
SetConnectorType(CATUnicodeString&)
- Sets the default connector type.
- o
SetEntities(int,CATLISTV(CATBaseUnknown_var)&)
- Sets the list of analysis connectors.
- o
SetMinAndMaxEntitiesNumber(int,int)
- Setups the minimum and the maximum numbers of entities needed to have
a consistent definition of the support for the startup definition.
- o
SetUpdateMode(int)
- Sets update behaviour.
- o
SwitchEntity(CATILinkableObject*,CATISpecObject*,int&,CATUnicodeString&)
- The given data description can be added if it isn't already bound,
else it is removed from the support, or may be substitute to another
description.
Methods
o AddEntity
| public virtual AddEntity( | const | iLinkable, |
| const | iSpecObject, |
| const | iType | = NULL) |
-
Adds an entity to the definition of the Analysis support.
Both of the parameters can not be null.
Warning! Even if an entity description is added several times, it will be added once.
This entity is described by a couple of data as defined for an analysis connector.
- Parameters:
-
- iLinkable
- CATILinkableObject that identify the object to be pointed.
- iSpecObject
- CATISpecObject that identify the object to be pointed for positionning management and instance/reference management. (Most current use is the CATIProduct Feature object).
- iType
- to be set as "GeometrySmartConnector"
o CheckSupport
| public virtual CheckSupport( | const | iPointed, |
| const | iPositionning) |
-
Check if a support can be added in an entity.
This support is described by a couple of data as defined for an analysis connector.
- Parameters:
-
- iPointed
- CATILinkableObject that identify the object to be pointed.
- iPositionning
- CATISpecObject that identify the object to be pointed for positionning management and instance/reference management. (Most current use is the CATIProduct Feature object).
This method delegated its answer to CATISamSupportFilter is the object is implementing this interface,
else SAM_SupportId of iPointed is checked.
- Returns:
- HRESULT
Legal values:
- S_OK Valid Support./li>
- E_FAIL Otherwise.
o GetAuthorizedSupports
| public virtual GetAuthorizedSupports( | | oType) |
-
Retrieves the authorized types.
These types are defined as a bit mask as defined for the startup definition.
- Parameters:
-
- oType
- The type of support that can be used.
o GetAvailableSupport
| public virtual GetAvailableSupport( | | oType) |
-
Retrieves an enumerations combination describing the kind of defined entities.
- Parameters:
-
- oType
- The type of support that can be used (specific to analysis entities).
o GetBodyControl
| public virtual GetBodyControl( | | oBRepAuthorized) |
-
Retrieves if boundary representations of a MechanicalTool-Body can be selected.
- Parameters:
-
- oBRepAuthorized
-
- TRUE Boundary representations of a MechanicalTool-Body may be selected
- FALSE Boundary representations of a MechanicalTool-Body can't be selected
o GetConnectorType
| public virtual GetConnectorType( | ) |
-
Retrieves the default connector type.
- Returns:
- the connector type.
o GetEntitiesNumber
| public virtual GetEntitiesNumber( | | oEntitiesNumber) |
-
Returns the number of bound entities in the support.
- Parameters:
-
- oEntitiesNumber
- Number of valid support found.
o GetEntities
| public virtual GetEntities( | | oSupport) |
-
Retrieves the list of analysis connectors.
Each connector corresponds to a support entity. It defines the couple of pointed data.
No controle is done on the validity of the connector. It can be empty.
- Parameters:
-
- oSupport
- Collection of AnalysisConnector.
o GetEntities
| public virtual GetEntities( | | oSupport, |
| const | iid) |
-
Retrieves the entities corresponding to the given interface identifier.
The returned list is supposed to contain connectors that can be valuable
as connectors.
Each connector corresponds to a support entity. It binds the defining
couple of data.
o GetMinAndMaxEntitiesNumber
| public virtual GetMinAndMaxEntitiesNumber( | | oMinNumber, |
| | oMaxNumber) |
-
Returns the minimum and the maximum numbers of entities needed to have
a consistent definition of the support.
If oMinNumber is less than 0, there is no minimal amount.
If oMaxNumber is less than 0, there is no maximal amount.
- Parameters:
-
- oMinNumber
- Minimal number of connector to define the support.
- oMaxNumber
- Maximal number of connector to define the support.
o GetUpdateMode
| public virtual GetUpdateMode( | | oMode) |
-
Retrieves update behaviour.
- Parameters:
-
- oMode
-
Legal values:
- 1 The analysisEntity or a basic component that selects a BRep
(ex: SAMSingleGeomPtr, SAMMultiGeomPtr) has to be informed
when the BRep (particular pointed object) is modified.
- 0 Otherwise.
o RemoveAllSupports
| public virtual RemoveAllSupports( | ) |
-
Removes all the support defined on an Analysis Entity.
o RemoveConnector
| public virtual RemoveConnector( | const | ipiConnector) |
-
Removes a connector.
- Parameters:
-
- ipiConnector
- The connector to remove.
o RemoveEntity
| public virtual RemoveEntity( | const | iSupport, |
| const | iSpecObject, |
| const | iType | = NULL) |
-
Removes an entity from the definition of the Analysis support.
This entity is described by a couple of data as defined for an analysis connector.
- Parameters:
-
- iLinkable
- CATILinkableObject that identify the object to be pointed.
- iSpecObject
- CATISpecObject that identify the object to be pointed for positionning management and instance/reference management. (Most current use is the CATIProduct Feature object).
- iType
- to be set as "GeometrySmartConnector"
o SetAuthorizedSupports
| public virtual SetAuthorizedSupports( | | iType, |
| | iAdd | =0) |
-
Setups the authorized types.
These types are defined as a bit mask defined in CATSamDefs for the startup definition.
- Parameters:
-
- iType
- The type of support that can be used.
- iAdd
- Addition mode:
Legal values:
- 0: SupportId is replaced.
- 1: SupportId is added.
o SetBodyControl
| public virtual SetBodyControl( | | iBRepAuthorized) |
-
Sets if boundary representations of a MechanicalTool-Body can be selected.
This method must be used on a
- Parameters:
-
- iBRepAuthorized
-
- TRUE Boundary representations of a MechanicalTool-Body may be selected
- FALSE Boundary representations of a MechanicalTool-Body can't be selected
o SetConnectorType
| public virtual SetConnectorType( | const | iType) |
-
Sets the default connector type.
- Parameters:
-
- iType
- the connector type.
Default value:
- If not specified a GeometrySmartConnector will be created.
- If specified a connector build by derivation of GeometrySmartConnector is required.
Note that this method must be used on startup and not on feature instance.
o SetEntities
| public virtual SetEntities( | | iRemove, |
| const | iSupport) |
-
Sets the list of analysis connectors.
This methode is dedicated for support definition at the level of a startup. For this,
use the
CATISamAnalysisModelFactory.CreateConnector and put the returned connector in the iSupport List. Each connector corresponds to a support entity.
It defines the couple of pointed data.
No controle is done on the validity of the connector. It can be empty.
- Parameters:
-
- iRemove
- Empty the list or set up at the end.
Legal values:
- 1 Existing connectors will be removed.
- 2 New connectors will be added to existing one.
- iSupport
- Collection of AnalysisConnector.
o SetMinAndMaxEntitiesNumber
| public virtual SetMinAndMaxEntitiesNumber( | | iMinNumber, |
| | iMaxNumber) |
-
Setups the minimum and the maximum numbers of entities needed to have
a consistent definition of the support for the startup definition.
If iMinNumber is less than 0, there is no minimal amount.
If iMaxNumber is less than 0, there is no maximal amount.
- Parameters:
-
- oMinNumber
- Minimal number of connector to define the support.
- oMaxNumber
- Maximal number of connector to define the support.
o SetUpdateMode
| public virtual SetUpdateMode( | | iMode) |
-
Sets update behaviour.
- Parameters:
-
- iMode
-
Legal values:
- 1 The analysisEntity or a basic component that selects a BRep
(ex: SAMSingleGeomPtr, SAMMultiGeomPtr) has to be informed
when the BRep (particular pointed object) is modified.
- 0 Otherwise.
o SwitchEntity
| public virtual SwitchEntity( | const | iLinkable, |
| const | iSpecObject, |
| | oModifStatus, |
| const | iType | = NULL) |
-
The given data description can be added if it isn't already bound,
else it is removed from the support, or may be substitute to another
description.
This entity is described by a couple of data as defined for an analysis connector.
- Parameters:
-
- iLinkable
- CATILinkableObject that identify the object to be pointed.
- iSpecObject
- CATISpecObject that identify the object to be pointed for positionning management and instance/reference management. (Most current use is the CATIProduct Feature object).
- oModifStatus:
- A flag that defines how the new entity has been switched in the support:
Legal values:
- 0: It has been REMOVED because it was already in the support.
- 1: It has been ADDED because it wasn't in the support yet.
- 2: It has been SUBSTITUTEED to another data of the same kind.
- iType:
- define the type of analysis connector used to bind given data.
To be set as"GeometrySmartConnector"
This object is included in the file: CATISamAnalysisSupport.h
If needed, your Imakefile.mk should include the module: CATAnalysisInterface