All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamAnalysisModelFactory

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

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


interface CATISamAnalysisModelFactory

Interface to create Analysis Features.
Role: Interface designed to create all kinds of Analysis data.

See also:
CATISamAnalysisEntity, CATISamAnalysisSet, CATISamAnalysisCase


Method Index


o CreateAnalysisCase(CATUnicodeString&)
Creates an Analysis Case.
o CreateAnalysisEntity(CATUnicodeString&,CATUnicodeString&,CATISpecObject*)
Creates an Analysis Entity.
o CreateAnalysisLink(CATString,CATUnicodeString&)
Creates an Analysis Link Feature.
o CreateAnalysisMeasure(CATUnicodeString&,CATCkeListOfParm,CATUnicodeString&,CATISpecObject*)
Creates an Analysis Measure Feature.
o CreateAnalysisSensor(CATUnicodeString&,CATUnicodeString&,CATISpecObject*)
Creates an Analysis Sensor.
o CreateConnector(CATILinkableObject*,CATILinkableObject*,CATUnicodeString&,int)
Creates an Analysis Connector.
o CreateLoadSet(CATUnicodeString&,CATISpecObject*)
Creates a Load Set.
o CreateRestraintSet(CATUnicodeString&,CATISpecObject*)
Creates a Restraint Set.
o CreateUserSet(CATUnicodeString&,CATUnicodeString&,CATISpecObject*)
Creates a User Set.
o DuplicateConnector(CATISamAnalysisConnector*)
Duplicate a CATISamAnalysisConnector feature.

Methods


o CreateAnalysisCase
public virtual CATISamAnalysisCase* CreateAnalysisCase( const CATUnicodeString& iName) = 0
Creates an Analysis Case.
Parameters:
iName
The name of the Analysis Case to be created.
Returns:
CATBaseUnknown#Release The created Analysis Case. @see CATISamAnalysisCase.
o CreateAnalysisEntity
public virtual CATISpecObject* CreateAnalysisEntity( const CATUnicodeString& iName,
const CATUnicodeString& iType,
CATISpecObject* iContainingObject= NULL) = 0
Creates an Analysis Entity.
Parameters:
iName
Name of the Analysis Entity to be created.
iType
Late Type of the Analysis Entity to be created (from a spec object point on view)
iContainingObject
Pointer to the Analysis Model used for creation and that will aggregate the set.
Returns:
CATBaseUnknown#Release The analysis entity created. @see CATISamAnalysisEntity.
o CreateAnalysisLink
public virtual CATISpecObject* CreateAnalysisLink( const CATString iLinkType= "SAMLink",
const CATUnicodeString& iType= "") = 0
Creates an Analysis Link Feature. This Object is designed to create a link to external documents.
Parameters:
iLinkType
string representing the kind of document to be linked.
iType
Late Type Of the feature to create (If NULL_string a SAMFeatureLink will be created).
Returns:
CATBaseUnknown#Release The created analysis link.
o CreateAnalysisMeasure
public virtual CATISpecObject* CreateAnalysisMeasure( const CATUnicodeString& iType,
const CATCkeListOfParm iListOfParameters,
const CATUnicodeString& iBody,
const CATISpecObject* iSensorContainer= NULL) = 0
Creates an Analysis Measure Feature. This Object is designed for Analysis Measures based on parameters defined with Formulas.
Parameters:
iType
string representing the kind of measures to create.
"AnalysisMeasureWithProgram" is the basic late Type, It can be derived or used directly.
iListOfParameters
(pointer on list of CATBaseUnknown_var) contains literal used as inputs or outputs.
iBody
contains the string describing the program.
iSensorContainer
The Sensor set in which the measure will be created.
Returns:
CATBaseUnknown#Release The created measure. This Object implements CATISamSensor interface.
See also:
CATISamSensor
o CreateAnalysisSensor
public virtual CATISpecObject* CreateAnalysisSensor( const CATUnicodeString& iType,
const CATUnicodeString& iIdentifier,
const CATISpecObject* iSensorContainer= NULL) = 0
Creates an Analysis Sensor. This Object is designed for Analysis Measures.
Parameters:
iType
string representing the kind of measures to create.
"AnalysisSensor" is the basic late Type, It can be derived or used directly.
iIdentifier
string representing the name of measures to create.
iSensorContainer
The Sensor set in which the measure will be created.
Returns:
CATBaseUnknown#Release The created measure. This Object implements CATISamSensor interface.
See also:
CATISamSensor
o CreateConnector
public virtual CATISamAnalysisConnector* CreateConnector( const CATILinkableObject* iPointedObject,
const CATILinkableObject* iPositionningObject,
const CATUnicodeString& iType= NULL,
int iUpdateMode= 0) = 0
Creates an Analysis Connector.
Parameters:
iPointedObject
CATILinkableObject to be linked.
iPositionningObject
CATILinkableObject for positionning.
iType
CATUnicodeString: "GeometrySmartConnector" may be used.
iUpdateMode
Update Mode
  • iUpdateMode = 0 : default behaviour
  • iUpdateMode = 1 : time stamp is updated if iPointedObject is a BRep
Returns:
CATBaseUnknown#Release The connector created. @see CATISamAnalysisConnector.
o CreateLoadSet
public virtual CATISamAnalysisSet* CreateLoadSet( const CATUnicodeString& iName,
CATISpecObject* iContainingObject= NULL) = 0
Creates a Load Set.
Parameters:
iName
Name of the Load Set to be created.
iContainingObject
Pointer to the Analysis Model used for creation and that will aggregate the set.
Returns:
CATBaseUnknown#Release The load Set created. @see CATISamAnalysisSet.
o CreateRestraintSet
public virtual CATISamAnalysisSet* CreateRestraintSet( const CATUnicodeString& iName,
CATISpecObject* iContainingObject= NULL) = 0
Creates a Restraint Set.
Parameters:
iName
Name of the Restraint Set to be created.
iContainingObject
Pointer to the Analysis Model used for creation and that will aggregate the set.
Returns:
CATBaseUnknown#Release The restraint Set created. @see CATISamAnalysisSet.
o CreateUserSet
public virtual CATISamAnalysisSet* CreateUserSet( const CATUnicodeString& iType,
const CATUnicodeString& iName,
CATISpecObject* iContainingObject= NULL) = 0
Creates a User Set.
Parameters:
iType
Late Type of the User Set to be created (from a spec object point on view)
iName
Name of the User Set to be created.
iContainingObject
Pointer to the Analysis Model used for creation and that will aggregate the set.
Returns:
CATBaseUnknown#Release The user set created. @see CATISamAnalysisSet.
o DuplicateConnector
public virtual CATISamAnalysisConnector* DuplicateConnector( const CATISamAnalysisConnector* iconnector) = 0
Duplicate a CATISamAnalysisConnector feature. Create new connector by duplication. (Same type & same attribute valuation).
Returns:
CATBaseUnknown#Release The created connector.
See also:
CATISamAnalysisConnector

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

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