Represents a JSON value. More...

#include <value.h>

Classes
struct	CommentInfo

class	CZString

union	ValueHolder

Public Types
typedef UInt	ArrayIndex

typedef ValueConstIterator	const_iterator

typedef Json::Int	Int

typedef ValueIterator	iterator

typedef std::vector< std::string >	Members

typedef std::map< CZString, Value >	ObjectValues

typedef Json::UInt	UInt

Public Member Functions
Value &	append (const Value &value)
	Append value to array at the end. More...

bool	asBool () const

const char *	asCString () const

double	asDouble () const

Int	asInt () const

std::string	asString () const

UInt	asUInt () const

const_iterator	begin () const

iterator	begin ()

void	clear ()

int	compare (const Value &other)

bool	empty () const
	Return true if empty array, empty object, or null; otherwise, false. More...

const_iterator	end () const

iterator	end ()

Value	get (UInt index, const Value &defaultValue) const

Value	get (const char *key, const Value &defaultValue) const
	Return the member named key if it exist, defaultValue otherwise. More...

Value	get (const std::string &key, const Value &defaultValue) const
	Return the member named key if it exist, defaultValue otherwise. More...

std::string	getComment (CommentPlacement placement) const
	Include delimiters and embedded newlines. More...

Members	getMemberNames () const
	Return a list of the member names. More...

bool	hasComment (CommentPlacement placement) const

bool	isArray () const

bool	isBool () const

bool	isConvertibleTo (ValueType other) const

bool	isDouble () const

bool	isInt () const

bool	isIntegral () const

bool	isMember (const char *key) const
	Return true if the object has a member named key. More...

bool	isMember (const std::string &key) const
	Return true if the object has a member named key. More...

bool	isNull () const

bool	isNumeric () const

bool	isObject () const

bool	isString () const

bool	isUInt () const

bool	isValidIndex (UInt index) const
	Return true if index < size(). More...

bool	operator! () const
	Return isNull() More...

bool	operator!= (const Value &other) const

bool	operator< (const Value &other) const

bool	operator<= (const Value &other) const

Value &	operator= (const Value &other)

bool	operator== (const Value &other) const

bool	operator> (const Value &other) const

bool	operator>= (const Value &other) const

Value &	operator[] (UInt index)

const Value &	operator[] (UInt index) const

Value &	operator[] (const char *key)
	Access an object value by name, create a null member if it does not exist. More...

const Value &	operator[] (const char *key) const
	Access an object value by name, returns null if there is no member with that name. More...

Value &	operator[] (const std::string &key)
	Access an object value by name, create a null member if it does not exist. More...

const Value &	operator[] (const std::string &key) const
	Access an object value by name, returns null if there is no member with that name. More...

Value &	operator[] (const StaticString &key)
	Access an object value by name, create a null member if it does not exist. More...

Value	removeMember (const char *key)
	Remove and return the named member. More...

Value	removeMember (const std::string &key)
	Same as removeMember(const char*) More...

void	resize (UInt size)

void	setComment (const char *comment, CommentPlacement placement)
	Comments must be //... or /* ... */. More...

void	setComment (const std::string &comment, CommentPlacement placement)
	Comments must be //... or /* ... */. More...

UInt	size () const
	Number of values in array or object. More...

void	swap (Value &other)

std::string	toStyledString () const

ValueType	type () const

	Value (ValueType type=nullValue)
	Create a default Value of the given type. More...

	Value (Int value)

	Value (UInt value)

	Value (double value)

	Value (const char *value)

	Value (const char beginValue, const char endValue)

	Value (const StaticString &value)
	Constructs a value from a static string. More...

	Value (const std::string &value)

	Value (bool value)

	Value (const Value &other)

	~Value ()

Static Public Attributes
static const Int	maxInt

static const UInt	maxUInt

static const Int	minInt

static const Value	null

Private Member Functions
Value &	resolveReference (const char *key, bool isStatic)

Private Attributes
int	allocated_: 1

CommentInfo *	comments_

ValueType	type_: 8

union Json::Value::ValueHolder	value_

Friends
class	ValueIteratorBase

Detailed Description

Represents a JSON value.

This class is a discriminated union wrapper that can represents a:

signed integer [range: Value::minInt - Value::maxInt]
unsigned integer (range: 0 - Value::maxUInt)
double
UTF-8 string
boolean
'null'
an ordered list of Value
collection of name/value pairs (javascript object)

The type of the held value is represented by a ValueType and can be obtained using type().

values of an objectValue or arrayValue can be accessed using operator[]() methods. Non const methods will automatically create the a nullValue element if it does not exist. The sequence of an arrayValue will be automatically resize and initialized with nullValue. resize() can be used to enlarge or truncate an arrayValue.

The get() methods can be used to obtanis default value in the case the required element does not exist.

It is possible to iterate over the list of a objectValue values using the getMemberNames() method.

Definition at line 111 of file value.h.

Member Typedef Documentation

typedef UInt Json::Value::ArrayIndex

Definition at line 124 of file value.h.

typedef ValueConstIterator Json::Value::const_iterator

Definition at line 121 of file value.h.

typedef Json::Int Json::Value::Int

Definition at line 123 of file value.h.

typedef ValueIterator Json::Value::iterator

Definition at line 120 of file value.h.

typedef std::vector<std::string> Json::Value::Members

Definition at line 119 of file value.h.

typedef std::map<CZString, Value> Json::Value::ObjectValues

Definition at line 161 of file value.h.

typedef Json::UInt Json::Value::UInt

Definition at line 122 of file value.h.

Constructor & Destructor Documentation

Json::Value::Value ( ValueType type = nullValue )

Create a default Value of the given type.

This is a very useful constructor.
To create an empty array, pass arrayValue.
To create an empty object, pass objectValue.
Another Value can then be set to this one by assignment.

This is useful since clear() and resize() will not alter types.

Examples:

Json::Value null_value; // null
Json::Value arr_value(Json::arrayValue); // []
Json::Value obj_value(Json::objectValue); // {}

Json::Value::Value ( Int value )

Json::Value::Value ( UInt value )

Json::Value::Value ( double value )

Json::Value::Value ( const char * value )

Json::Value::Value	(	const char *	beginValue,
		const char *	endValue
	)

Json::Value::Value ( const StaticString & value )

Constructs a value from a static string.

Like other value string constructor but do not duplicate the string for internal storage. The given string must remain alive after the call to this constructor. Example of usage:

* Json::Value aValue( StaticString("some text") );

*

Json::Value::Value ( const std::string & value )

Json::Value::Value ( bool value )

Json::Value::Value ( const Value & other )

Json::Value::~Value ( )

Member Function Documentation

Value& Json::Value::append ( const Value & value )

Append value to array at the end.

Equivalent to jsonvalue[jsonvalue.size()] = value;

Referenced by Vispa.Views.PropertyView.PropertyView::addProperty(), TriggerJSONMonitoring::globalEndLuminosityBlockSummary(), jsoncollector::DataPoint::mergeAndSerialize(), jsoncollector::DataPointDefinition::serialize(), jsoncollector::DataPoint::serialize(), and BeautifulSoup.Tag::setString().

bool Json::Value::asBool ( ) const

const char* Json::Value::asCString ( ) const

double Json::Value::asDouble ( ) const

Int Json::Value::asInt ( ) const

std::string Json::Value::asString ( ) const

Referenced by jsoncollector::DataPointDefinition::deserialize(), and jsoncollector::DataPoint::deserialize().

UInt Json::Value::asUInt ( ) const

const_iterator Json::Value::begin ( ) const

iterator Json::Value::begin ( )

void Json::Value::clear ( )

Remove all object members and array elements.

Precondition: type() is arrayValue, objectValue, or nullValue

Postcondition: type() is unchanged

Referenced by Vispa.Views.WidgetView.WidgetView::closeEvent(), Vispa.Views.BoxDecayView.BoxDecayView::closeEvent(), Vispa.Share.FindAlgorithm.FindAlgorithm::findUsingFindDialog(), Vispa.Views.LineDecayView.LineDecayView::setDataObjects(), Vispa.Views.WidgetView.WidgetView::setDataObjects(), Vispa.Views.TreeView.TreeView::updateContent(), Vispa.Views.TableView.TableView::updateContent(), Vispa.Views.BoxDecayView.BoxDecayView::updateContent(), and Vispa.Views.PropertyView.PropertyView::updateContent().

int Json::Value::compare ( const Value & other )

bool Json::Value::empty ( ) const

Return true if empty array, empty object, or null; otherwise, false.

Referenced by Vispa.Gui.VispaWidget.TextField::setAutosizeFont(), and Vispa.Gui.VispaWidget.TextField::setAutotruncate().

const_iterator Json::Value::end ( ) const

Referenced by Types.LuminosityBlockRange::cppID(), and Types.EventRange::cppID().

iterator Json::Value::end ( )

Referenced by Types.LuminosityBlockRange::cppID(), and Types.EventRange::cppID().

Value Json::Value::get	(	UInt	index,
		const Value &	defaultValue
	)		const

If the array contains at least index+1 elements, returns the element value, otherwise returns defaultValue.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), rrapi.RRApi::columns(), rrapi.RRApi::count(), rrapi.RRApi::data(), jsoncollector::DataPointDefinition::deserialize(), jsoncollector::DataPoint::deserialize(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), rrapi.RRApi::report(), rrapi.RRApi::reports(), rrapi.RRApi::tables(), rrapi.RRApi::tags(), rrapi.RRApi::templates(), and rrapi.RRApi::workspaces().

Value Json::Value::get	(	const char *	key,
		const Value &	defaultValue
	)		const

Return the member named key if it exist, defaultValue otherwise.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), rrapi.RRApi::columns(), rrapi.RRApi::count(), rrapi.RRApi::data(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), rrapi.RRApi::report(), rrapi.RRApi::reports(), rrapi.RRApi::tables(), rrapi.RRApi::tags(), rrapi.RRApi::templates(), and rrapi.RRApi::workspaces().

Value Json::Value::get	(	const std::string &	key,
		const Value &	defaultValue
	)		const

Return the member named key if it exist, defaultValue otherwise.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), rrapi.RRApi::columns(), rrapi.RRApi::count(), rrapi.RRApi::data(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), rrapi.RRApi::report(), rrapi.RRApi::reports(), rrapi.RRApi::tables(), rrapi.RRApi::tags(), rrapi.RRApi::templates(), and rrapi.RRApi::workspaces().

std::string Json::Value::getComment ( CommentPlacement placement ) const

Include delimiters and embedded newlines.

Members Json::Value::getMemberNames ( ) const

Return a list of the member names.

If null, return an empty list.

Precondition: type() is objectValue or nullValue

Postcondition: if type() was nullValue, it remains nullValue

bool Json::Value::hasComment ( CommentPlacement placement ) const

bool Json::Value::isArray ( ) const

Referenced by jsoncollector::DataPointDefinition::deserialize(), and jsoncollector::DataPoint::deserialize().

bool Json::Value::isBool ( ) const

bool Json::Value::isConvertibleTo ( ValueType other ) const

bool Json::Value::isDouble ( ) const

bool Json::Value::isInt ( ) const

bool Json::Value::isIntegral ( ) const

bool Json::Value::isMember ( const char * key ) const

Return true if the object has a member named key.

bool Json::Value::isMember ( const std::string & key ) const

Return true if the object has a member named key.

bool Json::Value::isNull ( ) const

bool Json::Value::isNumeric ( ) const

bool Json::Value::isObject ( ) const

bool Json::Value::isString ( ) const

bool Json::Value::isUInt ( ) const

bool Json::Value::isValidIndex ( UInt index ) const

Return true if index < size().

bool Json::Value::operator! ( ) const

Return isNull()

bool Json::Value::operator!= ( const Value & other ) const

bool Json::Value::operator< ( const Value & other ) const

bool Json::Value::operator<= ( const Value & other ) const

Value& Json::Value::operator= ( const Value & other )

bool Json::Value::operator== ( const Value & other ) const

bool Json::Value::operator> ( const Value & other ) const

bool Json::Value::operator>= ( const Value & other ) const

Value& Json::Value::operator[] ( UInt index )

Access an array element (zero based index ). If the array contains less than index element, then null value are inserted in the array so that its size is index+1. (You may need to say 'value[0u]' to get your compiler to distinguish this from the operator[] which takes a string.)

const Value& Json::Value::operator[] ( UInt index ) const

Access an array element (zero based index ) (You may need to say 'value[0u]' to get your compiler to distinguish this from the operator[] which takes a string.)

Value& Json::Value::operator[] ( const char * key )

Access an object value by name, create a null member if it does not exist.

const Value& Json::Value::operator[] ( const char * key ) const

Access an object value by name, returns null if there is no member with that name.

Value& Json::Value::operator[] ( const std::string & key )

Access an object value by name, create a null member if it does not exist.

const Value& Json::Value::operator[] ( const std::string & key ) const

Access an object value by name, returns null if there is no member with that name.

Value& Json::Value::operator[] ( const StaticString & key )

Access an object value by name, create a null member if it does not exist.

If the object as no entry for that name, then the member name used to store the new entry is not duplicated. Example of use:

* Json::Value object;
* static const StaticString code("code");
* object[code] = 1234;
* 

Value Json::Value::removeMember ( const char * key )

Remove and return the named member.

Do nothing if it did not exist.

Returns: the removed Value, or null.

Precondition: type() is objectValue or nullValue

Postcondition: type() is unchanged

Value Json::Value::removeMember ( const std::string & key )

Same as removeMember(const char*)

void Json::Value::resize ( UInt size )

Resize the array to size elements. New elements are initialized to null. May only be called on nullValue or arrayValue.

Precondition: type() is arrayValue or nullValue

Postcondition: type() is arrayValue

Referenced by Vispa.Gui.TextDialog.TextDialog::__init__(), Vispa.Plugins.ConfigEditor.ToolDialog.ToolDialog::__init__(), Vispa.Main.MainWindow.MainWindow::_loadIni(), and Vispa.Gui.PortConnection.PointToPointConnection::updateConnection().

Value& Json::Value::resolveReference	(	const char *	key,
		bool	isStatic
	)

private

void Json::Value::setComment	(	const char *	comment,
		CommentPlacement	placement
	)

Comments must be //... or /* ... */.

Referenced by ConfigToolBase.ConfigToolBase::apply().

void Json::Value::setComment	(	const std::string &	comment,
		CommentPlacement	placement
	)

Comments must be //... or /* ... */.

Referenced by ConfigToolBase.ConfigToolBase::apply().

UInt Json::Value::size ( ) const

Number of values in array or object.

Referenced by jsoncollector::DataPointDefinition::deserialize(), and jsoncollector::DataPoint::deserialize().

void Json::Value::swap ( Value & other )

Swap values.

Note: Currently, comments are intentionally not swapped, for both logic and efficiency.

std::string Json::Value::toStyledString ( ) const

ValueType Json::Value::type ( ) const

Referenced by cuy.ValElement::__init__(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::inputCommands(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::outputCommands(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::outputEventContent(), and Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::properties().

Friends And Related Function Documentation

friend class ValueIteratorBase

friend

Definition at line 113 of file value.h.

Member Data Documentation

int Json::Value::allocated_

private

Definition at line 440 of file value.h.

CommentInfo* Json::Value::comments_

private

Definition at line 445 of file value.h.

const Int Json::Value::maxInt

static

Definition at line 128 of file value.h.

const UInt Json::Value::maxUInt

static

Definition at line 129 of file value.h.

const Int Json::Value::minInt

static

Definition at line 127 of file value.h.

const Value Json::Value::null

static

Definition at line 126 of file value.h.

ValueType Json::Value::type_

private

Definition at line 439 of file value.h.

Referenced by Modules.Service::_placeImpl(), Modules.ESSource::_placeImpl(), Modules.ESProducer::_placeImpl(), Modules.ESPrefer::copy(), Mixins._TypedParameterizable::dumpPython(), Modules.ESPrefer::dumpPythonAs(), Modules.Service::insertInto(), RandomRunSource.RandomRunSource::insertInto(), Mixins._TypedParameterizable::insertInto(), Modules.ESSource::moduleLabel_(), Modules.ESProducer::moduleLabel_(), Modules.ESSource::nameInProcessDesc_(), Modules.ESProducer::nameInProcessDesc_(), and Modules.ESPrefer::nameInProcessDesc_().

union Json::Value::ValueHolder Json::Value::value_

private

Classes

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation