All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisBase Class CATAnalysisExplicitEntity

CATAnalysisBase.CATAnalysisExplicitData
  |
  +---CATAnalysisBase.CATAnalysisExplicitChild
    |
    +---CATAnalysisBase.CATAnalysisExplicitParent
      |
      +---CATAnalysisExplicitEntity
 

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


public class CATAnalysisExplicitEntity

Field model entity.
This object is used to provide services linked to the field model entities.


Constructor and Destructor Index


o CATAnalysisExplicitEntity()
Default constructor.
o CATAnalysisExplicitEntity(CATAnalysisExplicitData&)
Copy constructor.
o CATAnalysisExplicitEntity(CATAnalysisExplicitEntity&)
Copy constructor.

Method Index


o ApplyTo(CATAnalysisExplicitParent&,CATSamPosition,int,CATSamApplyQualifier)
Applies a field model entity to another entity or set.
o ApplyTo(int,CATSamExplicitPtr*,CATSamPosition,int*,CATSamApplyQualifier*)
Applies a field model entity to several entities or sets.
o ApplyTo(int,CATSamExplicitPtr*,CATSamPosition,int,CATSamApplyQualifier)
Applies a field model entity to several entities or sets.
o CreateEntity(CATAnalysisExplicitModel*,CATSamPhysicalType)
Creates an entity in the field model.
o CreateEntity(CATAnalysisExplicitParent&,CATSamPhysicalType)
Creates an entity in the field model as the child of an other set or entity.
o GetApplyTo(int&,CATSamExplicitPtr*&,CATBoolean)
Obtains the array of pointers to the apply-to.
o GetApplyTo(int&,CATSamExplicitPtr*&,CATSamPosition&,int*&,CATSamApplyQualifier*&,CATBoolean)
Obtains the arrays of the apply-to pointers, apply-to numbers, apply-to Qualifiers and the apply-to positions.
o GetApplyTo(int&,int*&,CATSamPosition&,int*&,CATSamApplyQualifier*&,CATBoolean)
Obtains the arrays of the apply-to sequential numbers, apply-to numbers, apply-to Qualifiers and the apply-to positions.
o GetApplyToList(CATAnalysisExplicitList&)
Obtains the apply-to list.
o GetPointedSetByCombinedEntity(CATAnalysisExplicitSet&)
o IsACombinedEntity()
o RemoveApplyTo(CATAnalysisExplicitParent&)
Removes the apply of a field model entity on another entity or set.
o RemoveApplyTo(int,CATSamExplicitPtr*,CATAnalysisExplicitModel*)
Removes the applies of a field model entity on several entities or sets.
o operator =(CATAnalysisExplicitData&)
Assignment operator.
o operator =(CATAnalysisExplicitEntity&)
Assignment operator.

Constructor and Destructor


o CATAnalysisExplicitEntity
public CATAnalysisExplicitEntity()
Default constructor.
o CATAnalysisExplicitEntity
public CATAnalysisExplicitEntity( const CATAnalysisExplicitData& iData)
Copy constructor.
See also:
CATAnalysisExplicitData
o CATAnalysisExplicitEntity
public CATAnalysisExplicitEntity( const CATAnalysisExplicitEntity& iEntity)
Copy constructor.

Methods


o ApplyTo
public HRESULT ApplyTo( const CATAnalysisExplicitParent& iApplyTo,
CATSamPosition iApplyPosition,
int iApplyNumber= 0,
CATSamApplyQualifier iApplyQualifier= CATSamApplyQualifierLast) const
Applies a field model entity to another entity or set.
Parameters:
iApplyTo
The field object on which the apply is done. must be defined in the same model than the entity.
iApplyPosition
The position of the apply.
iApplyNumber
The number of the apply.
iApplyQualifier
The apply qualifier.
See also:
CATAnalysisExplicitParent, CATSamPosition, CATSamApplyQualifier
o ApplyTo
public HRESULT ApplyTo(int iNumber,
const CATSamExplicitPtr* iApplyTo,
CATSamPosition iApplyPosition,
const int* iApplyNumber,
const CATSamApplyQualifier* iApplyQualifier= NULL) const
Applies a field model entity to several entities or sets.
Parameters:
oNumber
The number of apply-to.
iApplyTo[oNumber]
The array of pointers to the field objects on which the apply is done.
iApplyPosition
The position of the applies.
iApplyNumber[oNumber]
The array of numbers of the applies.
iApplyQualifier[oNumber]
The array of apply qualifiers.
See also:
CATSamPosition
o ApplyTo
public HRESULT ApplyTo(int iNumber,
const CATSamExplicitPtr* iApplyTo,
CATSamPosition iApplyPosition,
int iApplyNumber= 0,
CATSamApplyQualifier iApplyQualifier= CATSamApplyQualifierLast) const
Applies a field model entity to several entities or sets.
Parameters:
oNumber
The number of apply-to.
iApplyTo[oNumber]
The array of pointers to the field objects on which the apply is done.
iApplyPosition
The position of the applies.
iApplyNumber
The number of the applies.
iApplyQualifier
The apply qualifier.
See also:
CATSamPosition, CATSamApplyQualifier
o CreateEntity
public HRESULT CreateEntity( const CATAnalysisExplicitModel* iModel,
CATSamPhysicalType iPhysicalType)
Creates an entity in the field model.
Parameters:
iModel
A pointer to the field model into which the entity will be created.
iPhysicalType
The physical type of the entity.
See also:
CATAnalysisExplicitModel
o CreateEntity
public HRESULT CreateEntity( const CATAnalysisExplicitParent& iParent,
CATSamPhysicalType iPhysicalType)
Creates an entity in the field model as the child of an other set or entity.
Parameters:
iParent
The parent of the entity which will be created.
iPhysicalType
The physical type of the entity.
See also:
CATAnalysisExplicitParent
o GetApplyTo
public HRESULT GetApplyTo(int& oNumber,
CATSamExplicitPtr*& oApplyTo,
CATBoolean iExpand= FALSE) const
Obtains the array of pointers to the apply-to.
Parameters:
oNumber
The number of apply-to.
oApplyTo[oNumber]
The array of pointers to the apply-to.
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.
iExpand
If iExpand is True, and if the ApplyTo list contains Sets or Groups, the method returns the children of the Sets or the ApplyTo of the Groups.
o GetApplyTo
public HRESULT GetApplyTo(int& oNumber,
CATSamExplicitPtr*& oApplyTo,
CATSamPosition& oApplyToPosition,
int*& oApplyToNumbers,
CATSamApplyQualifier*& oApplyToQualifiers,
CATBoolean iExpand= FALSE) const
Obtains the arrays of the apply-to pointers, apply-to numbers, apply-to Qualifiers and the apply-to positions.
Parameters:
oNumber
The number of apply-to.
oApplyTo[oNumber]
The array of the apply-to 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.
oApplyToPosition
The apply position.
oApplyToNumbers[oNumber]
The array of apply-to numbers.
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.
oApplyToQualifiers[oNumber]
The array of apply-to qualifiers.
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.
iExpand
If iExpand is True, and if the ApplyTo list contains Sets or Groups, the method returns the children of the Sets or the ApplyTo of the Groups.
See also:
CATSamPosition, CATSamApplyQualifier
o GetApplyTo
public HRESULT GetApplyTo(int& oNumber,
int*& oApplyTo,
CATSamPosition& oApplyToPosition,
int*& oApplyToNumbers,
CATSamApplyQualifier*& oApplyToQualifiers,
CATBoolean iExpand= FALSE) const
Obtains the arrays of the apply-to sequential numbers, apply-to numbers, apply-to Qualifiers and the apply-to positions.
Parameters:
oNumber
The number of apply-to.
oApplyTo[oNumber]
The array of the apply-to Sequential Number .
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.
oApplyToPosition
The apply-to position.
oApplyToNumbers[oNumber]
The array of apply-to numbers.
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.
oApplyToQualifiers[oNumber]
The array of apply-to qualifiers.
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.
iExpand
If iExpand is True, and if the ApplyTo list contains Sets or Groups, the method returns the children of the Sets or the ApplyTo of the Groups.
See also:
CATSamPosition, CATSamApplyQualifier
o GetApplyToList
public HRESULT GetApplyToList(CATAnalysisExplicitList& oApplyToList) const
Obtains the apply-to list.
Parameters:
oApplyToList
The apply-to list.
See also:
CATAnalysisExplicitList
o GetPointedSetByCombinedEntity
public HRESULT GetPointedSetByCombinedEntity(CATAnalysisExplicitSet& oPointedSet) const
Deprecated:
V5R17 Gets the pointed Set if Combine status.
Parameters:
oPointedObject
the pointed object.
o IsACombinedEntity
public CATBoolean IsACombinedEntity()const
Deprecated:
V5R17 Returns the Combine status. Legal values:
  • TRUE The object is a combined Entity.
    This means that it is pointing to aSet in an other case. To access the "pointed" Set object use GetPointedSetByCombinedEntity.
  • FALSE The object is not a combined Entity.
o RemoveApplyTo
public HRESULT RemoveApplyTo( const CATAnalysisExplicitParent& iApplyTo) const
Removes the apply of a field model entity on another entity or set.
Parameters:
iApplyTo
The field object for which the apply must be removed.
See also:
CATAnalysisExplicitParent
o RemoveApplyTo
public HRESULT RemoveApplyTo(int iNumber,
const CATSamExplicitPtr* iApplyTo,
const CATAnalysisExplicitModel* iApplyModel= NULL) const
Removes the applies of a field model entity on several entities or sets.
Parameters:
oNumber
The number of apply-to.
iApplyTo[oNumber]
The array of pointers to the field objects for which the apply must be removed.
iApplyModel
if iApplyModel is not NULL the objects for which the apply must be removed are defined in iApplyModel, otherwise they are defined in the same model than the entity.
o operator =
public CATAnalysisExplicitEntity operator =( const CATAnalysisExplicitData& iData)
Assignment operator.
See also:
CATAnalysisExplicitData
o operator =
public CATAnalysisExplicitEntity operator =( const CATAnalysisExplicitEntity& iEntity)
Assignment operator.

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

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