![]() |
TopCon API
1.1.0
.Net API to control TopCon devices
|
This class covers a set of points and is used in all AAP based curves. It is declared 'abstract' so that it cannot be implemented, instead use the derived classes (e.g. AAPCurvePointList, UserDefinedCurvePointList) More...
Public Member Functions | |
CurvePointList (Int32 initialMaxCapacity) | |
Commonly this constructor should not be used as this class has to be inherited. E.g. when creating an AAPCurvePointList, create an instance of the AAPCurvePointList. The constructor will then initialize this base class with the correct parameters (here: max number of points = 64). More... | |
new void | Add (CurvePoint point) |
This method adds a point to the already existing List of curvePoints. More... | |
CurvePoint | GetCurvePointAtIndex (Int32 index) |
Returns the CurvePoint object at the index given as parameter. More... | |
Int32 | GetNumberOfCurvePointsInList () |
This method returns the number of CurvePoint items in the list. Note that it counts 0=empty, 1=one item, ... n=n items ( while any index used in remove.. / add.... methods uses 0 ... n-1 ) More... | |
void | DeleteCurvePointAtIndex (Int32 index) |
This method deletes the list item at the given index (start with 0) More... | |
Boolean | IsPointAlreadyInListByPointXValue (CurvePoint point) |
This method allows to check if a particular point is already in the list. HERE: check is done by comparing the X-values, y-values are ignored. More... | |
Boolean | IsPointAlreadyInListByXValue (Double xcompareValue) |
This method allows to check if a particular point is already in the list. HERE: check is done by comparing the parameter against the X-value of the existing points. More... | |
new void | Clear () |
This function removes all points from the list. More... | |
Int32 | GetMaxNumberOfPoints () |
This function returns the maximum number of Points that can be stored in this object. More... | |
override String | ToString () |
This method returns a string representation of this point list. Example: P(21 | 19) P(24 | 13) More... | |
string | GetLastError () |
Get the last exception message. More... | |
This class covers a set of points and is used in all AAP based curves. It is declared 'abstract' so that it cannot be implemented, instead use the derived classes (e.g. AAPCurvePointList, UserDefinedCurvePointList)
CH.Regatron.HPPS.TFE.CurvePointList.CurvePointList | ( | Int32 | initialMaxCapacity | ) |
Commonly this constructor should not be used as this class has to be inherited. E.g. when creating an AAPCurvePointList, create an instance of the AAPCurvePointList. The constructor will then initialize this base class with the correct parameters (here: max number of points = 64).
initialMaxCapacity | Max count of points that can be stored in this object. |
new void CH.Regatron.HPPS.TFE.CurvePointList.Add | ( | CurvePoint | point | ) |
This method adds a point to the already existing List of curvePoints.
point |
new void CH.Regatron.HPPS.TFE.CurvePointList.Clear | ( | ) |
This function removes all points from the list.
void CH.Regatron.HPPS.TFE.CurvePointList.DeleteCurvePointAtIndex | ( | Int32 | index | ) |
This method deletes the list item at the given index (start with 0)
index |
CurvePoint CH.Regatron.HPPS.TFE.CurvePointList.GetCurvePointAtIndex | ( | Int32 | index | ) |
Returns the CurvePoint object at the index given as parameter.
index | Index of the searched list item, first item == 0 |
string CH.Regatron.HPPS.TFE.CurvePointList.GetLastError | ( | ) |
Int32 CH.Regatron.HPPS.TFE.CurvePointList.GetMaxNumberOfPoints | ( | ) |
This function returns the maximum number of Points that can be stored in this object.
Int32 CH.Regatron.HPPS.TFE.CurvePointList.GetNumberOfCurvePointsInList | ( | ) |
This method returns the number of CurvePoint items in the list.
Note that it counts 0=empty, 1=one item, ... n=n items ( while any index used in remove.. / add.... methods uses 0 ... n-1 )
Boolean CH.Regatron.HPPS.TFE.CurvePointList.IsPointAlreadyInListByPointXValue | ( | CurvePoint | point | ) |
This method allows to check if a particular point is already in the list. HERE: check is done by comparing the X-values, y-values are ignored.
point | Point to check |
Boolean CH.Regatron.HPPS.TFE.CurvePointList.IsPointAlreadyInListByXValue | ( | Double | xcompareValue | ) |
This method allows to check if a particular point is already in the list. HERE: check is done by comparing the parameter against the X-value of the existing points.
xcompareValue | x coordinate to be checked for. |
override String CH.Regatron.HPPS.TFE.CurvePointList.ToString | ( | ) |
This method returns a string representation of this point list.
Example:
P(21 | 19)
P(24 | 13)