sysio::chain::asset Struct Reference

#include <asset.hpp>

Inheritance diagram for sysio::chain::asset:

Collaboration diagram for sysio::chain::asset:

Public Member Functions
	asset (share_type a=0, symbol id=symbol(CORE_SYMBOL))
bool	is_amount_within_range () const
bool	is_valid () const
double	to_real () const
uint8_t	decimals () const
string	symbol_name () const
int64_t	precision () const
const symbol &	get_symbol () const
share_type	get_amount () const
string	to_string () const
asset &	operator+= (const asset &o)
asset &	operator-= (const asset &o)
asset	operator- () const
void	reflector_init () const

Static Public Member Functions
static asset	from_string (const string &from)

Static Public Attributes
static constexpr int64_t	max_amount = (1LL << 62) - 1

Friends
struct	fc::reflector< asset >
bool	operator== (const asset &a, const asset &b)
bool	operator< (const asset &a, const asset &b)
bool	operator<= (const asset &a, const asset &b)
bool	operator!= (const asset &a, const asset &b)
bool	operator> (const asset &a, const asset &b)
bool	operator>= (const asset &a, const asset &b)
asset	operator- (const asset &a, const asset &b)
asset	operator+ (const asset &a, const asset &b)
std::ostream &	operator<< (std::ostream &out, const asset &a)

Detailed Description

asset includes amount and currency symbol

asset::from_string takes a string of the form "10.0000 CUR" and constructs an asset with amount = 10 and symbol(4,"CUR")

Definition at line 17 of file asset.hpp.

Constructor & Destructor Documentation

asset()

sysio::chain::asset::asset ( share_type a = 0, symbol id = symbol(CORE_SYMBOL) )

inlineexplicit

Definition at line 21 of file asset.hpp.

                                                                     :amount(a), sym(id) {
      SYS_ASSERT( is_amount_within_range(), asset_type_exception, "magnitude of asset amount must be less than 2^62" );
      SYS_ASSERT( sym.valid(), asset_type_exception, "invalid symbol" );
   }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

decimals()

uint8_t sysio::chain::asset::decimals

(

)

const

Definition at line 7 of file asset.cpp.

                             {
   return sym.decimals();
}

Here is the call graph for this function:

Here is the caller graph for this function:

from_string()

asset sysio::chain::asset::from_string ( const string & from )

static

Definition at line 31 of file asset.cpp.

{
   try {
      string s = fc::trim(from);
 
      // Find space in order to split amount and symbol
      auto space_pos = s.find(' ');
      SYS_ASSERT((space_pos != string::npos), asset_type_exception, "Asset's amount and symbol should be separated with space");
      auto symbol_str = fc::trim(s.substr(space_pos + 1));
      auto amount_str = s.substr(0, space_pos);
 
      // Ensure that if decimal point is used (.), decimal fraction is specified
      auto dot_pos = amount_str.find('.');
      if (dot_pos != string::npos) {
         SYS_ASSERT((dot_pos != amount_str.size() - 1), asset_type_exception, "Missing decimal fraction after decimal point");
      }
 
      // Parse symbol
      string precision_digit_str;
      if (dot_pos != string::npos) {
         precision_digit_str = sysio::chain::to_string(amount_str.size() - dot_pos - 1);
      } else {
         precision_digit_str = "0";
      }
 
      string symbol_part = precision_digit_str + ',' + symbol_str;
      symbol sym = symbol::from_string(symbol_part);
 
      // Parse amount
      safe<int64_t> int_part, fract_part;
      if (dot_pos != string::npos) {
         int_part = fc::to_int64(amount_str.substr(0, dot_pos));
         fract_part = fc::to_int64(amount_str.substr(dot_pos + 1));
         if (amount_str[0] == '-') fract_part *= -1;
      } else {
         int_part = fc::to_int64(amount_str);
      }
 
      safe<int64_t> amount = int_part;
      amount *= safe<int64_t>(sym.precision());
      amount += fract_part;
 
      return asset(amount.value, sym);
   }
   FC_CAPTURE_LOG_AND_RETHROW( (from) )
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_amount()

share_type sysio::chain::asset::get_amount ( ) const

inline

Definition at line 35 of file asset.hpp.

{ return amount; }

get_symbol()

const symbol & sysio::chain::asset::get_symbol ( ) const

inline

Definition at line 34 of file asset.hpp.

{ return sym; }

Here is the caller graph for this function:

is_amount_within_range()

bool sysio::chain::asset::is_amount_within_range ( ) const

inline

Definition at line 26 of file asset.hpp.

{ return -max_amount <= amount && amount <= max_amount; }

Here is the caller graph for this function:

is_valid()

bool sysio::chain::asset::is_valid ( ) const

inline

Definition at line 27 of file asset.hpp.

{ return is_amount_within_range() && sym.valid(); }

Here is the call graph for this function:

Here is the caller graph for this function:

operator+=()

asset & sysio::chain::asset::operator+= ( const asset & o )

inline

Definition at line 40 of file asset.hpp.

   {
      SYS_ASSERT(get_symbol() == o.get_symbol(), asset_type_exception, "addition between two different asset is not allowed");
      amount += o.amount;
      return *this;
   }

Here is the call graph for this function:

operator-()

asset sysio::chain::asset::operator- ( ) const

inline

Definition at line 53 of file asset.hpp.

{ return asset(-amount, get_symbol()); }

Here is the call graph for this function:

operator-=()

asset & sysio::chain::asset::operator-= ( const asset & o )

inline

Definition at line 47 of file asset.hpp.

   {
      SYS_ASSERT(get_symbol() == o.get_symbol(), asset_type_exception, "subtraction between two different asset is not allowed");
      amount -= o.amount;
      return *this;
   }

Here is the call graph for this function:

precision()

int64_t sysio::chain::asset::precision

(

)

const

Definition at line 15 of file asset.cpp.

                              {
   return sym.precision();
}

Here is the call graph for this function:

Here is the caller graph for this function:

reflector_init()

void sysio::chain::asset::reflector_init ( ) const

inline

Definition at line 83 of file asset.hpp.

                              {
      SYS_ASSERT( is_amount_within_range(), asset_type_exception, "magnitude of asset amount must be less than 2^62" );
      SYS_ASSERT( sym.valid(), asset_type_exception, "invalid symbol" );
   }

Here is the call graph for this function:

symbol_name()

string sysio::chain::asset::symbol_name

(

)

const

Definition at line 11 of file asset.cpp.

                               {
   return sym.name();
}

Here is the call graph for this function:

Here is the caller graph for this function:

to_real()

double sysio::chain::asset::to_real ( ) const

inline

Definition at line 29 of file asset.hpp.

{ return static_cast<double>(amount) / precision(); }

Here is the call graph for this function:

to_string()

string sysio::chain::asset::to_string

(

)

const

Definition at line 19 of file asset.cpp.

                             {
   string sign = amount < 0 ? "-" : "";
   int64_t abs_amount = std::abs(amount);
   string result = fc::to_string( static_cast<int64_t>(abs_amount) / precision());
   if( decimals() )
   {
      auto fract = static_cast<int64_t>(abs_amount) % precision();
      result += "." + fc::to_string(precision() + fract).erase(0,1);
   }
   return sign + result + " " + symbol_name();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

fc::reflector< asset >

friend struct fc::reflector< asset >

friend

Definition at line 79 of file asset.hpp.

operator!=

bool operator!= ( const asset & a, const asset & b )

friend

Definition at line 65 of file asset.hpp.

{ return !(a == b); }

operator+

asset operator+ ( const asset & a, const asset & b )

friend

Definition at line 74 of file asset.hpp.

                                                            {
      SYS_ASSERT(a.get_symbol() == b.get_symbol(), asset_type_exception, "addition between two different asset is not allowed");
      return asset(a.amount + b.amount, a.get_symbol());
   }

operator-

asset operator- ( const asset & a, const asset & b )

friend

Definition at line 69 of file asset.hpp.

                                                            {
      SYS_ASSERT(a.get_symbol() == b.get_symbol(), asset_type_exception, "subtraction between two different asset is not allowed");
      return asset(a.amount - b.amount, a.get_symbol());
   }

operator<

bool operator< ( const asset & a, const asset & b )

friend

Definition at line 59 of file asset.hpp.

   {
      SYS_ASSERT(a.get_symbol() == b.get_symbol(), asset_type_exception, "logical operation between two different asset is not allowed");
      return std::tie(a.amount,a.get_symbol()) < std::tie(b.amount,b.get_symbol());
   }

operator<<

std::ostream & operator<< ( std::ostream & out, const asset & a )

friend

Definition at line 79 of file asset.hpp.

{ return out << a.to_string(); }

operator<=

bool operator<= ( const asset & a, const asset & b )

friend

Definition at line 64 of file asset.hpp.

{ return (a == b) || (a < b); }

operator==

bool operator== ( const asset & a, const asset & b )

friend

Definition at line 55 of file asset.hpp.

   {
      return std::tie(a.get_symbol(), a.amount) == std::tie(b.get_symbol(), b.amount);
   }

operator>

bool operator> ( const asset & a, const asset & b )

friend

Definition at line 66 of file asset.hpp.

{ return !(a <= b); }

operator>=

bool operator>= ( const asset & a, const asset & b )

friend

Definition at line 67 of file asset.hpp.

{ return !(a < b);  }

Member Data Documentation

max_amount

int64_t sysio::chain::asset::max_amount = (1LL << 62) - 1

staticconstexpr

Definition at line 19 of file asset.hpp.

---

The documentation for this struct was generated from the following files:

• libraries/chain/include/sysio/chain/asset.hpp
• libraries/chain/asset.cpp