All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisBase Class CATAnalysisExplicitListATo

CATAnalysisBase.CATAnalysisExplicitData
  |
  +---CATAnalysisBase.CATAnalysisExplicitList
    |
    +---CATAnalysisExplicitListATo
 

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


public class CATAnalysisExplicitListATo

Field model apply to list.
This object provides services for apply to lists of the field model.


Constructor and Destructor Index


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

Method Index


o Find(CATSamCompareType,CATBoolean,void*)
o Find(CATSamCompareType,void*)
Searches from the current location for data in a list.
o First()
Moves to the first location in the list.
o GetApplyNumber()
Returns the apply number at the current location in the list.
o GetApplyPosition()
Returns the position of apply of the list.
o GetApplyQualifier()
Returns the apply qualifier at the current location in the list.
o GetContents(int&,CATSamExplicitPtr*&,CATBoolean,CATSamMeshType)
Obtains the arrays of pointers to the list contents, apply position and apply numbers.
o GetContents(int&,CATSamExplicitPtr*&,CATSamPosition&,int*&,CATSamApplyQualifier*&,CATBoolean,CATSamMeshType)
Obtains the arrays of pointers to the list contents, apply position, apply numbers and apply qualifiers.
o GetContents(int&,int*&,CATSamPosition&,int*&,CATSamApplyQualifier*&,CATBoolean,CATSamMeshType)
Obtains the arrays of pointers to the list contents, apply position, apply numbers and apply qualifiers.
o GetCurrent(int&)
Returns the object at the current location in the list and its apply number.
o Last()
Moves to the last location in the list.
o Next()
Moves to the next location in the list.
o Previous()
Moves to the previous location in the list.
o operator =(CATAnalysisExplicitData&)
Assignment operator.
o operator =(CATAnalysisExplicitListATo&)
Assignment operator.

Constructor and Destructor


o CATAnalysisExplicitListATo
public CATAnalysisExplicitListATo()
Default constructor.
o CATAnalysisExplicitListATo
public CATAnalysisExplicitListATo( const CATAnalysisExplicitData& iData)
Copy constructor.
See also:
CATAnalysisExplicitData
o CATAnalysisExplicitListATo
public CATAnalysisExplicitListATo( const CATAnalysisExplicitListATo& iList)
Copy constructor.

Methods


o Find
public CATAnalysisExplicitListATo & Find(CATSamCompareType iCompareType,
CATBoolean iSortList,
const void* iToSearch)
Deprecated:
V5R17 Use Find(CATSamCompareType, const void *) instead. Searches from the current location for data in a list.
Parameters:
iCompareType
The search criteria.
iSorted
If TRUE, then the list is sorted using the search criteria.
iWhat
A pointer to the value being searched for.
o Find
public CATAnalysisExplicitListATo & Find(CATSamCompareType iCompareType,
const void* iToSearch)
Searches from the current location for data in a list.
Parameters:
iCompareType
The search criteria.
iWhat
A pointer to the value being searched for.
o First
public CATAnalysisExplicitListATo & First()
Moves to the first location in the list.
o GetApplyNumber
public int GetApplyNumber()const
Returns the apply number at the current location in the list.
o GetApplyPosition
public CATSamPosition GetApplyPosition()const
Returns the position of apply of the list.
See also:
CATSamPosition
o GetApplyQualifier
public CATSamApplyQualifier GetApplyQualifier()const
Returns the apply qualifier at the current location in the list.
See also:
CATSamApplyQualifier
o GetContents
public HRESULT GetContents(int& oNumber,
CATSamExplicitPtr*& oContents,
CATBoolean iExpand= FALSE,
CATSamMeshType iFilter= CATSamMeshTypeAll)
Obtains the arrays of pointers to the list contents, apply position and apply numbers.
Parameters:
oNumber
The number of objects in the list.
oContents[oNumber]
The array of pointers to the objects.
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 and/or groups, the method returns the ApplyTo under the sets and/or the ApplyTo of the groups.
iFilter
A filter of the ApplyTo list: it's used to select virtual or not virtual ApplyTo entities in the expanded ApplyTo list.
Notes that iFilter is active only if iExpand is True.
See also:
CATSamPosition, CATSamMeshType
o GetContents
public HRESULT GetContents(int& oNumber,
CATSamExplicitPtr*& oContents,
CATSamPosition& oApplyPosition,
int*& oApplyNumbers,
CATSamApplyQualifier*& oApplyQualifiers,
CATBoolean iExpand= FALSE,
CATSamMeshType iFilter= CATSamMeshTypeAll)
Obtains the arrays of pointers to the list contents, apply position, apply numbers and apply qualifiers.
Parameters:
oNumber
The number of objects in the list.
oContents[oNumber]
The array of pointers to the objects.
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.
oApplyPosition
The apply position of the list.
oApplyNumbers[oNumber]
The array of apply 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.
oApplyQualifiers[oNumber]
The array of apply 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 and/or groups, the method returns the ApplyTo under the sets and/or the ApplyTo of the groups.
iFilter
A filter of the ApplyTo list: it's used to select virtual or not virtual ApplyTo entities in the expanded ApplyTo list.
Notes that iFilter is active only if iExpand is True.
See also:
CATSamPosition, CATSamMeshType, CATSamApplyQualifier
o GetContents
public HRESULT GetContents(int& oNumber,
int*& oContents,
CATSamPosition& oApplyPosition,
int*& oApplyNumbers,
CATSamApplyQualifier*& oApplyQualifiers,
CATBoolean iExpand= FALSE,
CATSamMeshType iFilter= CATSamMeshTypeAll)
Obtains the arrays of pointers to the list contents, apply position, apply numbers and apply qualifiers.
Parameters:
oNumber
The number of apply-to.
oContents[oNumber]
The array of Sequential Number of the objects.
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 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.
oApplyQualifiers[oNumber]
The array of apply 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 and/or groups, the method returns the ApplyTo under the sets and/or the ApplyTo of the groups.
iFilter
A filter of the ApplyTo list: it's used to select virtual or not virtual ApplyTo entities in the expanded ApplyTo list.
Notes that iFilter is active only if iExpand is True.
See also:
CATSamPosition, CATSamMeshType, CATSamApplyQualifier
o GetCurrent
public const CATAnalysisExplicitChild & GetCurrent(int& oApplyNumber) const
Returns the object at the current location in the list and its apply number.
Parameters:
oApplyNumber
The apply number.
See also:
CATAnalysisExplicitChild
o Last
public CATAnalysisExplicitListATo & Last()
Moves to the last location in the list.
o Next
public CATAnalysisExplicitListATo & Next()
Moves to the next location in the list.
o Previous
public CATAnalysisExplicitListATo & Previous()
Moves to the previous location in the list.
o operator =
public CATAnalysisExplicitListATo operator =( const CATAnalysisExplicitData& iData)
Assignment operator.
See also:
CATAnalysisExplicitData
o operator =
public CATAnalysisExplicitListATo operator =( const CATAnalysisExplicitListATo& iList)
Assignment operator.

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

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