All Frameworks Class Hierarchy This Framework Indexes
CATAnalysisBase Class CATAnalysisExplicitListUsr
Usage: you must use this class as is. You should never derive it.
public class CATAnalysisExplicitListUsr
Field model user list.
This object provides services for user lists of the field model.
Constructor and Destructor Index
- o
CATAnalysisExplicitListUsr(CATAnalysisExplicitData&)
- Copy constructor.
- o
CATAnalysisExplicitListUsr(CATAnalysisExplicitListUsr&)
- Copy constructor.
- o
CATAnalysisExplicitListUsr()
- Default constructor.
Method Index
- o
CreateList(CATAnalysisExplicitModel*)
- Creates a user list in the field model.
- o
Delete()
- Deletes a user list from the field model.
- o
Find(CATSamCompareType,CATBoolean,void*,CATBoolean)
- Searches from the current position for data in a list.
- o
First(CATBoolean)
- Moves to the first position of the list.
- o
Insert(CATAnalysisExplicitList&,CATBoolean)
- Inserts a list of new objects in the list after the current position.
- o
Insert(CATAnalysisExplicitChild&,CATBoolean)
- Inserts a new object in the list after the current position.
- o
Insert(CATAnalysisExplicitList&,CATSamCompareType,void*,CATBoolean)
- Inserts a list of new objects in the list after the current position using a filter.
- o
Last(CATBoolean)
- Moves to the last position of the list.
- o
Next(CATBoolean)
- Moves to the next position of the list.
- o
Previous(CATBoolean)
- Moves to the previous position of the list.
- o
Remove(CATAnalysisExplicitList&,CATBoolean)
- Removes a list of objects from the list.
- o
Remove(CATBoolean)
- Removes an object from the list.
- o
Remove(CATSamCompareType,void*)
- Removes all objects from the list which satisfy a particular filter.
- o
Sort(CATSamCompareType,CATSamCompareType)
- Sorts the list using two criterias.
- o
operator =(CATAnalysisExplicitData&)
- Assignment operator.
- o
operator =(CATAnalysisExplicitListUsr&)
- Assignment operator.
- o
operator++()
-
- o
operator--()
-
- o
operator+=(CATAnalysisExplicitList&)
- Inserts a list of new objects in the list after the current position.
- o
operator-=(CATAnalysisExplicitList&)
- Removes a list of objects from the list (use Remove() for a more optimized version).
- o
operator+=(CATAnalysisExplicitChild&)
- Inserts a new object in the list after the current position.
Constructor and Destructor
o CATAnalysisExplicitListUsr
| public CATAnalysisExplicitListUsr( | const | iData) |
-
Copy constructor.
- See also:
- CATAnalysisExplicitData
o CATAnalysisExplicitListUsr
| public CATAnalysisExplicitListUsr( | const | iList) |
-
Copy constructor.
o CATAnalysisExplicitListUsr
| public CATAnalysisExplicitListUsr( | ) |
-
Default constructor.
Methods
o CreateList
| public CreateList( | const | iModel) |
-
Creates a user list in the field model.
- Parameters:
-
- iModel
- A pointer to the field model into which the list will be created.
- See also:
- CATAnalysisExplicitModel
o Delete
-
Deletes a user list from the field model.
o Find
| public Find( | | iCompareType, |
| | iSorted, |
| const | iWhat, |
| | iLinkToListModel | = TRUE) |
-
Searches from the current position for data in a list.
Warning! Since V5R17, parameter iLinkToListModel is mandatory.
- 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.
- iLinkToListModel.
-
Legal values:
- TRUE : The founded object will be linked to the creation field model of the list.
- FALSE : The founded object will be linked to its own creation field model.
o First
| public First( | | iLinkToListModel | = TRUE) |
-
Moves to the first position of the list.
- Parameters:
-
- iLinkToListModel.
-
Legal values:
- TRUE : The object at the first location will be linked to the creation field model of the list.
- FALSE : The object at the first location will be linked to its own creation field model.
o Insert
| public Insert( | | iList, |
| | iBefore | = FALSE) |
-
Inserts a list of new objects in the list after the current position.
The current position of the list points on the last inserted object.
- Parameters:
-
- iList
- The list of objects to insert in the list.
- iBefore
- If TRUE, then the objects are inserted before the current position. If FALSE
then the objects are inserted after the current position.
- See also:
- CATAnalysisExplicitList
o Insert
| public Insert( | const | iChild, |
| | iBefore | = FALSE) |
-
Inserts a new object in the list after the current position.
The current position of the list points on the inserted object.
- Parameters:
-
- iChild
- The object to insert in the list.
- iBefore
- If TRUE, then the object is inserted before the current position. If FALSE
then the object is inserted after the current position.
- See also:
- CATAnalysisExplicitChild
o Insert
| public Insert( | | iList, |
| | iCompareType, |
| const | iCompareValue, |
| | iBefore | = FALSE) |
-
Inserts a list of new objects in the list after the current position using a filter.
The current position of the list points on the last inserted object.
- Parameters:
-
- iList
- The list of objects to insert in the list.
- iCompareType
- The filter criteria.
- iCompareValue
- A pointer to the value used by the filter criteria.
- iBefore
- If TRUE, then the objects are inserted before the current position. If FALSE
then the objects are inserted after the current position.
- See also:
- CATAnalysisExplicitList, CATSamCompareType
o Last
| public Last( | | iLinkToListModel | = TRUE) |
-
Moves to the last position of the list.
- Parameters:
-
- iLinkToListModel.
-
Legal values:
- TRUE : The object at the last location will be linked to the creation field model of the list.
- FALSE : The object at the last location will be linked to its own creation field model.
o Next
| public Next( | | iLinkToListModel | = TRUE) |
-
Moves to the next position of the list.
- Parameters:
-
- iLinkToListModel.
-
Legal values:
- TRUE : The object at the next location will be linked to the creation field model of the list.
- FALSE : The object at the next location will be linked to its own creation field model.
o Previous
| public Previous( | | iLinkToListModel | = TRUE) |
-
Moves to the previous position of the list.
- Parameters:
-
- iLinkToListModel.
-
Legal values:
- TRUE : The object at the previous location will be linked to the creation field model of the list.
- FALSE : The object at the previous location will be linked to its own creation field model.
o Remove
| public Remove( | | iList, |
| | iSort | = FALSE) |
-
Removes a list of objects from the list.
The current position of the list points to the first object in the list.
- Parameters:
-
- iList
- The list of objects to remove from the list.
- iSort
- If TRUE, then both lists will be sorted using the CATSamCompareTypePointer criteria
before any processing.
- See also:
- CATAnalysisExplicitList
o Remove
| public Remove( | | iAll | = FALSE) |
-
Removes an object from the list.
The current position of the list points to the previous object (or to the first
one in the list).
- Parameters:
-
- iAll
- If TRUE, then the list is completely emptied.
o Remove
| public Remove( | | iCompareType, |
| const | iCompareValue) |
-
Removes all objects from the list which satisfy a particular filter.
- Parameters:
-
- iCompareType
- The filter criteria.
- iCompareValue
- A pointer to the value used by the filter criteria.
o Sort
| public Sort( | | iCompareType1, |
| | iCompareType2) |
-
Sorts the list using two criterias.
- Parameters:
-
- iCompareType1
- The first criteria.
- iCompareType2
- The second criteria.
- See also:
- CATSamCompareType
o operator =
| public operator =( | const | iData) |
-
Assignment operator.
- See also:
- CATAnalysisExplicitData
o operator =
| public operator =( | const | iList) |
-
Assignment operator.
o operator++
-
- Deprecated:
- V5R16.
Moves to the next position of the list.
o operator--
-
- Deprecated:
- V5R16.
Moves to the previous position of the list.
o operator+=
| public operator+=( | | iList) |
-
Inserts a list of new objects in the list after the current position.
The current position of the list points on the last inserted object.
- Parameters:
-
- iList
- The list of objects to insert in the list.
- See also:
- CATAnalysisExplicitList
o operator-=
| public operator-=( | | iList) |
-
Removes a list of objects from the list (use Remove() for a more optimized version).
The current position of the list points to the first object in the list.
- Parameters:
-
- iList
- The list of objects to remove from the list.
- See also:
- CATAnalysisExplicitList
o operator+=
| public operator+=( | const | iChild) |
-
Inserts a new object in the list after the current position.
The current position of the list points on the inserted object.
- Parameters:
-
- iChild
- The object to insert in the list.
- See also:
- CATAnalysisExplicitChild
This object is included in the file: CATAnalysisExplicitListUsr.h
If needed, your Imakefile.mk should include the module: CATSAM0Explicit