Intermediate class for any STBase-derived class to store an Asset. More...

#include <STTakesAsset.h>

Inheritance diagram for xrpl::STTakesAsset:

[legend]

Collaboration diagram for xrpl::STTakesAsset:

[legend]

Public Member Functions
virtual void	associateAsset (Asset const &a)
	STBase ()
	STBase (STBase const &)=default
	STBase (SField const &n)
STBase &	operator= (STBase const &t)
bool	operator== (STBase const &t) const
bool	operator!= (STBase const &t) const
template<class D>
D &	downcast ()
template<class D>
D const &	downcast () const
template<class D>
D const &	downcast () const
virtual SerializedTypeID	getSType () const
virtual std::string	getFullText () const
virtual std::string	getText () const
virtual json::Value	getJson (JsonOptions=JsonOptions::Values::None) const
virtual void	add (Serializer &s) const
virtual bool	isEquivalent (STBase const &t) const
virtual bool	isDefault () const
void	setFName (SField const &n)
	A STBase is a field.
SField const &	getFName () const
void	addFieldID (Serializer &s) const

Static Protected Member Functions
template<class T>
static STBase *	emplace (std::size_t n, void *buf, T &&val)

Protected Attributes
std::optional< Asset >	asset_

Private Member Functions
virtual STBase *	copy (std::size_t n, void *buf) const
virtual STBase *	move (std::size_t n, void *buf)

Private Attributes
SField const *	fName_

Detailed Description

Intermediate class for any STBase-derived class to store an Asset.

In the class definition, this class should be specified as a base class instead of STBase.

Specifically, the Asset is only stored and used at runtime. It should not be serialized to the ledger.

The derived class decides what to do with the Asset, and when. It will not necessarily be set at any given time. As of this writing, only STNumber uses it to round the stored Number to the Asset's precision both when associated, and when serializing the Number.

Definition at line 21 of file STTakesAsset.h.

Member Function Documentation

◆ associateAsset()

void xrpl::STTakesAsset::associateAsset ( Asset const & a )

virtual

Reimplemented in xrpl::STNumber.

Definition at line 35 of file STTakesAsset.h.

◆ STBase() [1/3]

xrpl::STBase::STBase ( )

Definition at line 122 of file STBase.cpp.

◆ STBase() [2/3]

xrpl::STBase::STBase ( STBase const & )

default

◆ STBase() [3/3]

xrpl::STBase::STBase ( SField const & n )

explicit

Definition at line 127 of file STBase.cpp.

◆ operator=()

STBase & xrpl::STBase::operator= ( STBase const & t )

Definition at line 125 of file STBase.cpp.

◆ operator==()

bool xrpl::STBase::operator== ( STBase const & t ) const

inherited

Definition at line 36 of file STBase.cpp.

◆ operator!=()

bool xrpl::STBase::operator!= ( STBase const & t ) const

inherited

Definition at line 42 of file STBase.cpp.

◆ downcast() [1/3]

template<class D>

D & xrpl::STBase::downcast ( )

inherited

Definition at line 195 of file STBase.h.

◆ downcast() [2/3]

template<class D>

D const & xrpl::STBase::downcast ( ) const

inherited

◆ downcast() [3/3]

template<class D>

D const & xrpl::STBase::downcast ( ) const

nodiscardinherited

Definition at line 205 of file STBase.h.

◆ getSType()

SerializedTypeID xrpl::STBase::getSType ( ) const

nodiscardvirtualinherited

◆ getFullText()

std::string xrpl::STBase::getFullText ( ) const

nodiscardvirtualinherited

Reimplemented in xrpl::STAmount, xrpl::STArray, xrpl::STLedgerEntry, xrpl::STObject, and xrpl::STTx.

Definition at line 66 of file STBase.cpp.

◆ getText()

std::string xrpl::STBase::getText ( ) const

nodiscardvirtualinherited

◆ getJson()

json::Value xrpl::STBase::getJson ( JsonOptions = JsonOptions::Values::None ) const

nodiscardvirtualinherited

Reimplemented in xrpl::STAmount, xrpl::STArray, xrpl::STCurrency, xrpl::STInteger< Integer >, xrpl::STInteger< std::int32_t >, xrpl::STInteger< std::uint16_t >, xrpl::STInteger< std::uint32_t >, xrpl::STInteger< std::uint64_t >, xrpl::STInteger< unsigned char >, xrpl::STIssue, xrpl::STLedgerEntry, xrpl::STObject, xrpl::STPathSet, xrpl::STTx, xrpl::STVector256, and xrpl::STXChainBridge.

Definition at line 91 of file STBase.cpp.

◆ add()

void xrpl::STBase::add ( Serializer & s ) const

virtualinherited

◆ isEquivalent()

bool xrpl::STBase::isEquivalent ( STBase const & t ) const

nodiscardvirtualinherited

◆ isDefault()

bool xrpl::STBase::isDefault ( ) const

nodiscardvirtualinherited

◆ setFName()

void xrpl::STBase::setFName ( SField const & n )

inherited

A STBase is a field.

This sets the name.

Definition at line 119 of file STBase.cpp.

◆ getFName()

SField const & xrpl::STBase::getFName ( ) const

nodiscardinherited

Definition at line 126 of file STBase.cpp.

◆ addFieldID()

void xrpl::STBase::addFieldID ( Serializer & s ) const

inherited

Definition at line 132 of file STBase.cpp.

◆ emplace()

template<class T>

STBase * xrpl::STBase::emplace	(	std::size_t	n,
		void *	buf,
		T &&	val )

staticprotectedinherited

Definition at line 215 of file STBase.h.

◆ copy()

STBase * xrpl::STBase::copy	(	std::size_t	n,
		void *	buf ) const

privatevirtualinherited

◆ move()

STBase * xrpl::STBase::move	(	std::size_t	n,
		void *	buf )

privatevirtualinherited

Member Data Documentation

◆ asset_

std::optional<Asset> xrpl::STTakesAsset::asset_

protected

Definition at line 24 of file STTakesAsset.h.

◆ fName_

SField const* xrpl::STBase::fName_

privateinherited

Definition at line 118 of file STBase.h.

Public Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ associateAsset()

◆ STBase() [1/3]

◆ STBase() [2/3]

◆ STBase() [3/3]

◆ operator=()

◆ operator==()

◆ operator!=()

◆ downcast() [1/3]

◆ downcast() [2/3]

◆ downcast() [3/3]

◆ getSType()

◆ getFullText()

◆ getText()

◆ getJson()

◆ add()

◆ isEquivalent()

◆ isDefault()

◆ setFName()

◆ getFName()

◆ addFieldID()

◆ emplace()

◆ copy()

◆ move()

Member Data Documentation

◆ asset_

◆ fName_