rippled
Public Types | Public Member Functions | Public Attributes | List of all members
ripple::TxConsequences Struct Reference

Structure describing the consequences to the account of applying a transaction if the transaction consumes the maximum XRP allowed. More...

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

Public Types

enum  ConsequenceCategory { normal = 0, blocker }
 Describes how the transaction affects subsequent transactions. More...
 

Public Member Functions

 TxConsequences (ConsequenceCategory const category_, XRPAmount const fee_, XRPAmount const spend_)
 Constructor. More...
 
 TxConsequences (TxConsequences const &)=default
 Constructor. More...
 
TxConsequencesoperator= (TxConsequences const &)=delete
 Deleted copy assignment operator. More...
 
 TxConsequences (TxConsequences &&)=default
 Constructor. More...
 
TxConsequencesoperator= (TxConsequences &&)=delete
 Deleted copy assignment operator. More...
 

Public Attributes

const ConsequenceCategory category
 Describes how the transaction affects subsequent transactions. More...
 
const XRPAmount fee
 Transaction fee. More...
 
const XRPAmount potentialSpend
 Does NOT include the fee. More...
 

Detailed Description

Structure describing the consequences to the account of applying a transaction if the transaction consumes the maximum XRP allowed.

See also
calculateConsequences

Definition at line 126 of file applySteps.h.

Member Enumeration Documentation

◆ ConsequenceCategory

Describes how the transaction affects subsequent transactions.

Enumerator
normal 

Moves currency around, creates offers, etc.

blocker 

Affects the ability of subsequent transactions to claim a fee.

Eg. SetRegularKey

Definition at line 130 of file applySteps.h.

Constructor & Destructor Documentation

◆ TxConsequences() [1/3]

ripple::TxConsequences::TxConsequences ( ConsequenceCategory const  category_,
XRPAmount const  fee_,
XRPAmount const  spend_ 
)

Constructor.

Definition at line 147 of file applySteps.h.

◆ TxConsequences() [2/3]

ripple::TxConsequences::TxConsequences ( TxConsequences const &  )
default

Constructor.

◆ TxConsequences() [3/3]

ripple::TxConsequences::TxConsequences ( TxConsequences &&  )
default

Constructor.

Member Function Documentation

◆ operator=() [1/2]

TxConsequences& ripple::TxConsequences::operator= ( TxConsequences const &  )
delete

Deleted copy assignment operator.

◆ operator=() [2/2]

TxConsequences& ripple::TxConsequences::operator= ( TxConsequences &&  )
delete

Deleted copy assignment operator.

Member Data Documentation

◆ category

const ConsequenceCategory ripple::TxConsequences::category

Describes how the transaction affects subsequent transactions.

Definition at line 140 of file applySteps.h.

◆ fee

const XRPAmount ripple::TxConsequences::fee

Transaction fee.

Definition at line 142 of file applySteps.h.

◆ potentialSpend

const XRPAmount ripple::TxConsequences::potentialSpend

Does NOT include the fee.

Definition at line 144 of file applySteps.h.