Class TFunctionStringList

Unit

RbwParser

Declaration

type TFunctionStringList = class(TStringList)

Description

TFunctionStringList maintains a sorted list of TFunctionClasses.

In the functions below, except where otherwise noted, angles are expressed in radians.

The following functions are included:

• AbsI(Value) returns the absolute value of Value. Value must be an integer. The value returned by AbsI will be an integer.

• AbsR(Value) returns the absolute value of Value. Value can be either an integer or a real number. The value returned by AbsR will be a real number.

• ArcCos(Value) returns the inverse cosine of Value. The return value is in the range from zero to Pi.

• ArcCosh(Value) returns the inverse hyperbolic cosine of Value.

• ArcSin(Value) returns the inverse sine of Value. The return value is in the range from -Pi/2 to +Pi/2.

• ArcSinh(Value) returns the inverse hyperbolic sine of Value.

• ArcTan2(Y, X) returns the inverse tangent of Y/X in the correct quadrant. The return value is in the range from -Pi to +Pi.

• ArcTanh(Value) returns the inverse hyperbolic tangent of Value.

• CaseB(Index, Boolean_Result1, Boolean_Result2, ...) is like Case except that it always returns a Boolean.

• CaseI(Index, Integer_Result1, Integer_Result2, ...)  is like Case except that it always returns an integer.

• CaseR(Index, Real_Result1, Real_Result2, ...)  is like Case except that it always returns a real number.

• CaseT(Index, Text_Result1, Text_Result2, ...).  is like Case except that it always returns text.  CaseS is a synonym for CaseT.

• Copy(Text_Value, StartIndex, Count) returns a substring of text_Value starting at the character indicated by StartIndex and extending for either Count characters or until the end text_Value is reached whichever is smaller.

• Cos(Value) returns the cosine of Value.

• Cosh(Value) returns the hyperbolic cosine of Value.

• DegToRad(Value) converts Value from degrees to radians. See also RadToDeg.

• Distance(X1, Y1, X2, Y2) calculates the distance between points (X1, Y1) and (X2, Y2).

• FactorialI(Value_Less_than_13) returns the factorial of Value_Less_than_13 as an integer.

• FactorialR(Value_Less_than_171) returns the factorial of Value_Less_than_171 as a real number.

• FloatToText(Value) converts the real number Value to its string representation. FloatToStr is a synonym for FloatToText.

• Frac(Value) returns the fractional part of Value. Value is a real number.

• IfB(Boolean_Value, If_True_Boolean_Result, If_False_Boolean_Result)  is like If except that it always returns a Boolean.

• IfI(Boolean_Value, If_True_Integer_Result, If_False_Integer_Result) is like If except that it always returns an integer.

• IfR(Boolean_Value, If_True_Real_Result, If_False_Real_Result) is like If except that it always returns a real number.

• IfT(Boolean_Value, If_True_Text_Result, If_False_Text_Result) is like If except that it always returns text.  IfS is a synonym for IfT.

• Interpolate(Position, Value1, Distance1, Value2, Distance2). Interpolate returns

  (Position-Distance1)/(Distance2-Distance1)*(Value2-Value1)+Value1.

  As its name implies, this is an interpolation between Value1 and Value2 based on where Position is between Distance1 and Distance2. See also MultiInterpolate.

• IntPower(Base, Exponent) returns Base raised to the Exponent power. Base must be a real number or integer. Exponent must be an integer. IntPower returns a real number. See also Power.

• IntToText(Value) converts the integer number Value to its string representation. IntToStr is a synonym for IntToText.

• Length(Text_Value) returns the number of characters in text_Value.

• ln(Value) returns the natural log of Value.

• log10(Value) returns the log to the base 10 of Value.

• logN(BaseN, Value) returns the log to the base BaseN of Value.

• LowerCase(Text_Value) returns text_Value with all its characters converted to lower case. See also: UpperCase.

• MaxI(Integer_Value1, Integer_Value2, ...) returns whichever of its arguments is the largest. Its arguments must be integers. The result will be an integer.

• MaxR(Real_Value1, Real_Value2, ...) returns whichever of its arguments is the largest. Its arguments must be either integers or real numbers. The result will be a real number.

• MinI(Integer_Value1, Integer_Value2, ...) returns whichever of its arguments is the smallest. Its arguments must be integers. The result will be an integer.

• MinR(Real_Value1, Real_Value2, ...) returns whichever of its arguments is the smallest. Its arguments must be either integers or real numbers. The result will be a real number.

• Odd(Value) returns True if Value is an odd number. Otherwise it returns False. Value must be an integer.

• Pi returns the ratio of the circumference of a circle to its diameter.

• Pos(SubString, StringValue) returns the position of the first instance of SubString within StringValue. If Substring does not occur within StringValue, Pos returns 0.

• PosEx(SubText, Text_Value, Offset) returns the position of the first instance of SubText within Text_Value that starts on or after Offset. If SubText does not occur within Text_Value, on or after Offset, PosEx returns 0. If Offset equals one, PosEx is equivalent to Pos.

• Power(Base, Exponent) returns Base raised to the Exponent power. Base and Exponent must be real numbers or integers. Power returns a real number. See also IntPower.

• RadToDeg(Value) converts Value from radians to degrees. See also DegToRad.

• Round(Value) converts Value to the nearest integer. In the case of a number that is exactly halfway between two integers, it converts it to whichever one is even. See also Trunc.

• Sin(Value) returns the sine of Value.

• Sinh(Value) returns the hyperbolic sine of Value.

• SqrI(Integer_Value) returns integer_Value squared. Integer_Value must be an integer. The result of SqrI will be an integer.

• SqrR(Real_Value) returns real_Value squared. Real_Value can be either an integer or a real number. The result of SqrR will be a real number.

• Sqrt(Value) returns the square root of Value.

• TextToFloat(Text_Value) converts text_Value to a real number. If text_Value can not be converted, TextToFloat causes an error. StrToFloat is a synonym for TextToFloat.

• TextToFloatDef(Text_Value, DefaultResult) converts text_Value to a real number. If text_Value can not be converted, DefaultResult is returned instead. StrToFloatDef is a synonym for TextToFloatDef.

• TextToInt(Text_Value) converts text_Value to an integer. If text_Value can not be converted, TextToInt causes an error. StrToInt is a synonym for TextToInt.

• TextToIntDef(Text_Value, DefaultResult) converts text_Value to an integer. If text_Value can not be converted, DefaultResult is returned instead. StrToIntDef is a synonym for TextToIntDef.

• Tan(Value) returns the tangent of Value.

• Tanh(Value) returns the hyperbolic tangent of Value.

• Trim(Text_Value) removes leading and trailing spaces and control characters from Value.

• Trunc(Value) truncates Value to an integer by rounding it towards zero. See also Round.

• UpperCase(Text_Value) returns text_Value with all its characters converted to upper case. See also LowerCase.

Hierarchy

• TStringList
• TFunctionStringList

Overview

Methods

	function GetFunctionClass(const Index: integer): TFunctionClass;
	function Add(const FunctionRecord: TFunctionRecord): Integer; reintroduce;
	procedure Clear; override;
	constructor Create;
	procedure Delete(Index: Integer); override;
	destructor Destroy; override;

Properties

property FunctionClass[constIndex:integer]: TFunctionClass read GetFunctionClass;

Description

Methods

	function GetFunctionClass(const Index: integer): TFunctionClass;
See FunctionClass.

	function Add(const FunctionRecord: TFunctionRecord): Integer; reintroduce;
Add creates a TFunctionClass based on FunctionRecord, calls the TStringList.AddObject method using the function name and the TFunctionClass and returns the TFunctionClass that it created. Any TFunctionClass created in this way is owned by the TFunctionStringList.

	procedure Clear; override;
Clear sets the number of items in the TFunctionStringList to 0 and Free's all the TFunctionClass it created.

	constructor Create;
Create creates a TFunctionStringList and also creates a variety of TFunctionClass'es. Users should not generally call Create directly but instead use the TFunctionStringList already created in TRbwParser.Functions.

	procedure Delete(Index: Integer); override;
Delete destroys the TFunctionClass at the position Index.

	destructor Destroy; override;
Destroy destroys the TFunctionStringList. Do not call Destroy directly. Call Free instead.

Properties

	property FunctionClass[constIndex:integer]: TFunctionClass read GetFunctionClass;
FunctionClass returns the TFunctionClass at position index.