All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisBase Class CATAnalysisExplicitListABy

CATAnalysisBase.CATAnalysisExplicitData
  |
  +---CATAnalysisBase.CATAnalysisExplicitList
    |
    +---CATAnalysisExplicitListABy
 

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


public class CATAnalysisExplicitListABy

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


Constructor and Destructor Index


o CATAnalysisExplicitListABy()
Default constructor.
o CATAnalysisExplicitListABy(CATAnalysisExplicitData&)
Copy constructor.
o CATAnalysisExplicitListABy(CATAnalysisExplicitListABy&)
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 at the current location in the list.
o GetApplyQualifier()
Returns the apply qualifier at the current location in the list.
o GetApplyQualifiers(int&,CATSamApplyQualifier*&)
Returns the array of apply qualifiers for the list.
o GetContents(int&,CATSamExplicitPtr*&,CATSamPosition*&,int*&)
Obtains the arrays of pointers to the list contents, apply positions and apply numbers.
o GetCurrent(CATSamPosition&,int&)
Returns the object at the current location in the list and its position of apply and 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 =(CATAnalysisExplicitListABy&)
Assignment operator.

Constructor and Destructor


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

Methods


o Find
public CATAnalysisExplicitListABy & 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 CATAnalysisExplicitListABy & 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 CATAnalysisExplicitListABy & 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 at the current location in 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 GetApplyQualifiers
public HRESULT GetApplyQualifiers(int& oNumber,
CATSamApplyQualifier*& oApplyQualifiers)
Returns the array of apply qualifiers for the list.
Parameters:
oNumber
The number of objects in the list.
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.
See also:
CATSamApplyQualifier
o GetContents
public HRESULT GetContents(int& oNumber,
CATSamExplicitPtr*& oContents,
CATSamPosition*& oApplyPositions,
int*& oApplyNumbers)
Obtains the arrays of pointers to the list contents, apply positions 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.
oApplyPositions[oNumber]
The array of apply positions.
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.
oApplyNumbers[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.
See also:
CATSamPosition
o GetCurrent
public const CATAnalysisExplicitChild & GetCurrent(CATSamPosition& oApplyPosition,
int& oApplyNumber) const
Returns the object at the current location in the list and its position of apply and apply number.
Parameters:
oApplyPosition
The position of apply.
oApplyNumber
The apply number.
See also:
CATAnalysisExplicitChild, CATSamPosition
o Last
public CATAnalysisExplicitListABy & Last()
Moves to the last location in the list.
o Next
public CATAnalysisExplicitListABy & Next()
Moves to the next location in the list.
o Previous
public CATAnalysisExplicitListABy & Previous()
Moves to the previous location in the list.
o operator =
public CATAnalysisExplicitListABy operator =( const CATAnalysisExplicitData& iData)
Assignment operator.
See also:
CATAnalysisExplicitData
o operator =
public CATAnalysisExplicitListABy operator =( const CATAnalysisExplicitListABy& iList)
Assignment operator.

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

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