Description

The CTNumber class represents number objects.

Preconditions

This is one of the basic objects from the c-tree database layer.

CTNumber Operators

• operator =, +=, -=, *=, /=, abs, +, -, *, / : Assignment and arithmetic operators
• operator <, <=, >, >=, ==, != : Comparison operators

CTNumber.operator =, +, -, (, /, abs

Syntax

CTNumber operator=(int value)

CTNumber operator=(double value)

CTNumber operator=(ctdbNUMBER value)

CTNumber operator=(CTMoney value)

CTNumber operator=(String value)

CTNumber operator=(CTBigint value)

CTNumber operator=(CTCurrency value)

CTNumber operator=(CTNumber value)

CTNumber operator+(CTNumber left, CTNumber right)

CTNumber operator-(CTNumber left, CTNumber right)

CTNumber operator*(CTNumber left, CTNumber right)

CTNumber operator/(CTNumber left, CTNumber right)

CTNumber abs(CTNumber value)

CTNumber operator+(CTNumber left, CTNumber right)

CTNumber operator-(CTNumber left, CTNumber right)

CTNumber operator*(CTNumber left, CTNumber right)

CTNumber operator/(CTNumber left, CTNumber right)

Parameters

• value [in] long, double, CTNumber, CTMoney, CTBigint, CTCurrency, or String value or object to be assigned to or updated with the new CTNumber object.
• left [in] The left CTNumber object to be concatenated to form the new CTNumber object
• right [in] The right CTNumber object to be concatenated to form the new CTNumber object

Description

Assigns or concatenates values to form a CTNumber object

Return

The new CTNumber object

CTNumber.operator <, <=, >, >=, ==, !=

Syntax

bool operator < ( CTNumber left, CTNumber right)

bool operator <= ( CTNumber left, CTNumber right)

bool operator > ( CTNumber left, CTNumber right)

bool operator >= ( CTNumber left, CTNumber right)

bool operator == ( CTNumber left, CTNumber right)

bool operator != ( CTNumber left, CTNumber right)

Parameters

• left [in] The left CTNumber object to be compared
• right [in] The right CTNumber object to be compared

Description

These overloaded operators make comparisons between the CTNumber objects.

Return

The operators return true or false, depending on the result of the comparison.

CTNumber Methods

Constructor / Destructor

• CTNumber(): Creates a CTNumber object
• ~CTNumber(): Destroys a CTNumber object and resets all the dependent objects

Date Handling

• IsZero(): Indicate if a CTNumber value is zero
• Zero(): Set a CTNumber value to zero
• SetNumber(): Initializes the CTNumber object.
• Round(): Rounds the CTNumber to a specified number of decimal places
• DecimalDigits(): Retrieves the number of digits after the decimal point.
• IntegralDigits(): Retrieves the number of digits before the decimal point.
• AsFloat(): Converts a CTNumber object to double
• AsLong(): Converts a CTNumber object to long
• AsNumber(): Retrieves the CTNumber type
• AsMoney(): Converts a CTNumber object to a CTMoney object
• AsString(): Converts a CTNumber object to a String object
• AsBigint(): Converts a CTNumber to a big integer object.
• AsCurrency(): Converts CTNumber to a CTCurrency object.

CTNumber.CTNumber

Syntax

CTNumber( )

CTNumber(int value)

CTNumber(double value)

CTNumber(ctdbNUMBER value)

CTNumber( CTMoney value)

CTNumber( String value)

CTNumber( CTBigint value)

CTNumber( CTCurrency value)

CTNumber( CTNumber value)

Parameters

• value [in] the value to be initially assigned to the new CTNumber object.

Description

This is the constructor for the CTNumber object.

See Also

~CTNumber()

CTNumber.~CTNumber

Syntax

~CTNumber

Parameters

This destructor has no parameters.

Description

This is the destructor for the CTNumber object.

See Also

CTNumber()

CTNumber.AsBigint

Syntax

CTBigint AsBigint( )

Parameters

This method has no parameters.

Description

Convert CTNumber to a big integer object.

Return

AsBigint() returns the converted CTNumber value as a big integer object.

See Also

AsFloat(), AsLong()

CTNumber.AsCurrency

Syntax

CTCurrency AsCurrency( )

Parameters

This method has no parameters.

Description

Convert CTNumber to CTCurrency.

Return

AsCurrency() returns the converted CTNumber value as a CTCurrency object.

See Also

AsString()

CTNumber.AsFloat

Syntax

Single AsFloat( )

Parameters

This method has no parameters.

Description

Converts a CTNumber object to Single.

Return

AsFloat() returns the converted value in CTFLOAT (Single) format.

See Also

AsBigint(), AsLong()

CTNumber.AsLong

Syntax

long AsLong( )

Parameters

This method has no parameters.

Description

Converts a CTNumber object to long.

Return

AsLong() returns the converted value in long format.

See Also

AsBigint(), AsFloat()

CTNumber.AsMoney

Syntax

CTMoney AsMoney( )

Parameters

This method has no parameters.

Description

Convert CTNumber to CTMoney.

Return

AsMoney() returns the converted CTNumber value as a CTMoney object.

See Also

AsString()

CTNumber.AsNumber

Syntax

ctdbNUMBER AsNumber( )

Parameters

This method has no parameters.

Description

Retrieve the ctdbNUMBER type.

Return

AsNumber() returns a ctdbNUMBER object.

See Also

AsFloat(), AsLong()

CTNumber.AsString

Syntax

String AsString( )

Parameters

This method has no parameters.

Description

Converts a CTNumber object to a String object.

Return

AsString() returns a String object with the CTNumber value.

See Also

AsBigint()

CTNumber.DecimalDigits

Syntax

int DecimalDigits( )

Parameters

This method has no parameters.

Description

DecimalDigits() gets the number of digits after the decimal point.

Return

DecimalDigits() returns the number of digits after the decimal point.

See Also

IntegralDigits(), Round()

CTNumber.IntegralDigits

Syntax

int IntegralDigits( )

Parameters

This method has no parameters.

Description

IntegralDigits() gets the number of digits before the decimal point.

Return

IntegralDigits() returns the number of digits before the decimal point.

See Also

DecimalDigits(), Round()

CTNumber.IsZero

Syntax

bool IsZero( )

Parameters

This method has no parameters.

Description

IsZero() indicates if a CTNumber value is zero.

Return

IsZero() returns true if the CTNumber value is zero, false otherwise.

See Also

Zero()

CTNumber.Round

Syntax

CTNumber Round (int scale)

Parameters

• scale [in] the number of decimal places.

Description

Rounds a number to a specified number of decimal places.

Return

Round returns the rounded number.

See Also

DecimalDigits(), IntegralDigits()

CTNumber.SetNumber

Syntax

void SetNumber(int value)

void SetNumber(double value)

void SetNumber( CTMoney value)

void SetNumber( String value)

void SetNumber( CTBigint value)

void SetNumber( CTCurrency value);

void SetNumber( CTNumber value);

void SetNumber( ctdbNUMBER value);

Parameters

• value [in] The int, double, CTBigint, CTMoney, CTCurrency, CTNumber or String value or object to be converted and assigned to the new CTNumber object

Description

Initializes the CTNumber object.

Return

None.

See Also

Zero()

CTNumber.Zero

Syntax

void Zero()

Parameters

This method has no parameters.

Description

Zero sets a CTNumber value to zero.

Return

None.

See Also

IsZero()