All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamAnalysisSet

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATISamAnalysisSet
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATISamAnalysisSet

Interface to manage the Analysis Sets.
Role: Interface designed to manage Analysis Set behavior.

In the Analysis Model, an Analysis Set is the data dedicated to manage the Analysis Entities.

Also, it provides some services dedicated to Analysis links between sets. It also provides scan services about those links.

See also:
SAM_ScanCriterium, SAM_Status, CATISamAnalysisEntity


Method Index


o AddAnalysisEntity(CATISpecObject_var&,SAM_Quality,CATBoolean)
Appends an analysis entity to the current Analysis Set.
o AddBasicComponent(CATUnicodeString&,CATUnicodeString&,CATBaseUnknown_var&)
Adds an optional Basic component to an AnalysisEntity.
o AddNeutralFeature(CATISpecObject_var&)
Appends a feature to this Analysis Set.
o AddOutputFeature(CATISpecObject_var&,CATBoolean)
Appends a feature to this Analysis Set.
o AddSons(CATLISTV(CATISamAnalysisSet_var)&,int)
Adds childrens to Set.
o ConnectTo(CATLISTV(CATISamAnalysisSet_var)&,int)
Links to a list of Sets.
o DeConnectTo(CATLISTV(CATISamAnalysisSet_var)&,int)
Removes links to a list of Sets.
o GetAllDatas(CATLISTV(CATISpecObject_var)&,IID&,SAM_Quality)
Retrieves all the entities responding to a given interface.
o GetAnalysisManager(CATISamAnalysisManager*&)
Retrieves the Analysis Manager of the Model.
o GetBasicComponents(CATLISTV(CATBaseUnknown_var)*&,CATUnicodeString&)
Retrieves the list of basic components corresponding to a given type.
o GetConnected(CATLISTV(CATISamAnalysisSet_var)&,int)
Retrieves the list of linked Sets.
o GetFEMModel(CATISamAnalysisModel*&)
Retrieves the FEM Model in which the set is included.
o GetFatherCases(CATLISTV(CATBaseUnknown_var)*&)
Retrieves the list of analysis cases that reference the analysis set.
o GetNamedBasicComponent(CATUnicodeString&,CATISamBasicComponent_var&)
Retrieves the basic component corresponding to a given name.
o GetNamedEntity(CATUnicodeString&,CATISpecObject_var&,SAM_Quality)
Retrieves analysis entity with a given name.
o GetSons(CATLISTV(CATISamAnalysisSet_var)&,int)
Retrieves the children list of a Set.
o GetStatus()
Returns the status of the Analysis Set.
o GetTypedEntity(CATUnicodeString&,CATLISTV(CATISpecObject_var)&,SAM_Quality)
Retrieves analysis entity with a given type.
o Initialize()
Initializes the analysis set.
o IsReadOnly()
Returns the rights on this analysis set.
o ListNeutralFeatures(CATLISTV(CATISpecObject_var)&,IID&)
Retrieves all the Neutral Feature's responding to a given interface.
o ListOutputFeature(CATLISTV(CATISpecObject_var)&,IID&)
Retrieves all the Output Feature's responding to a given interface.
o RemoveAllNeutralFeatures(IID&)
Removes all the Neutral Feature's responding to a given interface.
o RemoveAnalysisEntity(CATISpecObject_var&,SAM_Quality)
Removes an analysis entity from the current Analysis Set.
o RemoveBasicComponent(CATUnicodeString&)
Removes an optional Basic componentto an AnalysisEntity.
o RemoveNeutralFeature(CATISpecObject_var&)
Removes a feature to this Analysis Set.
o RemoveOutputFeature(CATISpecObject_var&)
Removes a feature to this Analysis Set.
o Scan(CATLISTV(CATISamAnalysisSet_var)&,SAM_ScanCriterium,CATUnicodeString&,CATUnicodeString&,int,int,int)
Scan service for sets links according to name and type.
o SetReadOnly(CATBoolean)
Sets the rights on this analysis set.
o SetStatus(SAM_Status)
Sets the status of the Analysis Set.

Methods


o AddAnalysisEntity
public virtual HRESULT AddAnalysisEntity( const CATISpecObject_var& iEntity,
SAM_Quality iQuality= Sam_IN,
CATBoolean iAddInverseLink= FALSE )= 0
Appends an analysis entity to the current Analysis Set.
Parameters:
iEntity
The feature to be added.
iQuality
The quality of the entity.
Legal values:
  • Sam_IN To Plug the entity as input of the set.
  • Sam_OUT To Plug the entity as output of the set..
Default Value is Sam_IN.
iAddInverseLink.
If iQuality == Sam_OUT, sets the set as input of the entity. This mechanism allows to flag the entity not uptodate if the set is modified.
o AddBasicComponent
public virtual HRESULT AddBasicComponent( const CATUnicodeString& iBCName,
const CATUnicodeString& iLiteralName=NULL,
const CATBaseUnknown_var& iType= NULL_var )const = 0
Adds an optional Basic component to an AnalysisEntity. Returns the identifiers of the optional basic components
Parameters:
iBCName
: List of Basic Components name, this is name of instance.
iLiteralName:
List of Basic Components name, this is name of startup.
iType
: Used only in the case of Literal features. CATICkeType of the literal to derive.
For Example, use static CATICkeType_var MyLength = CATIParmDictionary::LengthType to create a length dimension.
See also:
CATIParmDictionary
iType
o AddNeutralFeature
public virtual HRESULT AddNeutralFeature( const CATISpecObject_var& iFeature) = 0
Appends a feature to this Analysis Set. This feature will be aggregated as an neutral of the set.
Note:
Parameters:
iFeature
The feature to be added.
o AddOutputFeature
public virtual HRESULT AddOutputFeature( const CATISpecObject_var& iFeature,
CATBoolean iWithFieldModel=FALSE) = 0
Appends a feature to this Analysis Set. This feature will be aggregated as an output of the set.
Note:
Parameters:
iFeature
The feature to be added.
iWithFieldModel
Defines if a Field model Structure needs to be managed. Legal values: TRUE The Field model object associated to iFeature is created. For this the iFeature needs to have a Physical type. FALSE No Field model structure will be created.
o AddSons
public virtual HRESULT AddSons(CATLISTV(CATISamAnalysisSet_var)& iSons,
int ToPlug= 1) = 0
Adds childrens to Set.
Note:
Parameters:
iSons
Collection of Set to be connected
ToPlug
Connection mode
o ConnectTo
public virtual HRESULT ConnectTo(CATLISTV(CATISamAnalysisSet_var)& iLinks,
int ToPlug= 1) = 0
Links to a list of Sets.
Note:
Parameters:
iLinks
The collection of Set to be connected
ToPlug
The connection mode
o DeConnectTo
public virtual HRESULT DeConnectTo(CATLISTV(CATISamAnalysisSet_var)& iLinks,
int ToPlug= 1) = 0
Removes links to a list of Sets.
Parameters:
iLinks
The Collection of Set to be deconnected.
ToPlug
The connection mode.
Legal values:
  • 0
  • : upward.
  • 2
  • : downward.
o GetAllDatas
public virtual HRESULT GetAllDatas(CATLISTV(CATISpecObject_var)& oEntitiesList,
const IID& iIntfIID,
SAM_Quality iQuality= Sam_IN) const = 0
Retrieves all the entities responding to a given interface.
Parameters:
oEntitiesList
The collection of entities found.
iIntfIID
identifier of the interface filtering the kind of objects to find.
iQuality
The quality of the entity. Default Value is Sam_IN.
o GetAnalysisManager
public virtual HRESULT GetAnalysisManager(CATISamAnalysisManager*& oAnalysisManager) const = 0
Retrieves the Analysis Manager of the Model.
Parameters:
oAnalysisManager
[out , CATBaseUnknown#Release] The Analysis Manager of the Model.
o GetBasicComponents
public virtual HRESULT GetBasicComponents(CATLISTV(CATBaseUnknown_var)*& oComponents,
const CATUnicodeString& iType=NULL) const = 0
Retrieves the list of basic components corresponding to a given type. If no type is given, every component is returned. Warning : you have to deal with the list destruction.
Parameters:
oComponents
pointer used to returned the list.
iType
The type of the basic component.
o GetConnected
public virtual HRESULT GetConnected(CATLISTV(CATISamAnalysisSet_var)& oLinks,
int iLevel= -1) = 0
Retrieves the list of linked Sets.
Parameters:
oLinks
Collection of CATISamAnalysisSet_var to be connected
iLevel
Indicates the number of level you want to scan in the hierarchy.
(-1) indicates no limit in the search. It is the default value.
o GetFEMModel
public virtual HRESULT GetFEMModel(CATISamAnalysisModel*& oFEMModel) const = 0
Retrieves the FEM Model in which the set is included. Remember that a set can be a component of a unique FEM Model.
Parameters:
oFEMModel
[out , CATBaseUnknown#Release] The parent FEM Model .
o GetFatherCases
public virtual HRESULT GetFatherCases(CATLISTV(CATBaseUnknown_var)*& oListOfCases) const = 0
Retrieves the list of analysis cases that reference the analysis set. For a set defined inside the analysis model, anlysis model will be returned.
Parameters:
oListOfCases
Collection of analysis cases.
o GetNamedBasicComponent
public virtual HRESULT GetNamedBasicComponent( const CATUnicodeString& iName,
CATISamBasicComponent_var& oComponent) const = 0
Retrieves the basic component corresponding to a given name.
Parameters:
iName
name of the basic components.
oComponents
pointer used to returned the list.
o GetNamedEntity
public virtual HRESULT GetNamedEntity( const CATUnicodeString& iName,
CATISpecObject_var& oEntity,
SAM_Quality iQuality= Sam_IN) const = 0
Retrieves analysis entity with a given name.

Entities have a unique Name in the context of an Analysis Set.

Parameters:
iName
The name used for search.
oEntity
The entity whose name is iName.
iQuality
The quality of the entity. Default Value is Sam_IN.
o GetSons
public virtual HRESULT GetSons(CATLISTV(CATISamAnalysisSet_var)& oSons,
int iLevel= -1) = 0
Retrieves the children list of a Set.
Parameters:
oSons
Collection of children.
iLevel
The number of level you want to scan in the hierarchy.
(-1) indicates no limit in the search. It is the default value.
o GetStatus
public virtual SAM_Status GetStatus()const = 0
Returns the status of the Analysis Set.
o GetTypedEntity
public virtual HRESULT GetTypedEntity( const CATUnicodeString& iType,
CATLISTV(CATISpecObject_var)& oEntitiesList,
SAM_Quality iQuality= Sam_IN) const = 0
Retrieves analysis entity with a given type.
Parameters:
iType
The type used for search.
oEntitiesList
The collection of entities whose type is iType.
iQuality
The quality of the entity. Default Value is Sam_IN.
o Initialize
public virtual HRESULT Initialize()= 0
Initializes the analysis set. This Method is systematically called after the set creation. Do not use.
o IsReadOnly
public virtual CATBoolean IsReadOnly()const = 0
Returns the rights on this analysis set. Legal values: TRUE The analysis set is "locked", No entity can be added or deleted. FALSE The Analysis set can be modified.
o ListNeutralFeatures
public virtual HRESULT ListNeutralFeatures(CATLISTV(CATISpecObject_var)& oEntitiesList,
const IID& iIntfIID) const = 0
Retrieves all the Neutral Feature's responding to a given interface.
Parameters:
oFeatureList
The collection of Feature's found.
iIntfIID
Identifier of the interface filtering the kind of objects to find.
o ListOutputFeature
public virtual HRESULT ListOutputFeature(CATLISTV(CATISpecObject_var)& oEntitiesList,
const IID& iIntfIID) const = 0
Retrieves all the Output Feature's responding to a given interface.
Parameters:
oFeatureList
The collection of Feature's found.
iIntfIID
Identifier of the interface filtering the kind of objects to find.
o RemoveAllNeutralFeatures
public virtual HRESULT RemoveAllNeutralFeatures( const IID& iIntfIID)= 0
Removes all the Neutral Feature's responding to a given interface.
Parameters:
oFeatureList
The collection of Feature's found.
iIntfIID
Identifier of the interface filtering the kind of objects to find.
o RemoveAnalysisEntity
public virtual HRESULT RemoveAnalysisEntity( const CATISpecObject_var& iEntity,
SAM_Quality iQuality= Sam_IN) = 0
Removes an analysis entity from the current Analysis Set. This method will remove the link from an analysis set to an analysis entity. For complete remove of analysis entities, use CATISamAnalysisModel.RemoveAnalysisFeature
Parameters:
iEntity
The feature to be removed.
iQuality
The quality of the entity. Default Value is Sam_IN.
o RemoveBasicComponent
public virtual HRESULT RemoveBasicComponent( const CATUnicodeString& iBcName) const = 0
Removes an optional Basic componentto an AnalysisEntity.
Parameters:
iBCName
the name of the Basic Component to remove.
o RemoveNeutralFeature
public virtual HRESULT RemoveNeutralFeature( const CATISpecObject_var& iFeature) = 0
Removes a feature to this Analysis Set. This feature will be aggregated as an neutral of the set.
Parameters:
iFeature
The feature to be removed.
o RemoveOutputFeature
public virtual HRESULT RemoveOutputFeature( const CATISpecObject_var& iFeature) = 0
Removes a feature to this Analysis Set. This feature was previously added with the AddOutputFeature method.
Parameters:
iFeature
The feature to be removed.
o Scan
public virtual HRESULT Scan(CATLISTV(CATISamAnalysisSet_var)& oLinks,
SAM_ScanCriterium iCriterium,
const CATUnicodeString& iName,
const CATUnicodeString& iType,
int iDirection= 0,
int iPartial= 0,
int iLevel= -1) = 0
Scan service for sets links according to name and type.
Parameters:
oLinks
The collection of CATISamAnalysisSet found regarding the input criteria.
iCriterium
The search criterion with Name, Type or both criterion.
iName
The name you are looking for
iType
The type you are looking for
iDirection
The searching direction
Legal values:
  • 0 : upward.
  • 2 : downward.
iPartial
The ability to search with a substring of the name or the type.
Default value is 0 i.e. you are searching with the whole word
iLevel
The number of levels you want to scan in the hierarchy.
-1 indicates no limit in the search. It is the default value
o SetReadOnly
public virtual void SetReadOnly( const CATBoolean iRights) = 0
Sets the rights on this analysis set.
Parameters:
iRights:
Legal values: TRUE The analysis set is locked, No entity can be added or deleted. FALSE The analysis set can be modified.
o SetStatus
public virtual void SetStatus(SAM_Status iStatus) = 0
Sets the status of the Analysis Set.
Parameters:
iStatus
SAM_Status be modified on the set.

This object is included in the file: CATISamAnalysisSet.h
If needed, your Imakefile.mk should include the module: CATAnalysisInterface

Copyright © 2003, Dassault Systèmes. All rights reserved.