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

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...

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

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...
 

Detailed Description

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)

Constructor & Destructor Documentation

◆ CurvePointList()

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).

Parameters
initialMaxCapacityMax count of points that can be stored in this object.

Member Function Documentation

◆ Add()

new void CH.Regatron.HPPS.TFE.CurvePointList.Add ( CurvePoint  point)

This method adds a point to the already existing List of curvePoints.

Parameters
point

◆ Clear()

new void CH.Regatron.HPPS.TFE.CurvePointList.Clear ( )

This function removes all points from the list.

◆ DeleteCurvePointAtIndex()

void CH.Regatron.HPPS.TFE.CurvePointList.DeleteCurvePointAtIndex ( Int32  index)

This method deletes the list item at the given index (start with 0)

Parameters
index

◆ GetCurvePointAtIndex()

CurvePoint CH.Regatron.HPPS.TFE.CurvePointList.GetCurvePointAtIndex ( Int32  index)

Returns the CurvePoint object at the index given as parameter.

Parameters
indexIndex of the searched list item, first item == 0
Returns
The curvePoint at the given index, throws an Exception otherwise (e.g. argument out of range exception)

◆ GetLastError()

string CH.Regatron.HPPS.TFE.CurvePointList.GetLastError ( )

Get the last exception message.

Returns

Implements CH.Regatron.HPPS.IExceptionMessenger.

◆ GetMaxNumberOfPoints()

Int32 CH.Regatron.HPPS.TFE.CurvePointList.GetMaxNumberOfPoints ( )

This function returns the maximum number of Points that can be stored in this object.

Returns
maximum number of points that can be stored in this list.

◆ GetNumberOfCurvePointsInList()

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 )

Returns
Number of CurvePoints items.

◆ IsPointAlreadyInListByPointXValue()

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.

Parameters
pointPoint to check
Returns
true if another curvePoint with the same Xvalue is already in the list, false otherwise.

◆ IsPointAlreadyInListByXValue()

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.

Parameters
xcompareValuex coordinate to be checked for.
Returns
true if another curvePoint with the same Xvalue is already in the list, false otherwise.

◆ ToString()

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)

Returns
A string representation of this point list.