class CTCurrency

Description

The CTCurrency class represents Currency objects. Currency objects are 64-bit integers representing currency values.

See Also

CTMoney, CTString

Preconditions

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

CTCurrency Operators

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

CTCurrency::operator =, +=, -=, *=, /=, abs, +, -, *, /

Syntax

CTCurrency& operator=(LONG value)
CTCurrency& operator=(CTFLOAT value)
CTCurrency& operator=(CTCURRENCY value)
CTCurrency& operator=(const CTMoney& value)
CTCurrency& operator=(const CTString& value)
CTCurrency& operator=(const CTBigint& value)
CTCurrency& operator=(const CTCurrency& value)
CTCurrency& operator+=(const CTCurrency& value)
CTCurrency& operator-=(const CTCurrency& value)
CTCurrency& operator*=(const CTCurrency& value)
CTCurrency& operator/=(const CTCurrency& value)
CTCurrency& operator abs(const CTCurrency& value)
CTCurrency& operator +(const CTCurrency& left, const CTCurrency& right)
CTCurrency& operator -(const CTCurrency& left, const CTCurrency& right)
CTCurrency& operator *(const CTCurrency& left, const CTCurrency& right)
CTCurrency& operator /(const CTCurrency& left, const CTCurrency& right)

Parameters

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

Description

Assigns or concatenates values to form a CTCurrency object

Return

The new CTCurrency object

CTCurrency::operator <, <=, >, >=, ==, !=

Syntax

CTBOOL operator < (const CTCurrency& left, const CTCurrency& right)
CTBOOL operator <= (const CTCurrency& left, const CTCurrency& right)
CTBOOL operator > (const CTCurrency& left, const CTCurrency& right)
CTBOOL operator >= (const CTCurrency& left, const CTCurrency& right)
CTBOOL operator == (const CTCurrency& left, const CTCurrency& right)
CTBOOL operator != (const CTCurrency& left, const CTCurrency& right)

Parameters

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

Description

These overloaded operators make comparisons between two CTCurrency objects.

Return

The operators return YES or NO, depending on the result of the comparison.

CTCurrency Methods

Constructor / Destructor

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

Currency Handling

• IsZero(): Indicates if a currency value is zero
• Zero(): Sets a currency value to zero
• SetCurrency(): Initializes the CTCurrency object.
• AsFloat(): Converts a CTCurrency object to float
• AsLong(): Converts a CTCurrency object to long
• AsBigint(): Converts a CTCurrency object to big integer
• AsCurrency(): Retrieves the C currency type
• AsMoney(): Converts a CTCurrency object to a CTMoney object
• AsString(): Converts a CTCurrency object to a CTString object
• StringToCurrency(): Converts a CTString object to a CTCurrency object

CTCurrency::CTCurrency

Syntax

CTCurrency  ( )
CTCurrency (LONG value)
CTCurrency (CTFLOAT value)
CTCurrency (CTCURRENCY value)
CTCurrency(const CTMoney& value)
CTCurrency(const CTString& value)
CTCurrency(const CTBigint& value)
CTCurrency(const CTCurrency& value)

Parameters

• value: [in] The LONG, double, CTCurrency, CTMoney, CTString, CTBigint or CTCurrency value or object to be converted and assigned to the new CTCurrency object

Description

This is the constructor for the CTCurrency object.

See also

~CTCurrency()

CTCurrency::~CTCurrency

Syntax

~CTCurrency

Parameters

This destructor has no parameters.

Description

This is the destructor for the CTCurrency object.

See also

CTCurrency()

CTCurrency::AsBigint

Syntax

CTBigint AsBigint( )  const

Parameters

This method has no parameters.

Description

Convert a CTCurrency object to big integer.

Return

AsBigint() returns the converted value in big integer (64-bit) format.

See also

AsLong(), AsFloat()

CTCurrency::AsCurrency

Syntax

CTCURRENCY AsCurrency( ) const

Parameters

This method has no parameters.

Description

Retrieve the C currency type.

Return

AsCurrency() returns a CTCURRENCY type.

See also

AsString()

CTCurrency::AsFloat

Syntax

CTFLOAT AsFloat  const

Parameters

This method has no parameters.

Description

Converts a CTCurrency object to CTFLOAT.

Return

AsFloat() returns the converted value in CTFLOAT format.

See also

AsLong(), AsBigint()

CTCurrency::AsLong

Syntax

LONG AsLong( ) const

Parameters

This method has no parameters.

Description

Converts a CTCurrency object to LONG.

Return

AsLong() returns the converted value in LONG format.

See also

AsFloat(), AsBigint()

CTCurrency::AsMoney

Syntax

CTMoney AsMoney( ) const

Parameters

This method has no parameters.

Description

Convert a CTCurrency object (64-bit) to a CTMoney object (32-bit).

Return

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

See also

AsString()

CTCurrency::AsString

Syntax

CTString AsString( ) const

Parameters

This method has no parameters.

Description

Converts a CTCurrency object to a CTString object.

Return

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

See also

StringToCurrency(), AsCurrency()

CTCurrency::IsZero

Syntax

CTBOOL IsZero( ) const

Parameters

This method has no parameters.

Description

IsZero() indicates if a currency value is zero.

Return

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

See also

Zero()

CTCurrency::Round

Syntax

CTCurrency Round (NINT scale) const

Parameters

• scale [in] the number of decimal places.

Description

Rounds a CTCurrency to a specified number of decimal places.

Return

Round returns the rounded CTCurrency.

See also

AsString(), SetCurrency()

CTCurrency::SetCurrency

Syntax

void SetCurrency(LONG value)
void SetCurrency(CTFLOAT value)
void SetCurrency(const CTMoney&  value)
void SetCurrency(const CTString& value)
void SetCurrency(const CTBigint& value)

Parameters

• value [in] The LONG, double, CTCurrency, CTMoney, CTString, CTBigint or CTCurrency value or object to be converted and assigned to the CTCurrency object

Description

Initializes the CTCurrency object.

Return

None.

See also

Zero()

CTCurrency::StringToCurrency

Syntax

void StringToCurrency(const CTString& str)

Parameters

• str [in] The string object to be converted.

Description

StringToCurrency() converts a CTString object to a CTCurrency object.

Return

None.

See also

AsString()

CTCurrency::Zero

Syntax

void Zero ( )

Parameters

This method has no parameters.

Description

Zero() sets a CTCurrency object value to zero.

Return

None.

See also

IsZero()