CATFmtToolsInterfaces CATFmtListOfPath
Usage: you must use this class as is. You should never derive it.
public class CATFmtListOfPath
Object managing a list of Paths on objects in the product structure.
- See also:
-
Constructor and Destructor Index
- o
CATFmtListOfPath(int)
- Constructs an empty list of Paths.
- o
~CATFmtListOfPath()
-
Method Index
- o
Append(CATFmtPath*,CATBoolean)
- Adds a new Path at the end of the list.
- o
Append(CATFmtListOfPath*,CATBoolean)
- Adds a new Path at the end of the list.
- o
Locate(CATFmtPath*)
- Locates a Path in the list.
- o
RemoveAll()
- Empty the list.
- o
RemovePosition(int)
- Removes an item in the list.
- o
Size()
- Returns the number of Paths in list.
- o
operator ==(CATFmtListOfPath&)
- Equality operator.
- o
operator [](int)
- Access a Path in the list.
Constructor and Destructor
o CATFmtListOfPath
| public CATFmtListOfPath( | | iInitialSize | = 0 ) |
-
Constructs an empty list of Paths.
- Parameters:
-
- iInitialSize
- Array integer to specify an initial memory allocation size for the list.
o ~CATFmtListOfPath
| public virtual ~CATFmtListOfPath( | ) |
-
Methods
o Append
| public Append( | | iPath, |
| | iSearchIfDuplicate | = FALSE ) |
-
Adds a new Path at the end of the list.
- Parameters:
-
- iPath
- Path to add in the list
- iSearchIfDuplicate
- If TRUE, iPath is added to the list only if it does not already exist.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The Path iPath added in the list.
- S_FALSE
- The Path iPath already exist in the list.
- E_FAIL
- The Path iPath is NULL.
- E_OUTOFMEMORY
- Memory allocation problem.
o Append
| public Append( | | iListPath, |
| | iSearchIfDuplicate | = FALSE ) |
-
Adds a new Path at the end of the list.
- Parameters:
-
- iListPath
- List of Path to add in the list
- iSearchIfDuplicate
- If TRUE, iPath is added to the list only if it does not already exist.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The Path iPath added in the list.
- S_FALSE
- The Path iPath already exist in the list.
- E_FAIL
- The Path iPath is NULL.
- E_OUTOFMEMORY
- Memory allocation problem.
o Locate
-
Locates a Path in the list.
- Parameters:
-
- iPath
- Path to be located in the list.
- Returns:
- The index in the list corresponding to iPath Path, otherwise 0.
o RemoveAll
-
Empty the list.
o RemovePosition
| public RemovePosition( | | iIndex) |
-
Removes an item in the list.
- Parameters:
-
- iIndex
- Index in the list to be removed. This value should be
between 1 and the size of the list, otherwise nothing is done.
o Size
-
Returns the number of Paths in list.
o operator ==
| public operator ==( | const | iList) |
-
Equality operator.
- Parameters:
-
- iList
- List of Paths to compare with
- Returns:
- boolean
Legal values: 0: False
the condition is not fullfilled, or Other: True
if the condition is fullfilled.
o operator []
| public operator []( | | iIndex) |
-
Access a Path in the list.
- Parameters:
-
- iIndex
- Index in the list of the Path to be returned. This value should be
between 1 and the size of the list, otherwise a NULL value is returned.
- Returns:
- A pointer on the Path.
Lifecycle rules deviation: the method does not AddRef the returned Path.
This object is included in the file: CATFmtListOfPath.h
If needed, your Imakefile.mk should include the module: CATFmtToolsInterfaces
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.