Class J2Ci.jDVPSCurve
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class J2Ci.jDVPSCurve

Object
   |
   +----J2Ci.jDVPSCurve

public class jDVPSCurve
extends Object
A jDVPSCurve is the Java-sided class for the C++-Class DVPSCurve.

Author:
Andreas Schröter

Constructor Index

 o J2Ci.jDVPSCurve()
Constructor
 o J2Ci.jDVPSCurve(long)
Constructor for attaching an existing C++-Object.
 o J2Ci.jDVPSCurve(jDVPSCurve)
Copy-Constructor

Method Index

 o getCurveAxisUnitsX()
Gets the curve axis units string for the X dimension if present.
 o getCurveAxisUnitsY()
Gets the curve axis units string for the Y dimension if present.
 o getCurveDescription()
Gets the curve description string if present.
 o getCurveGroup()
Get group number of curve repeating group managed by this object.
 o getCurveLabel()
Gets the curve label string if present.
 o getNumberOfPoints()
Gets the number of points in the curve.
 o getPoint(int, jDoubleByRef, jDoubleByRef)
Gets one point from the curve data.
 o getTypeOfData()
Gets the type of data in the curve (ROI or POLY).

Constructors

 o jDVPSCurve
protected jDVPSCurve()
Constructor

 o jDVPSCurve
public jDVPSCurve(long attachAdr)
Constructor for attaching an existing C++-Object. FOR INTERNAL USE ONLY!

Parameters:
attachAdr - Address of C++-Object
 o jDVPSCurve
public jDVPSCurve(jDVPSCurve copy)
Copy-Constructor

Parameters:
copy - Curve-Object to copy

Methods

 o getCurveAxisUnitsX
public native java.lang.String getCurveAxisUnitsX()
Gets the curve axis units string for the X dimension if present. If the string is absent, this method returns NULL or an empty string.

Returns:
curve description
 o getCurveAxisUnitsY
public native java.lang.String getCurveAxisUnitsY()
Gets the curve axis units string for the Y dimension if present. If the string is absent, this method returns NULL or an empty string.

Returns:
curve description
 o getCurveDescription
public native java.lang.String getCurveDescription()
Gets the curve description string if present. If the description string is absent, this method returns NULL or an empty string.

Returns:
curve description
 o getCurveGroup
public native byte getCurveGroup()
Get group number of curve repeating group managed by this object.

Returns:
the lower byte of the curve group
 o getCurveLabel
public native java.lang.String getCurveLabel()
Gets the curve label string if present. If the label string is absent, this method returns NULL or an empty string.

Returns:
curve label
 o getNumberOfPoints
public native int getNumberOfPoints()
Gets the number of points in the curve.

Returns:
number of points
 o getPoint
public native int getPoint(int idx,
                           jDoubleByRef x,
                           jDoubleByRef y)
Gets one point from the curve data.

Parameters:
idx - index of the curve point, must be < getNumberOfPoints();
x - upon success the x value of the point is returned in this parameter. Must be created before passing to this method!
y - upon success the y value of the point is returned in this parameter Must be created before passing to this method!
Returns:
EC_Normal if successful, an error code otherwise (from jE_Condition).
 o getTypeOfData
public native int getTypeOfData()
Gets the type of data in the curve (ROI or POLY).

Returns:
type of data in curve (from jDVPSCurveType).

All Packages  Class Hierarchy  This Package  Previous  Next  Index