ClassInformationCollection helper class for MantoSampleImageList.
More...
Inherits InfoCollection< TParent, TInfo >.
|
void | Create (string name) |
| Create a new empty class.
|
|
bool | Contains (string name) |
| Check if a certain name is present in the SIL.
|
|
void | Clear () |
| Remove all classes in the Sample image List.
|
|
bool | Remove (int Index) |
| Remove a class by Index.
|
|
bool | Remove (string ID) |
| Remove a class by ID.
|
|
TInfo[] | ToArray () |
| Converts this collection into an array.
|
|
|
override int | GetCount () |
| Parent class calls this method to determine the number of objects in the collection.
|
|
override ClassInformation | GetInfo (int index) |
| Parent class calls this method to extract one info object by index.
|
|
| InfoCollection (TParent parent) |
| Constructor.
|
|
int | GetCount () |
| Function with which the collection queries the number of elements.
|
|
TInfo | GetInfo (int index) |
| Function with which the collection retrieves the information object with the given index.
|
|
|
readonly TParent | Parent |
| Parent image reference helps keeping track of the lifetime and provides the information basis for index access.
|
|
ClassInformationCollection helper class for MantoSampleImageList.
◆ Clear()
Remove all classes in the Sample image List.
Note that this invalidates all ClassInfo objects and SampleInfo object that have been taken from this collection!
- Exceptions
-
ObjectDisposedException | If the image list has already been disposed |
◆ Contains()
bool Contains |
( |
string | name | ) |
|
Check if a certain name is present in the SIL.
- Parameters
-
name | name to be checked for |
- Returns
- true/false
- Exceptions
-
ObjectDisposedException | If the image list has already been disposed |
◆ Create()
void Create |
( |
string | name | ) |
|
Create a new empty class.
- Parameters
-
name | Name of the class to be created |
- Exceptions
-
ObjectDisposedException | If the image list has already been disposed |
InvalidOperationException | when trying to add a new class that already exists or if the name parameter contains an empty string. |
ArgumentNullException | If name is null |
◆ GetCount()
override int GetCount |
( |
| ) |
|
|
protected |
Parent class calls this method to determine the number of objects in the collection.
- Returns
- number of objects in the collection
- Exceptions
-
◆ GetInfo()
Parent class calls this method to extract one info object by index.
- Parameters
-
index | index at which to extract |
- Returns
- extracted object
- Exceptions
-
ObjectDisposedException | If the SampleImageList has already been disposed |
ArgumentOutOfRangeException | If the index is invalid |
◆ Remove() [1/2]
Remove a class by Index.
- Parameters
-
Index | index of the class to be removed |
- Exceptions
-
ObjectDisposedException | If the image list has already been disposed |
- Returns
- true if the class has been removed, false it is has not been removed or if it was not found in the image list
◆ Remove() [2/2]
Remove a class by ID.
- Parameters
-
ID | ID of the class to be removed |
- Exceptions
-
ObjectDisposedException | If the image list has already been disposed |
- Returns
- true if the class has been removed, false it is has not been removed or if it was not found in the image list
◆ this[int index]
Index-based item access.
- Parameters
-
index | index to be accessed |
- Returns
- indexed class object
- Exceptions
-
ObjectDisposedException | If the SampleImageList has already been disposed |
ArgumentOutOfRangeException | If the index is invalid |
◆ this[string name]
String-based item access.
- Parameters
-
- Returns
- indexed class object
- Exceptions
-