Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

Asset Framework and PI System Explorer (PI Server 2024 R2)

List of formula data reference functions

  • Last UpdatedDec 18, 2024
  • 2 minute read

PI AF supports the following functions in a formula data reference. For information on analyses expression functions, see Expression functions reference.

Function

Description

abs(X)

Absolute value of X.

acos(X)

Arc cosine of X.

asin(X)

Arc sine of X.

atan(X)

Arc tangent of X.

badval(x)

Returns 1 if the value has a bad status, has a floating point value of not a number (NaN), or is not a numeric value, otherwise returns 0.

ceiling(X)

Smallest integer not less than X.

cos(X)

Cosine of X.

cosh(X)

Hyperbolic cosine of X.

cot(X)

Cotangent of X.

coth(X)

Hyperbolic cotangent of X.

csc(X)

Cosecant of X.

csch(X)

Hyperbolic cosecant of X.

digstate()

Returns a system digital state value.

  • If successful, the system digital state is returned as a system enumeration value. For PI AF Client versions older than 2.4, the value is returned as a PI SDK digital state, because the system enumeration value set did not exist.

  • If unsuccessful, the value is returned as a string.

    In both cases, the AFValue.IsGood flag is set to false, and the attribute is flagged in the Attributes Viewer with the icon.

e()

Value of the natural logarithm base.

exp(X)

Natural logarithm base e raised to power of X.

floor(X)

Largest integer not greater than X.

ln(X)

Natural logarithm of X.

log(X)

Logarithm of X using base 10.

logbase(X,Y)

Logarithm of X using base Y.

max(X,Y)

Greater of X and Y.

min(X,Y)

Lesser of X and Y.

normalrnd(X,Y)

Random number that maps the normal distribution curve. X is the mean and Y is the standard deviation.

pi()

Value of pi.

poisson(X)

Random number that maps the Poisson distribution. X is the mean.

pow(X,Y)

X raised to the power of Y.

rand()

Uniform random number. The values can be between 0 and less than 1.0

rand(X,Y)

Uniform random number. The values can be between X-Y/2 and less than X+Y/2.

remainder(X,Y)

Returns the remainder resulting from the division of X by Y.

round(X)

X rounded to the nearest whole number.

roundfrac(X,Y)

X rounded to the number of fractional digits specified by Y. Y is an integer number.

sec(X)

Secant of X.

sech(X)

Hyperbolic secant of X.

sign(X)

Returns 1 if X is greater than zero and -1 if X is less than zero.

sin(X)

Sine of X.

sinh(X)

Hyperbolic sine of X.

sqrt(X)

Square root of X.

tan(X)

Tangent of X.

tanh(X)

Hyperbolic tangent of X.

TitleResults for “How to create a CRG?”Also Available in