ripple::XRPAmount Class Reference

Inheritance diagram for ripple::XRPAmount:

Collaboration diagram for ripple::XRPAmount:

Public Types
using	unit_type = feeunit::dropTag
using	value_type = std::int64_t

Public Member Functions
	XRPAmount ()=default
constexpr	XRPAmount (XRPAmount const &other)=default
constexpr XRPAmount &	operator= (XRPAmount const &other)=default
constexpr	XRPAmount (beast::Zero)
constexpr XRPAmount &	operator= (beast::Zero)
constexpr	XRPAmount (value_type drops)
XRPAmount &	operator= (value_type drops)
constexpr XRPAmount	operator* (value_type const &rhs) const
XRPAmount &	operator+= (XRPAmount const &other)
XRPAmount &	operator-= (XRPAmount const &other)
XRPAmount &	operator+= (value_type const &rhs)
XRPAmount &	operator-= (value_type const &rhs)
XRPAmount &	operator*= (value_type const &rhs)
XRPAmount	operator- () const
bool	operator== (XRPAmount const &other) const
bool	operator== (value_type other) const
bool	operator< (XRPAmount const &other) const
constexpr	operator bool () const noexcept
	Returns true if the amount is not zero. More...
constexpr int	signum () const noexcept
	Return the sign of the amount. More...
constexpr value_type	drops () const
	Returns the number of drops. More...
constexpr double	decimalXRP () const
template<class Dest >
std::optional< Dest >	dropsAs () const
template<class Dest >
Dest	dropsAs (Dest defaultValue) const
template<class Dest >
Dest	dropsAs (XRPAmount defaultValue) const
Json::Value	jsonClipped () const
constexpr value_type	value () const
	Returns the underlying value. More...

Static Public Member Functions
static XRPAmount	minPositiveAmount ()

Private Attributes
value_type	drops_

Friends
constexpr friend XRPAmount	operator* (value_type lhs, XRPAmount const &rhs)
std::istream &	operator>> (std::istream &s, XRPAmount &val)

Detailed Description

Definition at line 46 of file XRPAmount.h.

Member Typedef Documentation

unit_type

using ripple::XRPAmount::unit_type = feeunit::dropTag

Definition at line 52 of file XRPAmount.h.

value_type

using ripple::XRPAmount::value_type = std::int64_t

Definition at line 53 of file XRPAmount.h.

Constructor & Destructor Documentation

XRPAmount() [1/4]

ripple::XRPAmount::XRPAmount ( )

default

XRPAmount() [2/4]

constexpr ripple::XRPAmount::XRPAmount ( XRPAmount const &  other )

constexprdefault

XRPAmount() [3/4]

constexpr ripple::XRPAmount::XRPAmount ( beast::Zero  )

constexpr

Definition at line 64 of file XRPAmount.h.

XRPAmount() [4/4]

constexpr ripple::XRPAmount::XRPAmount ( value_type  drops )

explicitconstexpr

Definition at line 74 of file XRPAmount.h.

Member Function Documentation

operator=() [1/3]

constexpr XRPAmount& ripple::XRPAmount::operator= ( XRPAmount const &  other )

constexprdefault

operator=() [2/3]

constexpr XRPAmount& ripple::XRPAmount::operator= ( beast::Zero  )

constexpr

Definition at line 68 of file XRPAmount.h.

operator=() [3/3]

XRPAmount& ripple::XRPAmount::operator=

(

value_type

drops

)

Definition at line 79 of file XRPAmount.h.

operator*()

constexpr XRPAmount ripple::XRPAmount::operator* ( value_type const &  rhs ) const

constexpr

Definition at line 86 of file XRPAmount.h.

operator+=() [1/2]

XRPAmount& ripple::XRPAmount::operator+=

(

XRPAmount const &

other

)

Definition at line 99 of file XRPAmount.h.

operator-=() [1/2]

XRPAmount& ripple::XRPAmount::operator-=

(

XRPAmount const &

other

)

Definition at line 106 of file XRPAmount.h.

operator+=() [2/2]

XRPAmount& ripple::XRPAmount::operator+=

(

value_type const &

rhs

)

Definition at line 113 of file XRPAmount.h.

operator-=() [2/2]

XRPAmount& ripple::XRPAmount::operator-=

(

value_type const &

rhs

)

Definition at line 120 of file XRPAmount.h.

operator*=()

XRPAmount& ripple::XRPAmount::operator*=

(

value_type const &

rhs

)

Definition at line 127 of file XRPAmount.h.

operator-()

XRPAmount ripple::XRPAmount::operator-

(

)

const

Definition at line 134 of file XRPAmount.h.

operator==() [1/2]

bool ripple::XRPAmount::operator==

(

XRPAmount const &

other

)

const

Definition at line 140 of file XRPAmount.h.

operator==() [2/2]

bool ripple::XRPAmount::operator==

(

value_type

other

)

const

Definition at line 146 of file XRPAmount.h.

operator<()

bool ripple::XRPAmount::operator<

(

XRPAmount const &

other

)

const

Definition at line 152 of file XRPAmount.h.

operator bool()

constexpr ripple::XRPAmount::operator bool ( ) const

explicitconstexprnoexcept

Returns true if the amount is not zero.

Definition at line 158 of file XRPAmount.h.

signum()

constexpr int ripple::XRPAmount::signum ( ) const

constexprnoexcept

Return the sign of the amount.

Definition at line 165 of file XRPAmount.h.

drops()

constexpr value_type ripple::XRPAmount::drops ( ) const

constexpr

Returns the number of drops.

Definition at line 172 of file XRPAmount.h.

decimalXRP()

constexpr double ripple::XRPAmount::decimalXRP ( ) const

constexpr

Definition at line 253 of file XRPAmount.h.

dropsAs() [1/3]

template<class Dest >

std::optional<Dest> ripple::XRPAmount::dropsAs

(

)

const

Definition at line 182 of file XRPAmount.h.

dropsAs() [2/3]

template<class Dest >

Dest ripple::XRPAmount::dropsAs

(

Dest

defaultValue

)

const

Definition at line 196 of file XRPAmount.h.

dropsAs() [3/3]

template<class Dest >

Dest ripple::XRPAmount::dropsAs

(

XRPAmount

defaultValue

)

const

Definition at line 203 of file XRPAmount.h.

jsonClipped()

Json::Value ripple::XRPAmount::jsonClipped

(

)

const

Definition at line 209 of file XRPAmount.h.

value()

constexpr value_type ripple::XRPAmount::value ( ) const

constexpr

Returns the underlying value.

Code SHOULD NOT call this function unless the type has been abstracted away, e.g. in a templated function.

Definition at line 230 of file XRPAmount.h.

minPositiveAmount()

static XRPAmount ripple::XRPAmount::minPositiveAmount ( )

static

Definition at line 243 of file XRPAmount.h.

Friends And Related Function Documentation

operator*

constexpr friend XRPAmount operator* ( value_type  lhs, XRPAmount const &  rhs  )

friend

Definition at line 92 of file XRPAmount.h.

operator>>

std::istream& operator>> ( std::istream &  s, XRPAmount &  val  )

friend

Definition at line 236 of file XRPAmount.h.

Member Data Documentation

drops_

value_type ripple::XRPAmount::drops_

private

Definition at line 56 of file XRPAmount.h.