class CTNumber

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=(LONG value)
CTNumber& operator=(CTFLOAT value)
CTNumber& operator=(pCTNUMBER value)
CTNumber& operator=(const CTMoney& value)
CTNumber& operator=(const CTString& value)
CTNumber& operator=(const CTBigint& value)
CTNumber& operator=(const CTCurrency& value)
CTNumber& operator=(const CTNumber& value)
CTNumber& operator+(const CTNumber& left, const CTNumber & right)
CTNumber& operator-(const CTNumber& left, const CTNumber & right)
CTNumber& operator*(const CTNumber& left, const CTNumber & right)
CTNumber& operator/(const CTNumber& left, const CTNumber & right)
CTNumber abs(const CTNumber& value)
CTNumber operator+(const CTNumber& left, const CTNumber& right)
CTNumber operator-(const CTNumber& left, const CTNumber& right)
CTNumber operator*(const CTNumber& left, const CTNumber& right)
CTNumber operator/(const CTNumber& left, const CTNumber& right)

Parameters

• value [in] long, double, CTNumber, CTMoney, CTBigint, CTCurrency, or CTString 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

CTBOOL operator < (const CTNumber& left, const CTNumber& right)
CTBOOL operator <= (const CTNumber& left, const CTNumber& right)
CTBOOL operator > (const CTNumber& left, const CTNumber& right)
CTBOOL operator >= (const CTNumber& left, const CTNumber& right)
CTBOOL operator == (const CTNumber& left, const CTNumber& right)
CTBOOL operator != (const CTNumber& left, const 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 YES or NO, 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 C CTNumber type
• AsMoney(): Converts a CTNumber object to a CTMoney object
• AsString(): Converts a CTNumber object to a CTString object
• AsBigint(): Converts a CTNumber to a big integer object.
• AsCurrency(): Converts CTNumber to a CTCurrency object.

CTNumber::CTNumber

Syntax

CTNumber( )
CTNumber(LONG value)
CTNumber(CTFLOAT value)
CTNumber(pCTNUMBER value)
CTNumber(const CTMoney& value)
CTNumber(const CTString& value)
CTNumber(const CTBigint& value)
CTNumber(const CTCurrency& value)
CTNumber(const 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( )  const

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

AsLong(), AsFloat()

CTNumber::AsCurrency

Syntax

CTCurrency AsCurrency( ) const

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

CTFLOAT AsFloat( )  const

Parameters

This method has no parameters.

Description

Converts a CTNumber object to double.

Return

AsFloat() returns the converted value in CTFLOAT format.

See also

AsLong(), AsBigint()

CTNumber::AsLong

Syntax

LONG AsLong( ) const

Parameters

This method has no parameters.

Description

Converts a CTNumber object to LONG.

Return

AsLong() returns the converted value in LONG format.

See also

AsFloat(), AsBigint()

CTNumber::AsMoney

Syntax

CTMoney AsMoney( ) const

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

pCTNUMBER AsNumber( )  const

Parameters

This method has no parameters.

Description

Retrieve the C CTNumber type.

Return

AsNumber() returns a CTNumber object.

See also

AsLong(), AsFloat()

CTNumber::AsString

Syntax

CTString AsString( ) const

Parameters

This method has no parameters.

Description

Converts a CTNumber object to a CTString object.

Return

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

See also

AsBigint()

CTNumber::DecimalDigits

Syntax

NINT DecimalDigits( )  const

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

NINT IntegralDigits( )  const

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

CTBOOL IsZero( ) const

Parameters

This method has no parameters.

Description

IsZero() indicates if a CTNumber value is zero.

Return

IsZero() returns YES if the CTNumber value is zero, NO otherwise.

See also

Zero()

CTNumber::Round

Syntax

CTNumber Round (NINT scale) const

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

IntegralDigits(), DecimalDigits()

CTNumber::SetNumber

Syntax

void SetNumber(LONG value)
void SetNumber(CTFLOAT value)
void SetNumber(const CTMoney&  value)
void SetNumber(const CTString& value)
void SetNumber(const CTBigint& value)
void SetNumber(const CTCurrency& value);
void SetNumber(const CTNumber& value);
void SetNumber(pCTNUMBER value);

Parameters

• value [in] The long, double, CTBigint, CTMoney, CTCurrency, CTNumber or CTString 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()