ripple::STBase Class Reference

A type which can be exported to a well known binary format. More...

Inheritance diagram for ripple::STBase:

Collaboration diagram for ripple::STBase:

Public Member Functions
	STBase ()
	STBase (SField const &n)
virtual	~STBase ()=default
	STBase (const STBase &t)=default
STBase &	operator= (const STBase &t)
bool	operator== (const STBase &t) const
bool	operator!= (const STBase &t) const
virtual STBase *	copy (std::size_t n, void *buf) const
virtual STBase *	move (std::size_t n, void *buf)
template<class D >
D &	downcast ()
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) 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. More...
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
SField const *	fName

Detailed Description

A type which can be exported to a well known binary format.

A STBase:

• Always a field
• Can always go inside an eligible enclosing STBase (such as STArray)
• Has a field name

Like JSON, a SerializedObject is a basket which has rules on what it can hold.

Note

"ST" stands for "Serialized Type."

Definition at line 62 of file STBase.h.

Constructor & Destructor Documentation

STBase() [1/3]

ripple::STBase::STBase

(

)

Definition at line 27 of file STBase.cpp.

STBase() [2/3]

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

explicit

Definition at line 31 of file STBase.cpp.

~STBase()

virtual ripple::STBase::~STBase ( )

virtualdefault

STBase() [3/3]

ripple::STBase::STBase ( const STBase &  t )

default

Member Function Documentation

operator=()

STBase & ripple::STBase::operator=

(

const STBase &

t

)

Definition at line 37 of file STBase.cpp.

operator==()

bool ripple::STBase::operator==

(

const STBase &

t

)

const

Definition at line 45 of file STBase.cpp.

operator!=()

bool ripple::STBase::operator!=

(

const STBase &

t

)

const

Definition at line 51 of file STBase.cpp.

copy()

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

virtual

Reimplemented in ripple::STPathSet, ripple::STObject, ripple::STAmount, ripple::STValidation, ripple::STTx, ripple::STBlob, ripple::STLedgerEntry, ripple::STArray, ripple::STVector256, and ripple::STAccount.

Definition at line 81 of file STBase.h.

move()

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

virtual

Reimplemented in ripple::STPathSet, ripple::STObject, ripple::STAmount, ripple::STValidation, ripple::STTx, ripple::STBlob, ripple::STLedgerEntry, ripple::STArray, ripple::STVector256, and ripple::STAccount.

Definition at line 87 of file STBase.h.

downcast() [1/2]

template<class D >

D& ripple::STBase::downcast

(

)

Definition at line 94 of file STBase.h.

downcast() [2/2]

template<class D >

D const& ripple::STBase::downcast

(

)

const

Definition at line 104 of file STBase.h.

getSType()

SerializedTypeID ripple::STBase::getSType ( ) const

virtual

Reimplemented in ripple::STObject, ripple::STPathSet, ripple::STAmount, ripple::STArray, ripple::STTx, ripple::STBlob, ripple::STLedgerEntry, ripple::STVector256, and ripple::STAccount.

Definition at line 57 of file STBase.cpp.

getFullText()

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

virtual

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

Definition at line 63 of file STBase.cpp.

getText()

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

virtual

Reimplemented in ripple::STObject, ripple::STAmount, ripple::STArray, ripple::STBlob, ripple::STLedgerEntry, and ripple::STAccount.

Definition at line 82 of file STBase.cpp.

getJson()

Json::Value ripple::STBase::getJson ( JsonOptions  ) const

virtual

Reimplemented in ripple::STPathSet, ripple::STAmount, ripple::STVector256, ripple::STObject, ripple::STTx, ripple::STLedgerEntry, and ripple::STArray.

Definition at line 87 of file STBase.cpp.

add()

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

virtual

Reimplemented in ripple::STObject, ripple::STAmount, ripple::STPathSet, ripple::STArray, ripple::STBlob, ripple::STAccount, and ripple::STVector256.

Definition at line 93 of file STBase.cpp.

isEquivalent()

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

virtual

Reimplemented in ripple::STPathSet, ripple::STObject, ripple::STAmount, ripple::STArray, ripple::STBlob, ripple::STAccount, and ripple::STVector256.

Definition at line 100 of file STBase.cpp.

isDefault()

bool ripple::STBase::isDefault ( ) const

virtual

Reimplemented in ripple::STPathSet, ripple::STObject, ripple::STAmount, ripple::STArray, ripple::STBlob, ripple::STAccount, and ripple::STVector256.

Definition at line 107 of file STBase.cpp.

setFName()

void ripple::STBase::setFName

(

SField const &

n

)

A STBase is a field.

This sets the name.

Definition at line 113 of file STBase.cpp.

getFName()

SField const & ripple::STBase::getFName

(

)

const

Definition at line 120 of file STBase.cpp.

addFieldID()

void ripple::STBase::addFieldID

(

Serializer &

s

)

const

Definition at line 126 of file STBase.cpp.

emplace()

template<class T >

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

staticprotected

Definition at line 149 of file STBase.h.

Member Data Documentation

fName

SField const* ripple::STBase::fName

protected

Definition at line 145 of file STBase.h.