All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisBase Class CATAnalysisExplicitModel

CATAnalysisExplicitModel
 

Usage: you must use this class as is. You should never derive it.


public class CATAnalysisExplicitModel

Field Model management.
This object provides the framework which enables a field model to be created and manipulated in memory.
No field model data may exist without a CATAnalysisExplicitModel object. In particular when this object is de-allocated, all the field model information associated to the object is cleared from memory.
It also provides access to the database of rules.


Constructor and Destructor Index


o CATAnalysisExplicitModel(CATAnalysisExplicitModel&)
o CATAnalysisExplicitModel(char*)
o ~CATAnalysisExplicitModel()
Destructor.

Method Index


o Delete(CATSamDataType)
o Delete(CATSamPhysicalType)
Deletes objects in the field model based on their physical type.
o DisplayErrors(CATBoolean)
o DumpStatistics()
Dumps some statistics about the field model.
o DumpStatistics(CATListValCATUnicodeString*)
Dumps some statistics about the field model.
o GetAnalysisSet(CATAnalysisExplicitSet&)
Retrieves the first ANALYSIS set of the field model.
o GetAssemblyManager(CATAnalysisAssemblyManager*&)
Retrieves a pointer to the CATAnalysisAssemblyManager instance.
o GetDocumentModel(CATDocument*)
Retrieves a pointer to the field model corresponding to a document.
o GetElements(CATAnalysisExplicitParent&,CATMSHElement**(&))
o GetExplicitContainer(CATIContainer*&)
Retrieves a pointer to the explicit container to which Topology is linked to.
o GetFemModelSet(CATAnalysisExplicitSet&)
Retrieves the first ANALYSIS_MODEL set under the first ANALYSIS set of the field model.
o GetGlobalRefFrame(CATAnalysisExplicitAxis&)
Get the instance of the entity representing the global referential frame.
o GetLastTag(int&)
Returns the last tag number used during the creation of an object in the field model.
o GetMeshManager()
Retrieves a pointer to the mesh manager to which the field model is linked to.
o GetModelTag()
Returns the Field Model tag number.
o GetNbElements(CATAnalysisExplicitParent&,int&)
o GetNbNodes(CATAnalysisExplicitParent&,int&)
o GetNbVirtualElements(CATAnalysisExplicitParent&,int&)
o GetNbVirtualNodes(CATAnalysisExplicitParent&,int&)
o GetNodes(CATAnalysisExplicitParent&,CATMSHNode**(&))
o GetRulesData()
Retrieves a pointer to the current database of rules.
o GetSet(CATSamPhysicalType,CATAnalysisExplicitParent&,CATAnalysisExplicitSet&)
Returns an explicit set of the given physical type using a reference set or entity.
o GetTopology(CATAnalysisExplicitTopology*&)
Returns the instance of the CATAnalysisExplicitTopology object based on the FEM Model.
o IsGlobalRefFrame(CATAnalysisExplicitParent&)
Check if an Entity is equal to the instance of the entity representing the global referential frame.
o IsUndoMode()
Informs if the Undo mode is activated.
o ResetErrors()
o operator =(CATAnalysisExplicitModel&)
Assignment operator.

Constructor and Destructor


o CATAnalysisExplicitModel
public CATAnalysisExplicitModel( const CATAnalysisExplicitModel& iModel)
Deprecated:
V5R17 Copy constructor.
The new field model will use the same database of rules as the parameter field model but no other information is copied between the models.
o CATAnalysisExplicitModel
public CATAnalysisExplicitModel( const char* iFileName)
Deprecated:
V5R17 Contructor.
Parameters:
iFileName
The file name of the database of rules.
If no path is specified, this file is searched in directories set by the CATReffilesPath environment variable.
o ~CATAnalysisExplicitModel
public virtual ~CATAnalysisExplicitModel()
Destructor.

Methods


o Delete
public HRESULT Delete(CATSamDataType iDataType= CATSamDataTypeLast) const
Deprecated:
V5R17 Should not be used. Deletes objects in the field model based on their data type.
Parameters:
iDataType
The data type which must be deleted.
If equal to CATSamDataTypeLast, then all objects of the field model are deleted.
See also:
CATSamDataType
o Delete
public HRESULT Delete(CATSamPhysicalType iPhysicalType) const
Deletes objects in the field model based on their physical type.
Parameters:
iPhysicalType
The physical type which must be deleted.
o DisplayErrors
public static CATBoolean DisplayErrors(CATBoolean iDisplay= TRUE)
Deprecated:
V5R17 Should not be used. Enables or disables the display of errors. Retrieves the current display status.
Parameters:
iDisplay
If TRUE, then errors are displayed.
o DumpStatistics
public void DumpStatistics()const
Dumps some statistics about the field model.
o DumpStatistics
public void DumpStatistics(CATListValCATUnicodeString* oListOfString) const
Dumps some statistics about the field model.
Parameters:
oListOfString
The List of CATUnicodeString.
o GetAnalysisSet
public HRESULT GetAnalysisSet(CATAnalysisExplicitSet& oAnalysisSet) const
Retrieves the first ANALYSIS set of the field model.
Parameters:
oAnalysisSet
A reference to the ANALYSIS set if one exists.
See also:
CATAnalysisExplicitSet
o GetAssemblyManager
public HRESULT GetAssemblyManager( const CATAnalysisAssemblyManager*& oAssemblyManager) const
Retrieves a pointer to the CATAnalysisAssemblyManager instance.
Parameters:
oAssemblyManager.
The CATAnalysisAssemblyManager instance. An AddRef() is done on the CATAnalysisAssemblyManager before returning the pointer.
See also:
CATAnalysisAssemblyManager
o GetDocumentModel
public static CATAnalysisExplicitModel * GetDocumentModel(CATDocument* iDocument)
Retrieves a pointer to the field model corresponding to a document.
Parameters:
iDocument
A pointer to the document.
See also:
CATDocument
o GetElements
public HRESULT GetElements( const CATAnalysisExplicitParent& iContext,
CATMSHElement**(&) oElements) const
Deprecated:
V5R17 Use CATAnalysisExplicitTopology.GetElements instead. Returns the list of mesh element pointers of a context.
Parameters:
iContext
A reference to the context.
oElements
A pointer to the list of mesh element pointers.
This parameter must be equal to NULL when this method is called.
The memory for the array is allocated by this method but must be de-allocated by the caller.
See also:
CATAnalysisExplicitParent, CATMSHElement
o GetExplicitContainer
public HRESULT GetExplicitContainer( const CATIContainer*& oExplicitContainer) const
Retrieves a pointer to the explicit container to which Topology is linked to.
Parameters:
oExplicitContainer
The Explicit container to which Topology is linked to. An AddRef() is done on the Explicit container before returning the pointer.
See also:
CATIContainer
o GetFemModelSet
public HRESULT GetFemModelSet(CATAnalysisExplicitSet& oFemModelSet) const
Retrieves the first ANALYSIS_MODEL set under the first ANALYSIS set of the field model.
Parameters:
oFemModelSet
A reference to the ANALYSIS_MODEL set if one exists.
See also:
CATAnalysisExplicitSet
o GetGlobalRefFrame
public HRESULT GetGlobalRefFrame(CATAnalysisExplicitAxis& ioGlobalRefFrame) const
Get the instance of the entity representing the global referential frame.
Parameters:
ioGlobalRefFrame
the instance of the entity representing the global referential frame. ** WARNING ** : This instance must never be deleted.
o GetLastTag
public void GetLastTag(int& oTag) const
Returns the last tag number used during the creation of an object in the field model.
Parameters:
oTag
The last tag number.
o GetMeshManager
public CATIMSHMeshManager * GetMeshManager()const
Retrieves a pointer to the mesh manager to which the field model is linked to.
An AddRef()is done on the mesh manager before returning the pointer. You have to release the pointer after use.
Returns:
CATBaseUnknown
See also:
CATIMSHMeshManager
o GetModelTag
public int GetModelTag()const
Returns the Field Model tag number.
o GetNbElements
public HRESULT GetNbElements( const CATAnalysisExplicitParent& iContext,
int& oNbElements) const
Deprecated:
V5R17 Use CATAnalysisExplicitTopology.GetNbElements instead. Returns the number of elements of a context.
Parameters:
iContext
A reference to the context.
oNbElements
The number of elements.
See also:
CATAnalysisExplicitParent
o GetNbNodes
public HRESULT GetNbNodes( const CATAnalysisExplicitParent& iContext,
int& oNbNodes) const
Deprecated:
V5R17 Use CATAnalysisExplicitTopology.GetNbNodes instead. Returns the number of nodes of a context.
Parameters:
iContext
A reference to the context.
oNbNodes
The number of nodes.
See also:
CATAnalysisExplicitParent
o GetNbVirtualElements
public HRESULT GetNbVirtualElements( const CATAnalysisExplicitParent& iContext,
int& oNbVirtualElements) const
Deprecated:
V5R17 Use CATAnalysisExplicitTopology.GetNbVirtualElements instead. Returns the number of Virtual elements of a context.
Parameters:
iContext
A reference to the context.
oNbElements
The number of Virtual elements.
See also:
CATAnalysisExplicitParent
o GetNbVirtualNodes
public HRESULT GetNbVirtualNodes( const CATAnalysisExplicitParent& iContext,
int& oNbVirtualNodes) const
Deprecated:
V5R17 Use CATAnalysisExplicitTopology.GetNbVirtualNodes instead. Returns the number of Virtual nodes of a context.
Parameters:
iContext
A reference to the context.
oNbNodes
The number of Virtual nodes.
See also:
CATAnalysisExplicitParent
o GetNodes
public HRESULT GetNodes( const CATAnalysisExplicitParent& iContext,
CATMSHNode**(&) oNodes) const
Deprecated:
V5R17 Use CATAnalysisExplicitTopology.GetNodes instead. Returns the list of mesh node pointers of a context.
Parameters:
iContext
A reference to the context.
oNodes
A pointer to the list of mesh node pointers.
This parameter must be equal to NULL when this method is called.
The memory for the array is allocated by this method but must be de-allocated by the caller.
See also:
CATAnalysisExplicitParent, CATMSHNode
o GetRulesData
public const CATAnalysisExplicitRulesData * GetRulesData()const
Retrieves a pointer to the current database of rules.
o GetSet
public HRESULT GetSet(CATSamPhysicalType iPhysicalType,
const CATAnalysisExplicitParent& iReference,
CATAnalysisExplicitSet& oSet) const
Returns an explicit set of the given physical type using a reference set or entity.
If the reference is an entity, then its first parent becomes the reference set.
The search always begins by the children of the reference set. If it fails, the first parent of the reference set is taken and the search continues with its children. Similarly if the set is not found in the children list the same process is applied and stop when the set is found or when the reference reaches the parent ANALYSIS_MODEL,
Parameters:
iPhysicalType
The physical type of the set which is being asked for.
iPhysicalType can be ANALYSIS or ANALYSIS_MODEL in which case the search only uses the parent lists.
iReference
The reference set or entity from which the search will begin.
If NULL_exp is provided, then the reference set will be the first ANALYSIS set of the model.
oSet
The set if found, NULL_exp if not.
See also:
CATAnalysisExplicitParent, CATAnalysisExplicitSet
o GetTopology
public HRESULT GetTopology( const CATAnalysisExplicitTopology*& oTopology) const
Returns the instance of the CATAnalysisExplicitTopology object based on the FEM Model. An AddRef() is done on the topology before returning the pointer. You have to release the pointer after use.
Parameters:
oTopology
[out , CATBaseUnknown#Release] A pointer to the CATAnalysisExplicitTopology.
See also:
CATAnalysisExplicitTopology
o IsGlobalRefFrame
public CATBoolean IsGlobalRefFrame( const CATAnalysisExplicitParent& iGlobalRefFrame) const
Check if an Entity is equal to the instance of the entity representing the global referential frame.
Parameters:
iGlobalRefFrame
the instance of the entity to check.
o IsUndoMode
public CATBoolean IsUndoMode()const
Informs if the Undo mode is activated.
o ResetErrors
public static void ResetErrors()
Deprecated:
V5R17 Should not be used. Resets the treatment of errors.
o operator =
public CATAnalysisExplicitModel operator =( const CATAnalysisExplicitModel& iModel)
Assignment operator.
The current model is first totally emptied of all data.
The current field model will use the same database of rules as the parameter field model but no other information is copied between the models.

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

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