All Frameworks Object Hierarchy This Framework Indexes
ClashResults (Collection)
A collection of all ClashResult objects currently managed by the application.
The results linked to a specification are not managed thru this collection (see Clashes ).
The method GetTechnologicalObject("ClashResults") on the root product, allows you to retrieve this collection.
Method Index
-
AddFromXML
- Creates a ClashResult object from a XML file
and adds it to the ClashResults collection.
-
Item
- Returns a ClashResult object using its index or its name from the ClashResults collection.
-
Remove
- Removes a ClashResult object from the ClashResults collection.
Methods
o Func AddFromXML( | | iPath, |
| | iType) As |
-
Creates a ClashResult object from a XML file
and adds it to the ClashResults collection.
- Parameters:
-
- iPath
- The path of the XML file.
- iType
- The type of import.
- Returns:
- The created ClashResult
- Example:
- This example creates a new ClashResult in the TheClashResults collection.
Dim NewClashResult As ClashResult
Set NewClashResult = TheClashResults.AddFromXML("c:\tmp\sample.xml", CatClashImportTypeClashOnly)
-
Returns a ClashResult object using its index or its name from the ClashResults collection.
- Parameters:
-
- iIndex
- The index or the name of the ClashResult to retrieve from the collection of ClashResults.
As a numerics, this index is the rank of the ClashResult in the collection.
The index of the first ClashResult in the collection is 1, and
the index of the last ClashResult is Count.
As a string, it is the name you assigned to the ClashResult.
- Example:
- This example retrieves in ThisClashResult the ninth ClashResult,
and in ThatClashResult the ClashResult named
ClashResult Of MyProduct from the TheClashResults collection.
Dim ThisClashResult As ClashResult
Set ThisClashResult = TheClashResults.Item(9)
Dim ThatClashResult As ClashResult
Set ThatClashResult = TheClashResults.Item("ClashResult Of MyProduct")
-
Removes a ClashResult object from the ClashResults collection.
- Parameters:
-
- iIndex
- The index or the name of the ClashResult to remove from the collection of ClashResults.
As a numerics, this index is the rank of the ClashResult in the collection.
The index of the first ClashResult in the collection is 1, and
the index of the last ClashResult is Count.
As a string, it is the name you assigned to the ClashResult.
- Example:
- The following example removes the tenth ClashResult and the ClashResult named
ClashResult Of MyProduct from the TheClashResults collection.
TheClashResults.Remove(10)
TheClashResults.Remove("ClashResult Of MyProduct")