All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisBase Class CATAnalysisExplicitList

CATAnalysisBase.CATAnalysisExplicitData
  |
  +---CATAnalysisExplicitList
 

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


public class CATAnalysisExplicitList

Field model list.
This object provides services common to all types of lists of the field model.


Constructor and Destructor Index


o CATAnalysisExplicitList()
Default constructor.
o CATAnalysisExplicitList(CATAnalysisExplicitData&)
Copy constructor.
o CATAnalysisExplicitList(CATAnalysisExplicitList&)
Copy constructor.
o ~CATAnalysisExplicitList()
Donstructor.

Method Index


o Compare(CATSamCompareType,void*)
Compares the content of the current object with a value using a criteria.
o CurrentIsFirst()
Compare current location with first location in the list.
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 GetContents(int&,CATSamExplicitPtr*&)
Obtains the array of pointers to the list contents.
o GetCurrent()
Returns the object at the current location in the list.
o GetLength(CATBoolean)
Returns the length of the list.
o GetListType()
Returns the type of the list.
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 Sort(CATSamCompareType)
o Sort(CATSamCompareType,CATSamCompareType)
o operator =(CATAnalysisExplicitData&)
Assignment operator.
o operator =(CATAnalysisExplicitList&)
Assignment operator.
o operator*()
Returns the object at the current location in the list.

Constructor and Destructor


o CATAnalysisExplicitList
public CATAnalysisExplicitList()
Default constructor.
o CATAnalysisExplicitList
public CATAnalysisExplicitList( const CATAnalysisExplicitData& iData)
Copy constructor.
See also:
CATAnalysisExplicitData
o CATAnalysisExplicitList
public CATAnalysisExplicitList( const CATAnalysisExplicitList& iList)
Copy constructor.
o ~CATAnalysisExplicitList
public virtual ~CATAnalysisExplicitList()
Donstructor.

Methods


o Compare
public int Compare(CATSamCompareType iCompareType,
const void* iCompareValue)
Compares the content of the current object with a value using a criteria.
Parameters:
iCompareType
The compare criteria.
iCompareValue
A pointer to the value used by the compare criteria.
o CurrentIsFirst
public CATBoolean CurrentIsFirst()const
Compare current location with first location in the list. Returns TRUE if there are equal.
o Find
public CATAnalysisExplicitList & Find(CATSamCompareType iCompareType,
CATBoolean iSorted,
const void* iWhat)
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 CATAnalysisExplicitList & Find(CATSamCompareType iCompareType,
const void* iWhat)
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 CATAnalysisExplicitList & First()
Moves to the first location in the list.
o GetContents
public HRESULT GetContents(int& oNumber,
CATSamExplicitPtr*& oContents)
Obtains the array of pointers to the list contents.
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.
o GetCurrent
public const CATAnalysisExplicitChild & GetCurrent()const
Returns the object at the current location in the list.
See also:
CATAnalysisExplicitChild
o GetLength
public int GetLength(CATBoolean really= FALSE)
Returns the length of the list.
Parameters:
really
If really = TRUE, it returns the real length of the list (with temporary deleted datas).
o GetListType
public CATSamListType GetListType()const
Returns the type of the list.
See also:
CATSamListType
o Last
public CATAnalysisExplicitList & Last()
Moves to the last location in the list.
o Next
public CATAnalysisExplicitList & Next()
Moves to the next location in the list.
o Previous
public CATAnalysisExplicitList & Previous()
Moves to the previous location in the list.
o Sort
public HRESULT Sort(CATSamCompareType iCompareType)
Deprecated:
V5R17 Use CATAnalysisExplicitListUsr.Sort instead with twice the same arguments. Sorts the list using a criteria.
Parameters:
iCompareType
The criteria.
See also:
CATSamCompareType
o Sort
public HRESULT Sort(CATSamCompareType iCompareType1,
CATSamCompareType iCompareType2)
Deprecated:
V5R17 Use CATAnalysisExplicitListUsr.Sort instead. Sorts the list using two criterias.
Parameters:
iCompareType1
The first criteria.
iCompareType2
The second criteria.
See also:
CATSamCompareType
o operator =
public CATAnalysisExplicitList operator =( const CATAnalysisExplicitData& iData)
Assignment operator.
See also:
CATAnalysisExplicitData
o operator =
public CATAnalysisExplicitList operator =( const CATAnalysisExplicitList& iList)
Assignment operator.
o operator*
public const CATAnalysisExplicitChild & operator*()const
Returns the object at the current location in the list.
See also:
CATAnalysisExplicitChild

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

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