SourcePro® API Reference Guide

Product Documentation:
   SourcePro
Documentation Home
List of all members | Public Member Functions
RWDecimalOverflowErr< M > Class Template Reference

Signals overflow problems in computations involving the Rogue Wave decimal classes. More...

#include <rw/currency/decimal.h>

Inheritance diagram for RWDecimalOverflowErr< M >:
RWExternalErr RWxmsg

Public Member Functions

RWDecimal< M > leftOperand () const
 
const char * msg () const
 
RWDecimalBase::Op operation () const
 
RWDecimal< M > rightOperand () const
 
- Public Member Functions inherited from RWxmsg
 RWxmsg (const char *msg)
 
 RWxmsg (const RWxmsg &msg)
 
 RWxmsg (RWxmsg &&msg)
 
RWxmsgoperator= (const RWxmsg &)
 
RWxmsgoperator= (RWxmsg &&msg)
 
virtual void raise () const
 
void swap (RWxmsg &rhs)
 
virtual const char * why () const
 

Additional Inherited Members

- Protected Member Functions inherited from RWxmsg
 RWxmsg (const char *msg, bool doCopy)
 

Detailed Description

template<class M>
class RWDecimalOverflowErr< M >

RWDecimalOverflowErr is one of the error objects used to signal problems in computations involving RWDecimal and RWFixedDecimal objects. The other error object is RWDecimalInexactErr. See RWDecimal and RWFixedDecimal for details about when the error objects are used. Also, see the section on error handling in the Currency Module User's Guide for information about how to set error handlers.

Synopsis
#include <rw/currency/decimal.h> // for RWDecimalOverflowErr<T>
// and RWDecimalInexactErr<T>
#include <rw/currency/mp2int.h> // For RWMP2Int
RWDecimal<RWMP2Int> x = "9999999999";
RWDecimal<RWMP2Int> y = x*x; // calls the overflow error handler

The following header files are available for backward compatibility:

#include <rw/dec52.h> // RWDecimal52InexactErr,
// RWDecimal52OverflowErr
#include <rw/dec64.h> // RWDecimal64InexactErr,
// RWDecimal64OverflowErr
#include <rw/dec96.h> // RWDecimal96InexactErr,
// RWDecimal96OverflowErr

Member Function Documentation

template<class M >
RWDecimal<M> RWDecimalOverflowErr< M >::leftOperand ( ) const
inline

Returns the left operand of the operation that generated the error object.

template<class M >
const char* RWDecimalOverflowErr< M >::msg ( ) const
inline

Returns a message describing the error.

template<class M >
RWDecimalBase::Op RWDecimalOverflowErr< M >::operation ( ) const
inline

Returns the operation that generated the error object. The returned value RWDecimalBase::Op is an enumerated type scoped in the RWDecimalBase class.

template<class M >
RWDecimal<M> RWDecimalOverflowErr< M >::rightOperand ( ) const
inline

Returns the right operand of the operation that generated the error object.

Copyright © 2021 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.