ripple::TxConsequences Class Reference

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

#include <applySteps.h>

Collaboration diagram for ripple::TxConsequences:

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

Public Member Functions
	TxConsequences (NotTEC pfresult)
	TxConsequences (STTx const &tx)
	Constructor if the STTx has no notable consequences for the TxQ.
	TxConsequences (STTx const &tx, Category category)
	Constructor for a blocker.
	TxConsequences (STTx const &tx, XRPAmount potentialSpend)
	Constructor for an STTx that may consume more XRP than the fee.
	TxConsequences (STTx const &tx, std::uint32_t sequencesConsumed)
	Constructor for an STTx that consumes more than the usual sequences.
	TxConsequences (TxConsequences const &)=default
	Copy constructor.
TxConsequences &	operator= (TxConsequences const &)=default
	Copy assignment operator.
	TxConsequences (TxConsequences &&)=default
	Move constructor.
TxConsequences &	operator= (TxConsequences &&)=default
	Move assignment operator.
XRPAmount	fee () const
	Fee.
XRPAmount const &	potentialSpend () const
	Potential Spend.
SeqProxy	seqProxy () const
	SeqProxy.
std::uint32_t	sequencesConsumed () const
	Sequences consumed.
bool	isBlocker () const
	Returns true if the transaction is a blocker.
SeqProxy	followingSeq () const

Private Attributes
bool	isBlocker_
	Describes how the transaction affects subsequent transactions.
XRPAmount	fee_
	Transaction fee.
XRPAmount	potentialSpend_
	Does NOT include the fee.
SeqProxy	seqProx_
	SeqProxy of transaction.
std::uint32_t	sequencesConsumed_
	Number of sequences consumed.

Detailed Description

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

Definition at line 57 of file applySteps.h.

Member Enumeration Documentation

Category

enum ripple::TxConsequences::Category

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 62 of file applySteps.h.

Constructor & Destructor Documentation

TxConsequences() [1/7]

ripple::TxConsequences::TxConsequences ( NotTEC  pfresult )

explicit

Definition at line 240 of file applySteps.cpp.

TxConsequences() [2/7]

ripple::TxConsequences::TxConsequences ( STTx const &  tx )

explicit

Constructor if the STTx has no notable consequences for the TxQ.

Definition at line 252 of file applySteps.cpp.

TxConsequences() [3/7]

ripple::TxConsequences::TxConsequences	(	STTx const &	tx,
		Category	category
	)

Constructor for a blocker.

Definition at line 263 of file applySteps.cpp.

TxConsequences() [4/7]

ripple::TxConsequences::TxConsequences	(	STTx const &	tx,
		XRPAmount	potentialSpend
	)

Constructor for an STTx that may consume more XRP than the fee.

Definition at line 269 of file applySteps.cpp.

TxConsequences() [5/7]

ripple::TxConsequences::TxConsequences	(	STTx const &	tx,
		std::uint32_t	sequencesConsumed
	)

Constructor for an STTx that consumes more than the usual sequences.

Definition at line 275 of file applySteps.cpp.

TxConsequences() [6/7]

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

default

Copy constructor.

TxConsequences() [7/7]

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

default

Move constructor.

Member Function Documentation

operator=() [1/2]

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

default

Copy assignment operator.

operator=() [2/2]

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

default

Move assignment operator.

fee()

XRPAmount ripple::TxConsequences::fee

(

)

const

Fee.

Definition at line 113 of file applySteps.h.

potentialSpend()

XRPAmount const & ripple::TxConsequences::potentialSpend

(

)

const

Potential Spend.

Definition at line 120 of file applySteps.h.

seqProxy()

SeqProxy ripple::TxConsequences::seqProxy

(

)

const

SeqProxy.

Definition at line 127 of file applySteps.h.

sequencesConsumed()

std::uint32_t ripple::TxConsequences::sequencesConsumed

(

)

const

Sequences consumed.

Definition at line 134 of file applySteps.h.

isBlocker()

bool ripple::TxConsequences::isBlocker

(

)

const

Returns true if the transaction is a blocker.

Definition at line 141 of file applySteps.h.

followingSeq()

SeqProxy ripple::TxConsequences::followingSeq

(

)

const

Definition at line 148 of file applySteps.h.

Member Data Documentation

isBlocker_

bool ripple::TxConsequences::isBlocker_

private

Describes how the transaction affects subsequent transactions.

Definition at line 73 of file applySteps.h.

fee_

XRPAmount ripple::TxConsequences::fee_

private

Transaction fee.

Definition at line 75 of file applySteps.h.

potentialSpend_

XRPAmount ripple::TxConsequences::potentialSpend_

private

Does NOT include the fee.

Definition at line 77 of file applySteps.h.

seqProx_

SeqProxy ripple::TxConsequences::seqProx_

private

SeqProxy of transaction.

Definition at line 79 of file applySteps.h.

sequencesConsumed_

std::uint32_t ripple::TxConsequences::sequencesConsumed_

private

Number of sequences consumed.

Definition at line 81 of file applySteps.h.