rippled
Classes | Static Public Member Functions | Public Attributes | List of all members
ripple::path::RippleCalc Class Reference

RippleCalc calculates the quality of a payment path. More...

Collaboration diagram for ripple::path::RippleCalc:
Collaboration graph
[legend]

Classes

struct  Input
 
struct  Output
 

Static Public Member Functions

static Output rippleCalculate (PaymentSandbox &view, STAmount const &saMaxAmountReq, STAmount const &saDstAmountReq, AccountID const &uDstAccountID, AccountID const &uSrcAccountID, STPathSet const &spsPaths, Logs &l, Input const *const pInputs=nullptr)
 

Public Attributes

PaymentSandboxview
 
boost::container::flat_set< uint256permanentlyUnfundedOffers_
 

Detailed Description

RippleCalc calculates the quality of a payment path.

Quality is the amount of input required to produce a given output along a specified path - another name for this is exchange rate.

Definition at line 43 of file RippleCalc.h.

Member Function Documentation

◆ rippleCalculate()

RippleCalc::Output ripple::path::RippleCalc::rippleCalculate ( PaymentSandbox view,
STAmount const &  saMaxAmountReq,
STAmount const &  saDstAmountReq,
AccountID const &  uDstAccountID,
AccountID const &  uSrcAccountID,
STPathSet const &  spsPaths,
Logs l,
Input const *const  pInputs = nullptr 
)
static

Definition at line 31 of file RippleCalc.cpp.

Member Data Documentation

◆ view

PaymentSandbox& ripple::path::RippleCalc::view

Definition at line 117 of file RippleCalc.h.

◆ permanentlyUnfundedOffers_

boost::container::flat_set<uint256> ripple::path::RippleCalc::permanentlyUnfundedOffers_

Definition at line 123 of file RippleCalc.h.