TopCon API  1.1.0
.Net API to control TopCon devices
CH.Regatron.HPPS.TFE.UserDefinedCurvePointList Class Reference

This class is a special CurvePointList with a maximum capacity of 1000 points.
It should be used with userDefinedCurves.
It is not recommended to use this CurvePointList for the initialization of all AAP and SASCurves. More...

Inheritance diagram for CH.Regatron.HPPS.TFE.UserDefinedCurvePointList:
Inheritance graph

Public Member Functions

 UserDefinedCurvePointList ()
 Standard constructor of the underlying CurvePointList (initialized with a maximum capacity of 1000 points.) More...
 
Double GetMaximumValue ()
 
override String ToString ()
 This method returns a readable string representation of the whole CurvePointList.
Example:
UserDefinedCurvePointList:
Point [ 123 | 987 ]
Point [ 234 | 999 ]
Point [ ... | ... ]
More...
 
- Public Member Functions inherited from 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). 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...
 

Detailed Description

This class is a special CurvePointList with a maximum capacity of 1000 points.
It should be used with userDefinedCurves.
It is not recommended to use this CurvePointList for the initialization of all AAP and SASCurves.

Constructor & Destructor Documentation

◆ UserDefinedCurvePointList()

CH.Regatron.HPPS.TFE.UserDefinedCurvePointList.UserDefinedCurvePointList ( )

Standard constructor of the underlying CurvePointList (initialized with a maximum capacity of 1000 points.)

Member Function Documentation

◆ GetMaximumValue()

Double CH.Regatron.HPPS.TFE.UserDefinedCurvePointList.GetMaximumValue ( )

Returns

◆ ToString()

override String CH.Regatron.HPPS.TFE.UserDefinedCurvePointList.ToString ( )

This method returns a readable string representation of the whole CurvePointList.
Example:
UserDefinedCurvePointList:
Point [ 123 | 987 ]
Point [ 234 | 999 ]
Point [ ... | ... ]

Returns
The string representation.