System functions More...
Public Member Functions | |
double | POWER (double Base, double Exponent) |
Returns a specified number raised to the specified power. More... | |
double | SIN (double Angle) |
Returns the sine of the specified angle. More... | |
double | SINH (double Angle) |
Returns the hyperbolic sine of the specified angle. More... | |
double | COS (double Angle) |
Returns the cosine of the specified angle. More... | |
double | COSH (double Angle) |
Returns the cosine of the specified angle. More... | |
double | TG (double Angle) |
Returns the tangent of the specified angle. More... | |
double | TGH (double Angle) |
Returns the hyperbolic tangent of the specified angle. More... | |
double | COTH (double Angle) |
Returns the cotangent of the specified angle. More... | |
double | ABS (double Value) |
Returns the absolute value of a specified number. More... | |
double | SQRT (double Value) |
Returns the square root of a specified number. More... | |
double | LN (double Value) |
Returns the natural (base 'e') logarithm of a specified number. More... | |
double | LOG (double Value) |
Returns the base 10 logarithm of a specified number. More... | |
double | LOG (double Value, double Base) |
Returns the logarithm of a specified number in a specified base. More... | |
double | SUM (params double[] Values) |
Returns sum of given numeric parameters. More... | |
double | AVERAGE (params double[] Values) |
Returns arithmetic averarge of given numeric parameters. More... | |
double | MIN (params double[] Values) |
Returns the smallest of given numbers. More... | |
double | MAX (params double[] Values) |
Returns the biggest of given numbers. More... | |
double | PARMIN (params double[] Values) |
Returns the smallest of given numbers. Draw vertical stack of given formulas to output. More... | |
double | PARMAX (params double[] Values) |
Returns the biggest of given numbers. Draw vertical stack of given formulas to output. More... | |
double | CEILING (double Value) |
Returns number rounded up, away from zero, to the nearest integer. More... | |
double | CEILING (double Value, double Significance) |
Returns number rounded up, away from zero, to the nearest multiple of significance. More... | |
double | FLOOR (double Value) |
Returns number rounded down, away from zero, to the nearest integer. More... | |
double | FLOOR (double Value, double Significance) |
Returns number rounded down, away from zero, to the nearest multiple of significance. More... | |
double | ROUND (double Value) |
Rounds a numeric value to the nearest integet. More... | |
double | ROUND (double Value, int Decimals) |
Rounds a numeric value to a specified number of fractional digits. More... | |
double | ROUND (double Value, int Decimals, string Unit) |
Rounds a numeric value to a specified number of fractional digits. Value is expressed in given physical units. More... | |
double | ROUNDUP (double Value) |
Rounds a numeric value UP to the nearest integet. More... | |
double | ROUNDUP (double Value, int Decimals) |
Rounds a numeric value UP to a specified number of fractional digits. More... | |
double | ROUNDUP (double Value, int Decimals, string Unit) |
Rounds a numeric value UP to a specified number of fractional digits. Value is expressed in given physical units. More... | |
double | ROUNDDOWN (double Value) |
Rounds a numeric value DOWN to the nearest integet. More... | |
double | ROUNDDOWN (double Value, int Decimals) |
Rounds a numeric value DOWN to a specified number of fractional digits. More... | |
double | ROUNDDOWN (double Value, int Decimals, string Unit) |
Rounds a numeric value DOWN to a specified number of fractional digits. Value is expressed in given physical units. More... | |
double | DIV (double I1, double I2) |
Calculates the quotient of two 32-bit signed integers. More... | |
double | MOD (double I1, double I2) |
Returns the remainder of two 32-bit signed integers. More... | |
double | ARCSIN (double Value) |
Returns the angle whose sine is the specified number. More... | |
double | ARCCOS (double Value) |
Returns the angle whose cosine is the specified number. More... | |
double | ARCTG (double Value) |
Returns the angle whose tangent is the specified number. More... | |
double | ARCTG (double X, double Y) |
Returns the angle whose tangent is the quotient of two specified numbers. More... | |
double | COMPARE (object O1, object O2) |
Compares two specified objects, and returns an integer that indicates their relative position in the sort order. More... | |
double | COMPARE (object O1, object O2, double Precision) |
double | LinInterp (double X, params Point[] Points) |
Linear interpolation on a set of data points (x0, y0), (x1, y1), ..., (xn, yn). Function returns concatenation of linear interpolants between each pair of data points. More... | |
double | LinExtrap (double X, PointD Point1, PointD Point2) |
Linear extrapolation on line specified by Point1 and Point2 More... | |
double | PointFromLine (object Point, object L1, object L2) |
Returns distance from given point to line defined by two points. More... | |
double | CUnit (double Value, string TargetUnit) |
Convert given value from source to target unit More... | |
double | CUnit (double Value, string TargetUnit, string SourceUnit) |
Convert given value from source to target unit More... | |
double | GetLength (object IList) |
Return length of given array (list). More... | |
bool | IsNaN (double Value) |
Returns a value that indicates whether the specified value is not a number (NaN). More... | |
bool | IsInfinity (double Value) |
Returns a value indicating whether the specified number evaluates to negative or positive infinity More... | |
bool | IsNegativeInfinity (double Value) |
Returns a value indicating whether the specified number evaluates to negative infinity. More... | |
bool | IsPositiveInfinity (double Value) |
Returns a value indicating whether the specified number evaluates to positive infinity. More... | |
bool | IsNullOrWhiteSpace (double Value) |
Indicates whether a specified string is null, empty, or consists only of white-space characters. More... | |
bool | IsNullOrEmpty (double Value) |
Indicates whether the specified string is null or an Empty string. More... | |
string | Description (string VariableName) |
Returns description of variable with given name. Description is automatically translated to the selected language. More... | |
string | Val (double D, int Precision) |
Reformats numeric input to required output with given precision. More... | |
string | LowIndex (string Value) |
Convert given string to lower index More... | |
string | UpIndex (string Value) |
Convert given string to upper index More... | |
string | RenameVar (object Variable, string NewDrawName) |
Change DrawName of given variable to the value defined by the second parameter. More... | |
string | TR (string Message) |
Return the translation of the message to the current language More... | |
void | Text (object Param) |
Add text to the graphical output More... | |
void | Img (string ImageID) |
Insert static (bitmap) image to the graphical output More... | |
void | Block () |
Creates new block in the graphical output More... | |
void | Block (string Caption) |
Creates new collapsible block in the graphical output More... | |
void | PageBreak () |
Insert PageBreak mark into output. More... | |
void | Break () |
Terminates the closest enclosing loop or while statement in which it appears. Control is passed to the statement that follows the terminated statement, if any. More... | |
void | Exit () |
Terminates calculation run. More... | |
void | Continue () |
The continue statement passes control to the next iteration of the enclosing while, for, or foreach statement in which it appears. More... | |
object | LoadExternCLC (string Path) |
Load and initialize calculation from extern file. More... | |
List< object > | Sort (object List, string PropertyName) |
Sort list of object by the property specified by name. More... | |
List< object > | Sort (object List, string PropertyName, bool Descendant) |
Sort list of object by the property specified by name. More... | |
RectangleF | GetBounds (object Points) |
Returns rectangle bounds of the specified list of points. More... | |
TStructure | SaveResults (eResultType ResultType, string Key) |
Save structured variable with all calculation results (defined by ESA_ID starting with 'Result.') to result-holder-node of IO structure More... | |
object | SaveResults (eResultType ResultType, string Key, object Value) |
Save user-defined value to result-holder-node of IO structure More... | |
object | ReadResults (eResultType ResultType) |
Returns complete results node from IO structure More... | |
object | ReadResults (eResultType ResultType, string Key) |
Reads results set with given key from IO..Results More... | |
bool | TryReadResults (eResultType ResultType, string Key, out object Value) |
Tries to read results from given result set More... | |
PointD[] | RoundPolyline (IList Points, double Radius, int Segments) |
Round polyline with given radius More... | |
object | GetDialogStructure () |
Return structure which contains all inputs from the dialog More... | |
System functions
double ABS | ( | double | Value | ) |
Returns the absolute value of a specified number.
Value | A number that is greater than or equal to Double.MinValue, but less than or equal to Double.MaxValue. |
double ARCCOS | ( | double | Value | ) |
Returns the angle whose cosine is the specified number.
Value | A number representing a cosine, where d must be greater than or equal to -1, but less than or equal to 1. |
double ARCSIN | ( | double | Value | ) |
Returns the angle whose sine is the specified number.
Value | A number representing a sine, where d must be greater than or equal to -1, but less than or equal to 1. |
double ARCTG | ( | double | Value | ) |
Returns the angle whose tangent is the specified number.
Value | A number representing a tangent. |
double ARCTG | ( | double | X, |
double | Y | ||
) |
Returns the angle whose tangent is the quotient of two specified numbers.
X | The X coordinate of a point. |
Y | The Y coordinate of a point. |
double AVERAGE | ( | params double[] | Values | ) |
Returns arithmetic averarge of given numeric parameters.
Values | Numeric expressions |
void Block | ( | ) |
Creates new block in the graphical output
void Block | ( | string | Caption | ) |
Creates new collapsible block in the graphical output
Caption | Caption of the collapsible block |
void Break | ( | ) |
Terminates the closest enclosing loop or while statement in which it appears. Control is passed to the statement that follows the terminated statement, if any.
double CEILING | ( | double | Value | ) |
Returns number rounded up, away from zero, to the nearest integer.
Value | Value to be rounded |
double CEILING | ( | double | Value, |
double | Significance | ||
) |
Returns number rounded up, away from zero, to the nearest multiple of significance.
Value | Value to be rounded |
Significance | Multiple to which you want to round. |
double COMPARE | ( | object | O1, |
object | O2 | ||
) |
Compares two specified objects, and returns an integer that indicates their relative position in the sort order.
O1 | First object to compare |
O2 | Second object to compare |
double COMPARE | ( | object | O1, |
object | O2, | ||
double | Precision | ||
) |
O1 | First object to compare |
O2 | Second object to compare |
Precision | Precision used to compare numeric values. Values are considered to be same, if relative difference is less than 1+Power(10, -Precision). Presision=3 => difference is less than 1.001 |
void Continue | ( | ) |
The continue statement passes control to the next iteration of the enclosing while, for, or foreach statement in which it appears.
double COS | ( | double | Angle | ) |
Returns the cosine of the specified angle.
Angle | An angle, measured in degrees. |
double COSH | ( | double | Angle | ) |
Returns the cosine of the specified angle.
Angle | An angle, measured in degrees. |
double COTH | ( | double | Angle | ) |
Returns the cotangent of the specified angle.
Angle | An angle, measured in degrees. |
double CUnit | ( | double | Value, |
string | TargetUnit | ||
) |
Convert given value from source to target unit
Value | Value to be converted |
TargetUnit | Unit to which the value should be transferred |
double CUnit | ( | double | Value, |
string | TargetUnit, | ||
string | SourceUnit | ||
) |
Convert given value from source to target unit
Value | Value to be converted |
TargetUnit | Unit to which the value should be transferred |
SourceUnit | Initial unit of the value |
string Description | ( | string | VariableName | ) |
Returns description of variable with given name. Description is automatically translated to the selected language.
VariableName | Name of variable |
double DIV | ( | double | I1, |
double | I2 | ||
) |
Calculates the quotient of two 32-bit signed integers.
I1 | The dividend. |
I2 | The divisor. |
void Exit | ( | ) |
Terminates calculation run.
double FLOOR | ( | double | Value | ) |
Returns number rounded down, away from zero, to the nearest integer.
Value | Value to be rounded |
double FLOOR | ( | double | Value, |
double | Significance | ||
) |
Returns number rounded down, away from zero, to the nearest multiple of significance.
Value | Value to be rounded |
Significance | Multiple to which you want to round. |
RectangleF GetBounds | ( | object | Points | ) |
Returns rectangle bounds of the specified list of points.
Points | List of points. Acceptable types: Point, PointF, PointD, structure. |
object GetDialogStructure | ( | ) |
Return structure which contains all inputs from the dialog
double GetLength | ( | object | IList | ) |
Return length of given array (list).
IList | Array whose length is to be measured. |
void Img | ( | string | ImageID | ) |
Insert static (bitmap) image to the graphical output
ImageID | Image identifier (set in image library) |
bool IsInfinity | ( | double | Value | ) |
Returns a value indicating whether the specified number evaluates to negative or positive infinity
Value | Value to test |
bool IsNaN | ( | double | Value | ) |
Returns a value that indicates whether the specified value is not a number (NaN).
Value | A double-precision floating-point number. |
bool IsNegativeInfinity | ( | double | Value | ) |
Returns a value indicating whether the specified number evaluates to negative infinity.
Value | Value to test |
bool IsNullOrEmpty | ( | double | Value | ) |
Indicates whether the specified string is null or an Empty string.
Value | String to test |
bool IsNullOrWhiteSpace | ( | double | Value | ) |
Indicates whether a specified string is null, empty, or consists only of white-space characters.
Value | String to test |
bool IsPositiveInfinity | ( | double | Value | ) |
Returns a value indicating whether the specified number evaluates to positive infinity.
Value | Value to test |
Linear extrapolation on line specified by Point1 and Point2
X | X-coordinate of extrapolated value |
Point1 | First point defining the extrapolation line |
Point2 | Second point defining the extrapolation line |
double LinInterp | ( | double | X, |
params Point[] | Points | ||
) |
Linear interpolation on a set of data points (x0, y0), (x1, y1), ..., (xn, yn). Function returns concatenation of linear interpolants between each pair of data points.
X | X value for linear interpolation. |
Points | Set of data points (x0, y0), (x1, y1), ..., (xn, yn). |
double LN | ( | double | Value | ) |
Returns the natural (base 'e') logarithm of a specified number.
Value | The number whose logarithm is to be found. |
object LoadExternCLC | ( | string | Path | ) |
Load and initialize calculation from extern file.
Path | Path to file containing required calculation. |
double LOG | ( | double | Value | ) |
Returns the base 10 logarithm of a specified number.
Value | A number whose logarithm is to be found. |
double LOG | ( | double | Value, |
double | Base | ||
) |
Returns the logarithm of a specified number in a specified base.
Value | The number whose logarithm is to be found. |
Base | The base of the logarithm. |
string LowIndex | ( | string | Value | ) |
Convert given string to lower index
Value | String value to be converted to lower index. |
double MAX | ( | params double[] | Values | ) |
Returns the biggest of given numbers.
Values | Array of numbers. |
double MIN | ( | params double[] | Values | ) |
Returns the smallest of given numbers.
Values | Array of numbers. |
double MOD | ( | double | I1, |
double | I2 | ||
) |
Returns the remainder of two 32-bit signed integers.
I1 | The dividend. |
I2 | The divisor. |
void PageBreak | ( | ) |
Insert PageBreak mark into output.
double PARMAX | ( | params double[] | Values | ) |
Returns the biggest of given numbers. Draw vertical stack of given formulas to output.
Values | Array of numbers. |
double PARMIN | ( | params double[] | Values | ) |
Returns the smallest of given numbers. Draw vertical stack of given formulas to output.
Values | Array of numbers. |
double PointFromLine | ( | object | Point, |
object | L1, | ||
object | L2 | ||
) |
Returns distance from given point to line defined by two points.
Point | Point. Acceptable types: Point, PointF, PointD, struct[X, Y]. |
L1 | First point on the line. Acceptable types: Point, PointF, PointD, struct[X, Y]. |
L2 | Second point on the lint. Acceptable types: Point, PointF, PointD, struct[X, Y]. |
double POWER | ( | double | Base, |
double | Exponent | ||
) |
Returns a specified number raised to the specified power.
Base | A double-precision floating-point number to be raised to a power. |
Exponent | A double-precision floating-point number that specifies a power. |
object ReadResults | ( | eResultType | ResultType | ) |
Returns complete results node from IO structure
ResultType | Result type which determines result place holder: ResultType.Member, ResultType.Place, ResultType.Combi |
object ReadResults | ( | eResultType | ResultType, |
string | Key | ||
) |
Reads results set with given key from IO..Results
ResultType | Result type which determines result place holder: ResultType.Member, ResultType.Place, ResultType.Combi |
Key | Key identifying results set in result place holder |
string RenameVar | ( | object | Variable, |
string | NewDrawName | ||
) |
Change DrawName of given variable to the value defined by the second parameter.
Variable | Variable whose DrawName is to be changed. |
NewDrawName | New DrawName of the variable. |
double ROUND | ( | double | Value | ) |
Rounds a numeric value to the nearest integet.
Value | A double-precision number to be rounded. |
double ROUND | ( | double | Value, |
int | Decimals | ||
) |
Rounds a numeric value to a specified number of fractional digits.
Value | A double-precision number to be rounded. |
Decimals | The number of decimal places in the return value. |
double ROUND | ( | double | Value, |
int | Decimals, | ||
string | Unit | ||
) |
Rounds a numeric value to a specified number of fractional digits. Value is expressed in given physical units.
Value | A double-precision number to be rounded. |
Decimals | The number of decimal places in the return value. |
Unit | Physical unit, in which the value is expressed |
double ROUNDDOWN | ( | double | Value | ) |
Rounds a numeric value DOWN to the nearest integet.
Value | A double-precision number to be rounded. |
double ROUNDDOWN | ( | double | Value, |
int | Decimals | ||
) |
Rounds a numeric value DOWN to a specified number of fractional digits.
Value | A double-precision floating-point number to be rounded. |
Decimals | A double-precision floating-point number to be rounded. |
double ROUNDDOWN | ( | double | Value, |
int | Decimals, | ||
string | Unit | ||
) |
Rounds a numeric value DOWN to a specified number of fractional digits. Value is expressed in given physical units.
Value | A double-precision number to be rounded. |
Decimals | The number of decimal places in the return value. |
Unit | Physical unit, in which the value is expressed |
PointD [] RoundPolyline | ( | IList | Points, |
double | Radius, | ||
int | Segments | ||
) |
Round polyline with given radius
Points | Polyline points |
Radius | Radius |
Segments | Number of segments in radius |
double ROUNDUP | ( | double | Value | ) |
Rounds a numeric value UP to the nearest integet.
Value | A double-precision number to be rounded. |
double ROUNDUP | ( | double | Value, |
int | Decimals | ||
) |
Rounds a numeric value UP to a specified number of fractional digits.
Value | A double-precision number to be rounded. |
Decimals | The number of decimal places in the return value. |
double ROUNDUP | ( | double | Value, |
int | Decimals, | ||
string | Unit | ||
) |
Rounds a numeric value UP to a specified number of fractional digits. Value is expressed in given physical units.
Value | A double-precision number to be rounded. |
Decimals | The number of decimal places in the return value. |
Unit | Physical unit, in which the value is expressed |
TStructure SaveResults | ( | eResultType | ResultType, |
string | Key | ||
) |
Save structured variable with all calculation results (defined by ESA_ID starting with 'Result.') to result-holder-node of IO structure
ResultType | Result type which determines result place holder: ResultType.Member, ResultType.Place, ResultType.Combi |
Key | Key used to identify result structure saved in given results node |
object SaveResults | ( | eResultType | ResultType, |
string | Key, | ||
object | Value | ||
) |
Save user-defined value to result-holder-node of IO structure
ResultType | Result type which determines result place holder: ResultType.Member, ResultType.Place, ResultType.Combi |
Key | Key used to identify value saved in given results node |
Value | Value saved under given key |
double SIN | ( | double | Angle | ) |
Returns the sine of the specified angle.
Angle | An angle, measured in degrees. |
double SINH | ( | double | Angle | ) |
Returns the hyperbolic sine of the specified angle.
Angle | An angle, measured in degrees. |
List<object> Sort | ( | object | List, |
string | PropertyName | ||
) |
Sort list of object by the property specified by name.
List | List of objects to sort. |
PropertyName | Case sensitive name of property used to sorting. |
List<object> Sort | ( | object | List, |
string | PropertyName, | ||
bool | Descendant | ||
) |
Sort list of object by the property specified by name.
List | List of objects to sort. |
PropertyName | Case sensitive name of property used to sorting. |
Descendant | True to descendant sorting. Otherwise false. |
double SQRT | ( | double | Value | ) |
Returns the square root of a specified number.
Value | The number whose square root is to be found. |
double SUM | ( | params double[] | Values | ) |
Returns sum of given numeric parameters.
Values | Numeric expressions |
void Text | ( | object | Param | ) |
Add text to the graphical output
Param | Text content |
double TG | ( | double | Angle | ) |
Returns the tangent of the specified angle.
Angle | An angle, measured in degrees. |
double TGH | ( | double | Angle | ) |
Returns the hyperbolic tangent of the specified angle.
Angle | An angle, measured in degrees. |
string TR | ( | string | Message | ) |
Return the translation of the message to the current language
Message | Message to be translated |
bool TryReadResults | ( | eResultType | ResultType, |
string | Key, | ||
out object | Value | ||
) |
Tries to read results from given result set
ResultType | Result type which determines result place holder: ResultType.Member, ResultType.Place, ResultType.Combi |
Key | Key identifying results set in result place holder |
Value | When this method returns, contains the value associated with the specified key, if the key is found; otherwise NULL. This parameter can be passed uninitialized. |
string UpIndex | ( | string | Value | ) |
Convert given string to upper index
Value | String value to be converted to upper index. |
string Val | ( | double | D, |
int | Precision | ||
) |
Reformats numeric input to required output with given precision.
D | Input numeric value or expression. |
Precision | Output precision. |