All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

CATAnalysisBase Class CATSamModelDataServices

CATSamModelDataServices
 

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


public class CATSamModelDataServices

Global Services for Field model objects information.


Method Index


o GetDataCategory(CATSamExplicitPtr,CATSamValue&)
Retrieves the category of a model data.
o GetDataSolverName(CATSamExplicitPtr,char*&)
Retrieves the solver name of a model data.
o GetDataTag(CATSamExplicitPtr,CATLONG32&)
Retrieves the external tag of a model data.
o GetDataType(CATSamExplicitPtr,CATSamDataType&)
Retrieves the data type of a model data.
o GetDataUserName(CATSamExplicitPtr,char*&)
Retrieves the user name of a model data.
o GetDataUserNumber(CATSamExplicitPtr,CATLONG32&)
Retrieves the user number of a model data.
o GetDataValueType(CATSamExplicitPtr,CATSamValue&)
Retrieves the value type of a model data characteristic.
o GetPhysicalType(CATSamExplicitPtr,CATSamPhysicalType&)
Retrieves the physical type of a model data.
o HasRepeatedValues(CATSamExplicitPtr)
Tells if the values of the charac are distributed or repeated.
o IsDeleted(CATSamExplicitPtr)
Tells if the model data is logicaly.

Methods


o GetDataCategory
public static HRESULT GetDataCategory(CATSamExplicitPtr iExpDataPtr,
CATSamValue& oCategory)
Retrieves the category of a model data.
Parameters:
iExpDataPtr
A pointer to a model data
oCategory
The category of the model data.
See also:
CATSamExplicitPtr, CATSamValue
o GetDataSolverName
public static HRESULT GetDataSolverName(CATSamExplicitPtr iExpDataPtr,
const char*& oSolverName)
Retrieves the solver name of a model data.
Parameters:
iExpDataPtr
A pointer to a model data
oSolverName
The solver name of the model data.
See also:
CATSamExplicitPtr
o GetDataTag
public static HRESULT GetDataTag(CATSamExplicitPtr iExpDataPtr,
CATLONG32& oTag)
Retrieves the external tag of a model data.
Parameters:
iExpDataPtr
A pointer to a model data
oTag
The tag of the model data.
See also:
CATSamExplicitPtr
o GetDataType
public static HRESULT GetDataType(CATSamExplicitPtr iExpDataPtr,
CATSamDataType& oDataType)
Retrieves the data type of a model data.
Parameters:
iExpDataPtr
A pointer to a model data
oDataType
The data type of the model data.
See also:
CATSamExplicitPtr, CATSamDataType
o GetDataUserName
public static HRESULT GetDataUserName(CATSamExplicitPtr iExpDataPtr,
const char*& oUserName)
Retrieves the user name of a model data.
Parameters:
iExpDataPtr
A pointer to a model data
oUserName
The user name of the model data.
See also:
CATSamExplicitPtr
o GetDataUserNumber
public static HRESULT GetDataUserNumber(CATSamExplicitPtr iExpDataPtr,
CATLONG32& oUserNumber)
Retrieves the user number of a model data.
Parameters:
iExpDataPtr
A pointer to a model data
oUserNumber
The user number of the model data.
See also:
CATSamExplicitPtr
o GetDataValueType
public static HRESULT GetDataValueType(CATSamExplicitPtr iExpDataPtr,
CATSamValue& oValueType)
Retrieves the value type of a model data characteristic.
Parameters:
iExpDataPtr
A pointer to a model data
oValueType
The value type of the model data.
See also:
CATSamExplicitPtr, CATSamValue
o GetPhysicalType
public static HRESULT GetPhysicalType(CATSamExplicitPtr iExpDataPtr,
CATSamPhysicalType& oPhysicalType)
Retrieves the physical type of a model data.
Parameters:
iExpDataPtr
A pointer to a model data
oPhysicalType
The physical type of the model data.
See also:
CATSamExplicitPtr, CATSamPhysicalType
o HasRepeatedValues
public static CATBoolean HasRepeatedValues(CATSamExplicitPtr iExpDataPtr)
Tells if the values of the charac are distributed or repeated.
o IsDeleted
public static CATBoolean IsDeleted(CATSamExplicitPtr iExpDataPtr)
Tells if the model data is logicaly.

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

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