xrpl::TrustLineBase Class Reference

Wraps a trust line SLE for convenience. More...

#include <TrustLine.h>

Inheritance diagram for xrpl::TrustLineBase:

Collaboration diagram for xrpl::TrustLineBase:

Public Member Functions
uint256 const &	key () const
	Returns the state map key for the ledger entry.
AccountID const &	getAccountID () const
AccountID const &	getAccountIDPeer () const
bool	getAuth () const
bool	getAuthPeer () const
bool	getNoRipple () const
bool	getNoRipplePeer () const
LineDirection	getDirection () const
LineDirection	getDirectionPeer () const
bool	getFreeze () const
	Have we set the freeze flag on our peer.
bool	getDeepFreeze () const
	Have we set the deep freeze flag on our peer.
bool	getFreezePeer () const
	Has the peer set the freeze flag on us.
bool	getDeepFreezePeer () const
	Has the peer set the deep freeze flag on us.
STAmount const &	getBalance () const
STAmount const &	getLimit () const
STAmount const &	getLimitPeer () const
Json::Value	getJson (int)

Protected Member Functions
	TrustLineBase (std::shared_ptr< SLE const > const &sle, AccountID const &viewAccount)
	~TrustLineBase ()=default
	TrustLineBase (TrustLineBase const &)=default
TrustLineBase &	operator= (TrustLineBase const &)=delete
	TrustLineBase (TrustLineBase &&)=default

Protected Attributes
uint256	key_
STAmount const	mLowLimit
STAmount const	mHighLimit
STAmount	mBalance
std::uint32_t	mFlags
bool	mViewLowest

Detailed Description

Wraps a trust line SLE for convenience.

The complication of trust lines is that there is a "low" account and a "high" account. This wraps the SLE and expresses its data from the perspective of a chosen account on the line.

This wrapper is primarily used in the path finder and there can easily be tens of millions of instances of this class. When modifying this class think carefully about the memory implications.

Definition at line 33 of file TrustLine.h.

Constructor & Destructor Documentation

TrustLineBase() [1/3]

xrpl::TrustLineBase::TrustLineBase ( std::shared_ptr< SLE const > const &  sle, AccountID const &  viewAccount  )

protected

Definition at line 9 of file TrustLine.cpp.

~TrustLineBase()

xrpl::TrustLineBase::~TrustLineBase ( )

protecteddefault

TrustLineBase() [2/3]

xrpl::TrustLineBase::TrustLineBase ( TrustLineBase const &  )

protecteddefault

TrustLineBase() [3/3]

xrpl::TrustLineBase::TrustLineBase ( TrustLineBase &&  )

protecteddefault

Member Function Documentation

operator=()

TrustLineBase & xrpl::TrustLineBase::operator= ( TrustLineBase const &  )

protecteddelete

key()

uint256 const & xrpl::TrustLineBase::key

(

)

const

Returns the state map key for the ledger entry.

Definition at line 49 of file TrustLine.h.

getAccountID()

AccountID const & xrpl::TrustLineBase::getAccountID

(

)

const

Definition at line 57 of file TrustLine.h.

getAccountIDPeer()

AccountID const & xrpl::TrustLineBase::getAccountIDPeer

(

)

const

Definition at line 63 of file TrustLine.h.

getAuth()

bool xrpl::TrustLineBase::getAuth

(

)

const

Definition at line 70 of file TrustLine.h.

getAuthPeer()

bool xrpl::TrustLineBase::getAuthPeer

(

)

const

Definition at line 76 of file TrustLine.h.

getNoRipple()

bool xrpl::TrustLineBase::getNoRipple

(

)

const

Definition at line 82 of file TrustLine.h.

getNoRipplePeer()

bool xrpl::TrustLineBase::getNoRipplePeer

(

)

const

Definition at line 88 of file TrustLine.h.

getDirection()

LineDirection xrpl::TrustLineBase::getDirection

(

)

const

Definition at line 94 of file TrustLine.h.

getDirectionPeer()

LineDirection xrpl::TrustLineBase::getDirectionPeer

(

)

const

Definition at line 100 of file TrustLine.h.

getFreeze()

bool xrpl::TrustLineBase::getFreeze

(

)

const

Have we set the freeze flag on our peer.

Definition at line 107 of file TrustLine.h.

getDeepFreeze()

bool xrpl::TrustLineBase::getDeepFreeze

(

)

const

Have we set the deep freeze flag on our peer.

Definition at line 114 of file TrustLine.h.

getFreezePeer()

bool xrpl::TrustLineBase::getFreezePeer

(

)

const

Has the peer set the freeze flag on us.

Definition at line 121 of file TrustLine.h.

getDeepFreezePeer()

bool xrpl::TrustLineBase::getDeepFreezePeer

(

)

const

Has the peer set the deep freeze flag on us.

Definition at line 128 of file TrustLine.h.

getBalance()

STAmount const & xrpl::TrustLineBase::getBalance

(

)

const

Definition at line 134 of file TrustLine.h.

getLimit()

STAmount const & xrpl::TrustLineBase::getLimit

(

)

const

Definition at line 140 of file TrustLine.h.

getLimitPeer()

STAmount const & xrpl::TrustLineBase::getLimitPeer

(

)

const

Definition at line 146 of file TrustLine.h.

getJson()

Json::Value xrpl::TrustLineBase::getJson

(

int

)

Definition at line 22 of file TrustLine.cpp.

Member Data Documentation

key_

uint256 xrpl::TrustLineBase::key_

protected

Definition at line 155 of file TrustLine.h.

mLowLimit

STAmount const xrpl::TrustLineBase::mLowLimit

protected

Definition at line 157 of file TrustLine.h.

mHighLimit

STAmount const xrpl::TrustLineBase::mHighLimit

protected

Definition at line 158 of file TrustLine.h.

mBalance

STAmount xrpl::TrustLineBase::mBalance

protected

Definition at line 160 of file TrustLine.h.

mFlags

std::uint32_t xrpl::TrustLineBase::mFlags

protected

Definition at line 162 of file TrustLine.h.

mViewLowest

bool xrpl::TrustLineBase::mViewLowest

protected

Definition at line 164 of file TrustLine.h.