rippled
Public Types | Public Member Functions | Private Attributes | List of all members
ripple::OrderBook Class Reference

Describes a serialized ledger entry for an order book. More...

Collaboration diagram for ripple::OrderBook:
Collaboration graph
[legend]

Public Types

using pointer = std::shared_ptr< OrderBook >
 
using ref = std::shared_ptr< OrderBook > const &
 
using List = std::vector< pointer >
 

Public Member Functions

 OrderBook (uint256 const &base, Book const &book)
 Construct from a currency specification. More...
 
uint256 const & getBookBase () const
 
Book const & book () const
 
Currency const & getCurrencyIn () const
 
Currency const & getCurrencyOut () const
 
AccountID const & getIssuerIn () const
 
AccountID const & getIssuerOut () const
 

Private Attributes

const uint256 mBookBase
 
const Book mBook
 

Detailed Description

Describes a serialized ledger entry for an order book.

Definition at line 26 of file OrderBook.h.

Member Typedef Documentation

◆ pointer

Definition at line 29 of file OrderBook.h.

◆ ref

Definition at line 30 of file OrderBook.h.

◆ List

Definition at line 31 of file OrderBook.h.

Constructor & Destructor Documentation

◆ OrderBook()

ripple::OrderBook::OrderBook ( uint256 const &  base,
Book const &  book 
)

Construct from a currency specification.

Parameters
index???
bookin and out currency/issuer pairs.

Definition at line 39 of file OrderBook.h.

Member Function Documentation

◆ getBookBase()

uint256 const& ripple::OrderBook::getBookBase ( ) const

Definition at line 45 of file OrderBook.h.

◆ book()

Book const& ripple::OrderBook::book ( ) const

Definition at line 51 of file OrderBook.h.

◆ getCurrencyIn()

Currency const& ripple::OrderBook::getCurrencyIn ( ) const

Definition at line 57 of file OrderBook.h.

◆ getCurrencyOut()

Currency const& ripple::OrderBook::getCurrencyOut ( ) const

Definition at line 63 of file OrderBook.h.

◆ getIssuerIn()

AccountID const& ripple::OrderBook::getIssuerIn ( ) const

Definition at line 69 of file OrderBook.h.

◆ getIssuerOut()

AccountID const& ripple::OrderBook::getIssuerOut ( ) const

Definition at line 75 of file OrderBook.h.

Member Data Documentation

◆ mBookBase

const uint256 ripple::OrderBook::mBookBase
private

Definition at line 81 of file OrderBook.h.

◆ mBook

const Book ripple::OrderBook::mBook
private

Definition at line 82 of file OrderBook.h.