ripple::SField Class Reference

Identifies fields. More...

#include <SField.h>

Inheritance diagram for ripple::SField:

Collaboration diagram for ripple::SField:

Classes
struct	private_access_tag_t

Public Types
enum	{   sMD_Never = 0x00 , sMD_ChangeOrig = 0x01 , sMD_ChangeNew = 0x02 , sMD_DeleteFinal = 0x04 ,   sMD_Create = 0x08 , sMD_Always = 0x10 , sMD_BaseTen = 0x20 , sMD_Default }
enum class	IsSigning : unsigned char { no , yes }

Public Member Functions
	SField (SField const &)=delete
SField &	operator= (SField const &)=delete
	SField (SField &&)=delete
SField &	operator= (SField &&)=delete
	SField (private_access_tag_t, SerializedTypeID tid, int fv, const char *fn, int meta=sMD_Default, IsSigning signing=IsSigning::yes)
	SField (private_access_tag_t, int fc)
std::string const &	getName () const
bool	hasName () const
Json::StaticString const &	getJsonName () const
	operator Json::StaticString const & () const
bool	isInvalid () const
bool	isUseful () const
bool	isBinary () const
bool	isDiscardable () const
int	getCode () const
int	getNum () const
bool	shouldMeta (int c) const
bool	shouldInclude (bool withSigningField) const
bool	operator== (const SField &f) const
bool	operator!= (const SField &f) const

Static Public Member Functions
static const SField &	getField (int fieldCode)
static const SField &	getField (std::string const &fieldName)
static const SField &	getField (int type, int value)
static const SField &	getField (SerializedTypeID type, int value)
static int	getNumFields ()
static int	compare (const SField &f1, const SField &f2)
static std::map< int, SField const * > const &	getKnownCodeToField ()

Public Attributes
int const	fieldCode
SerializedTypeID const	fieldType
int const	fieldValue
std::string const	fieldName
int const	fieldMeta
int const	fieldNum
IsSigning const	signingField
Json::StaticString const	jsonName

Static Public Attributes
static IsSigning const	notSigning = IsSigning::no

Static Private Attributes
static int	num = 0
static std::map< int, SField const * >	knownCodeToField

Detailed Description

Identifies fields.

Fields are necessary to tag data in signed transactions so that the binary format of the transaction can be canonicalized. All SFields are created at compile time.

Each SField, once constructed, lives until program termination, and there is only one instance per fieldType/fieldValue pair which serves the entire application.

Definition at line 143 of file SField.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
sMD_Never
sMD_ChangeOrig
sMD_ChangeNew
sMD_DeleteFinal
sMD_Create
sMD_Always
sMD_BaseTen
sMD_Default

Definition at line 146 of file SField.h.

IsSigning

enum class ripple::SField::IsSigning : unsigned char

strong

Enumerator
no
yes

Definition at line 158 of file SField.h.

Constructor & Destructor Documentation

SField() [1/4]

ripple::SField::SField ( SField const &  )

delete

SField() [2/4]

ripple::SField::SField ( SField &&  )

delete

SField() [3/4]

ripple::SField::SField	(	private_access_tag_t	,
		SerializedTypeID	tid,
		int	fv,
		const char *	fn,
		int	meta = sMD_Default,
		IsSigning	signing = IsSigning::yes
	)

Definition at line 86 of file SField.cpp.

SField() [4/4]

ripple::SField::SField ( private_access_tag_t  , int  fc  )

explicit

Definition at line 105 of file SField.cpp.

Member Function Documentation

operator=() [1/2]

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

delete

operator=() [2/2]

SField & ripple::SField::operator= ( SField &&  )

delete

getField() [1/4]

SField const & ripple::SField::getField ( int  fieldCode )

static

Definition at line 118 of file SField.cpp.

getField() [2/4]

SField const & ripple::SField::getField ( std::string const &  fieldName )

static

Definition at line 146 of file SField.cpp.

getField() [3/4]

static const SField & ripple::SField::getField ( int  type, int  value  )

static

Definition at line 195 of file SField.h.

getField() [4/4]

static const SField & ripple::SField::getField ( SerializedTypeID  type, int  value  )

static

Definition at line 201 of file SField.h.

getName()

std::string const & ripple::SField::getName

(

)

const

Definition at line 207 of file SField.h.

hasName()

bool ripple::SField::hasName

(

)

const

Definition at line 213 of file SField.h.

getJsonName()

Json::StaticString const & ripple::SField::getJsonName

(

)

const

Definition at line 219 of file SField.h.

operator Json::StaticString const &()

ripple::SField::operator Json::StaticString const &

(

)

const

Definition at line 224 of file SField.h.

isInvalid()

bool ripple::SField::isInvalid

(

)

const

Definition at line 230 of file SField.h.

isUseful()

bool ripple::SField::isUseful

(

)

const

Definition at line 236 of file SField.h.

isBinary()

bool ripple::SField::isBinary

(

)

const

Definition at line 242 of file SField.h.

isDiscardable()

bool ripple::SField::isDiscardable

(

)

const

Definition at line 252 of file SField.h.

getCode()

int ripple::SField::getCode

(

)

const

Definition at line 258 of file SField.h.

getNum()

int ripple::SField::getNum

(

)

const

Definition at line 263 of file SField.h.

getNumFields()

static int ripple::SField::getNumFields ( )

static

Definition at line 268 of file SField.h.

shouldMeta()

bool ripple::SField::shouldMeta

(

int

c

)

const

Definition at line 274 of file SField.h.

shouldInclude()

bool ripple::SField::shouldInclude

(

bool

withSigningField

)

const

Definition at line 280 of file SField.h.

operator==()

bool ripple::SField::operator==

(

const SField &

f

)

const

Definition at line 287 of file SField.h.

operator!=()

bool ripple::SField::operator!=

(

const SField &

f

)

const

Definition at line 293 of file SField.h.

compare()

int ripple::SField::compare ( const SField &  f1, const SField &  f2  )

static

Definition at line 130 of file SField.cpp.

getKnownCodeToField()

static std::map< int, SField const * > const & ripple::SField::getKnownCodeToField ( )

static

Definition at line 302 of file SField.h.

Member Data Documentation

notSigning

SField::IsSigning const ripple::SField::notSigning = IsSigning::no

static

Definition at line 159 of file SField.h.

fieldCode

int const ripple::SField::fieldCode

Definition at line 161 of file SField.h.

fieldType

SerializedTypeID const ripple::SField::fieldType

Definition at line 162 of file SField.h.

fieldValue

int const ripple::SField::fieldValue

Definition at line 163 of file SField.h.

fieldName

std::string const ripple::SField::fieldName

Definition at line 164 of file SField.h.

fieldMeta

int const ripple::SField::fieldMeta

Definition at line 165 of file SField.h.

fieldNum

int const ripple::SField::fieldNum

Definition at line 166 of file SField.h.

signingField

IsSigning const ripple::SField::signingField

Definition at line 167 of file SField.h.

jsonName

Json::StaticString const ripple::SField::jsonName

Definition at line 168 of file SField.h.

num

int ripple::SField::num = 0

staticprivate

Definition at line 308 of file SField.h.

knownCodeToField

std::map< int, SField const * > ripple::SField::knownCodeToField

staticprivate

Definition at line 309 of file SField.h.