blender::io::serialize::Value Class Reference

#include <BLI_serialize.hh>

Inherited by blender::io::serialize::PrimitiveValue< int64_t, eValueType::Int >, blender::io::serialize::PrimitiveValue< double, eValueType::Double >, blender::io::serialize::PrimitiveValue< bool, eValueType::Boolean >, blender::io::serialize::PrimitiveValue< int, eValueType::Enum >, blender::io::serialize::ArrayValue, blender::io::serialize::DictionaryValue, blender::io::serialize::NullValue, blender::io::serialize::PrimitiveValue< T, V >, and blender::io::serialize::StringValue.

Public Member Functions
	Value ()=delete
virtual	~Value ()=default
eValueType	type () const
const StringValue *	as_string_value () const
const IntValue *	as_int_value () const
const DoubleValue *	as_double_value () const
const BooleanValue *	as_boolean_value () const
const EnumValue *	as_enum_value () const
const ArrayValue *	as_array_value () const
const DictionaryValue *	as_dictionary_value () const

Protected Member Functions
	Value (eValueType type)

Detailed Description

Class containing a (de)serializable value.

To serialize from or to a specific format the Value will be used as an intermediate container holding the values. Value class is abstract. There are concrete classes to for different data types.

• StringValue: contains a string.
• IntValue: contains an integer.
• ArrayValue: contains an array of elements. Elements don't need to be the same type.
• NullValue: represents nothing (null pointer or optional).
• BooleanValue: contains a boolean (true/false).
• DoubleValue: contains a double precision floating point number.
• DictionaryValue: represents an object (key value pairs where keys are strings and values can be of different types.

Definition at line 112 of file BLI_serialize.hh.

Constructor & Destructor Documentation

Value() [1/2]

blender::io::serialize::Value::Value ( eValueType type )

inlineexplicitprotected

Definition at line 117 of file BLI_serialize.hh.

References type().

Referenced by blender::io::serialize::ArrayValue::ArrayValue(), blender::io::serialize::DictionaryValue::DictionaryValue(), blender::io::serialize::NullValue::NullValue(), blender::io::serialize::PrimitiveValue< int64_t, eValueType::Int >::PrimitiveValue(), and blender::io::serialize::StringValue::StringValue().

Value() [2/2]

blender::io::serialize::Value::Value ( )

delete

~Value()

virtual blender::io::serialize::Value::~Value ( )

virtualdefault

Member Function Documentation

as_array_value()

const ArrayValue * blender::io::serialize::Value::as_array_value

(

)

const

Casts to an ArrayValue. Will return nullptr when it is a different type.

Definition at line 56 of file serialize.cc.

References blender::io::serialize::Array.

Referenced by blender::bke::idprop::convert_from_serialize_value(), blender::io::serialize::convert_to_json(), and blender::bke::bake::deserialize_typed_array().

as_boolean_value()

const BooleanValue * blender::io::serialize::Value::as_boolean_value

(

)

const

Casts to a BooleanValue. Will return nullptr when it is a different type.

Definition at line 40 of file serialize.cc.

References blender::io::serialize::Boolean.

Referenced by blender::io::serialize::convert_to_json(), and blender::bke::bake::deserialize_primitive_value().

as_dictionary_value()

const DictionaryValue * blender::io::serialize::Value::as_dictionary_value

(

)

const

Casts to an DictionaryValue. Will return nullptr when it is a different type.

Definition at line 64 of file serialize.cc.

References blender::io::serialize::Dictionary.

Referenced by blender::io::serialize::convert_to_json(), blender::bke::bake::deserialize_bake(), blender::bke::idprop::tests::test_array_to_value(), blender::bke::idprop::tests::test_double_to_value(), blender::bke::idprop::tests::test_float_to_value(), blender::bke::idprop::tests::test_int_to_value(), blender::bke::idprop::tests::test_string_to_value(), blender::bke::bake::try_load_grease_pencil(), and blender::bke::bake::try_load_instances().

as_double_value()

const DoubleValue * blender::io::serialize::Value::as_double_value

(

)

const

Casts to a DoubleValue. Will return nullptr when it is a different type.

Definition at line 32 of file serialize.cc.

References blender::io::serialize::Double.

Referenced by blender::io::serialize::convert_to_json(), and blender::bke::bake::deserialize_float().

as_enum_value()

const EnumValue * blender::io::serialize::Value::as_enum_value

(

)

const

Casts to a EnumValue. Will return nullptr when it is a different type.

Definition at line 48 of file serialize.cc.

References blender::io::serialize::Enum.

Referenced by blender::io::serialize::convert_to_json().

as_int_value()

const IntValue * blender::io::serialize::Value::as_int_value

(

)

const

Casts to an IntValue. Will return nullptr when it is a different type.

Definition at line 24 of file serialize.cc.

References blender::io::serialize::Int.

Referenced by blender::io::serialize::convert_to_json(), blender::bke::bake::deserialize_float(), and blender::bke::bake::deserialize_int().

as_string_value()

const StringValue * blender::io::serialize::Value::as_string_value

(

)

const

Casts to a StringValue. Will return nullptr when it is a different type.

Definition at line 16 of file serialize.cc.

References blender::io::serialize::String.

Referenced by blender::io::serialize::convert_to_json(), and blender::io::serialize::DictionaryValue::lookup_str().

type()

eValueType blender::io::serialize::Value::type ( ) const

inline

Definition at line 122 of file BLI_serialize.hh.

Referenced by blender::bke::idprop::tests::check_container_value(), blender::bke::idprop::convert_from_serialize_value(), blender::io::serialize::convert_to_json(), and Value().

---

The documentation for this class was generated from the following files:

• BLI_serialize.hh
• serialize.cc