All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Class CATSamCatalogFactory

CATSamCatalogFactory
 

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


public class CATSamCatalogFactory

Global Services to create feature that derive from Analysis Types.


Method Index


o CreateAnalysisEntity(CATUnicodeString*,CATUnicodeString*,CATBaseUnknown**,CATICatalog**,CATBoolean,CATBoolean)
Global service for "AnalysisEntity" startup creation.
o CreateAnalysisSet(CATUnicodeString*,CATUnicodeString*,CATBaseUnknown**,CATICatalog**,CATBoolean,CATBoolean)
Global service for "AnalysisSet" startup creation.
o CreateBasicComponent(CATUnicodeString*,CATUnicodeString*,CATBaseUnknown**,CATICatalog**,CATBoolean,CATBoolean)
Global service for "BasicComponent" startup creation.
o CreateMSHPart(CATUnicodeString*,CATBaseUnknown**,CATICatalog**,CATBoolean,CATBoolean)
Global service for "MSHPart" startup creation.
o SetBasicComponent(CATUnicodeString*,CATBaseUnknown*,CATICatalog**,CATBaseUnknown*)
Global service to associate a "BasicComponent" to another or to an Analysis entity.
o SetDataType(CATBaseUnknown*,CATUnicodeString*)
Global service to define a data type on a startup on anay type.
o SetLabels(CATBaseUnknown*,int,CATUnicodeString*)
Global service to define a the Labels values on a startup of basic component.
o SetPhysicalType(CATBaseUnknown*,CATUnicodeString*)
Global service to define a physical type on a startup on anay type.
o SetValuesDim(CATBaseUnknown*,int,int*)
Global service to define a the dimension values on a startup of basic component.
o UpgradeForBackup(CATICatalog**,int)
Global service to set up a backup startup in a CATfct.

Methods


o CreateAnalysisEntity
public static HRESULT CreateAnalysisEntity( const CATUnicodeString* iTypeName,
const CATUnicodeString* iSubType,
CATBaseUnknown** oStartUp,
CATICatalog** piCatalog,
CATBoolean iPublic=FALSE,
CATBoolean iDerivable=FALSE)
Global service for "AnalysisEntity" startup creation.
Note : These methods allow to derive the AnalysisEntity startup and store the derived one in a client catalog that can be accessed via the "CATICatalog" interface
Parameters:
iTypeName
The type of the created startup.
iSubType
The type of the startup of Analysis Entity to derive.
Legal values:
  • NULL : to derive directely a Analysis Entity.
  • Late Type of an existing Analysis Entity to create a new derivation of kind of entity.
    For example "AnalysisProperty"
oStartUp
The created startup.
piCatalog
Catalog to store the created startup.
iPublic
Set-up the created startup as Public.
iDerivable
Set-up the created startup as Derivable.
Returns:
S_OK if the startup is created. E_FAIL in other cases
o CreateAnalysisSet
public static HRESULT CreateAnalysisSet( const CATUnicodeString* iTypeName,
const CATUnicodeString* iSubType,
CATBaseUnknown** oStartUp,
CATICatalog** piCatalog,
CATBoolean iPublic=FALSE,
CATBoolean iDerivable=FALSE)
Global service for "AnalysisSet" startup creation.
Note : These methods allow to derive the Analysis Set startup and store the derived one in a client catalog that can be accessed via the "CATICatalog" interface
Parameters:
iTypeName
The type of the created startup.
iSubType
The type of the startup of Analysis Set to derive.
Legal values:
  • NULL : to derive directely a Analysis Set.
  • SolutionSet to create a new type of Solution Set.
  • Late Type of an existing Analysis Set to create a new derivation of kind of set.
    For example "Restraint Set"
oStartUp
The created startup.
piCatalog
Catalog to store the created startup.
iPublic
Set-up the created startup as Public.
iDerivable
Set-up the created startup as Derivable.
Returns:
S_OK if the startup is created. E_FAIL in other cases
See also:
CATICatalog
o CreateBasicComponent
public static HRESULT CreateBasicComponent( const CATUnicodeString* iTypeName,
const CATUnicodeString* iSubType,
CATBaseUnknown** oStartUp,
CATICatalog** piCatalog,
CATBoolean iPublic=FALSE,
CATBoolean iDerivable=FALSE)
Global service for "BasicComponent" startup creation.
Note : These methods allow to define a BasicComponent startup and store the derived one in a client catalog that can be accessed via the "CATICatalog" interface
Parameters:
iTypeName
The type of the created startup.
iSubType
The type of the startup of BasicComponent to create.
Legal values:
  • NULL to derive directely a Basic Component
  • SAM3DVector to create a new type of 3DVector
  • SAMTensor to create a new type of Tensor
oStartUp
The created startup
piCatalog
Catalog to store the created startup.
iPublic
Set-up the created startup as Public.
iDerivable
Set-up the created startup as Derivable.
Returns:
S_OK if the startup is created. E_FAIL in other cases
o CreateMSHPart
public static HRESULT CreateMSHPart( const CATUnicodeString* iTypeName,
CATBaseUnknown** oStartUp,
CATICatalog** piCatalog,
CATBoolean iPublic=FALSE,
CATBoolean iDerivable=FALSE)
Global service for "MSHPart" startup creation.
Note : These methods allow to derive the MSHPart startup and store the derived one in a client catalog that can be accessed via the "CATICatalog" interface
Parameters:
iTypeName
The type of the created startup.
oStartUp
The created startup.
piCatalog
Catalog to store the created startup.
iPublic
Set-up the created startup as Public.
iDerivable
Set-up the created startup as Derivable.
Returns:
S_OK if the startup is created. E_FAIL in other cases
o SetBasicComponent
public static HRESULT SetBasicComponent( const CATUnicodeString* iTypeName,
CATBaseUnknown* piStartUp,
CATICatalog** piCatalog,
CATBaseUnknown* piBasicComponent=NULL)
Global service to associate a "BasicComponent" to another or to an Analysis entity.
Parameters:
iTypeName
The type of the startup of BasicComponent to retrieve.
piStartUp
The Startup in which the association will be done.
piCatalog
Catalog to store the created startup.
piBasicComponent
If the Pointer of the basic component is known (For example if it is created
by using the
CATICkeParmFactory.CreateDimension method, set iTypeName to NULL and use the pointer.
Returns:
S_OK if the startup is created. E_FAIL in other cases
o SetDataType
public static HRESULT SetDataType(CATBaseUnknown* piStartUp,
const CATUnicodeString* iType)
Global service to define a data type on a startup on anay type.
Parameters:
piStartUp
The Startup.
iType
The string of the data type.
o SetLabels
public static HRESULT SetLabels(CATBaseUnknown* piStartUp,
int Nb,
const CATUnicodeString* iLabels)
Global service to define a the Labels values on a startup of basic component.
Parameters:
piStartUp
The Startup.
iLabels
The array that defines the labels identifiers.
o SetPhysicalType
public static HRESULT SetPhysicalType(CATBaseUnknown* piStartUp,
const CATUnicodeString* iType)
Global service to define a physical type on a startup on anay type.
Parameters:
piStartUp
The Startup.
iType
The string of the physical type.
o SetValuesDim
public static HRESULT SetValuesDim(CATBaseUnknown* piStartUp,
int Nb,
const int* iValueDim)
Global service to define a the dimension values on a startup of basic component.
Parameters:
piStartUp
The Startup.
iValueDim
The array that defines the dimension values.
o UpgradeForBackup
public static HRESULT UpgradeForBackup(CATICatalog** piCatalog,
int iMode)
Global service to set up a backup startup in a CATfct.
Parameters:
piCatalog
Catalog to upgrade.
iMode
Check or Upgrade.
Legal values:
  • 1Check only.
  • 2 Check and upgrade.
Returns:
HRESULT
Legal values:
  • S_OK The catalog needs to be saved.
  • S_FALSE The catalog doesn't need to be saved.
  • E_* Internal Error.

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

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