A class that stores a variable of arbitrary type. More...

#include <OGF/gom/types/any.h>

Public Member Functions
	Any ()
	Any constructor.

	~Any ()
	Any destructor.

bool	is_null () const
	Tests whether this Any is null.

bool	is_a (const MetaType *type) const
	Tests whether the stored object inherits a given type.

void	reset ()
	Resets this Any to the initial null value.

	Any (const Any &rhs)
	Any copy constructor.

Any &	operator= (const Any &rhs)
	Any affectation operator.

std::string	as_string () const
	Gets a string representation.

MetaType *	meta_type () const
	Gets the MetaType of the stored value.

LifeCycle *	life_cycle () const
	Gets the LifeCycle.

template<class T >
void	set_value (const T &value)
	Sets the value of this Any.

void	set_value (const char *value)
	Sets the value of this Any (overload for string literals).

template<class T >
bool	get_value (SmartPointer< T > &value) const
	Gets the stored value as a SmartPointer.

template<class T >
bool	get_value (T &value) const
	Gets the stored value.

bool	get_value (std::string &value) const
	Gets the stored value (std::string overload).

bool	get_value (index_t &value) const
	Gets the stored value (index_t overload).

bool	get_value (signed_index_t &value) const
	Gets the stored value (signed_index_t overload).

bool	get_value (float &value) const
	Gets the stored value (float overload).

bool	get_value (double &value) const
	Gets the stored value (double overload).

template<class T >
bool	get_value (T *&value) const
	Gets the stored value (pointers overload).

void	create (MetaType *meta_type)
	Initializes this Any with the default value of a specified MetaType.

void	copy_from (Memory::pointer addr, MetaType *meta_type)
	Assigns a value from a specifed address and specified type to this Any.

bool	copy_to (Memory::pointer addr, MetaType *meta_type) const
	Copies the value stored in this Any at a specified address.

Memory::pointer	data ()
	Gets a pointer to the stored value.

Static Public Member Functions
static bool	convert_to_string (MetaType *meta_type, std::string &string, Memory::pointer value)
	Converts an object of a given type into a string.

static bool	convert_from_string (MetaType *meta_type, const std::string &string, Memory::pointer value)
	Converts a string into an object of a given type.

static bool	is_pointer_type (const MetaType *mtype)
	Tests whether a MetaType is a pointer type.

static bool	is_smart_pointer_type (const MetaType *mtype)
	Tests whether a MetaType is a smart pointer type.

static MetaType *	pointed_type (const MetaType *mtype)
	Gets the deferenced type.

static bool	pointer_can_be_casted_to (const MetaType derived_pointer_type, const MetaType base_pointer_type)
	Tests whether a pointer type can be casted to an object type.

static MetaType *	resolve_meta_type_by_typeid_name (const std::string &typeid_name)
	Finds a MetaType by typeid name.

template<class T >
static MetaType *	resolve_meta_type ()
	Gets the MetaType associated with a type.

Protected Member Functions
bool	copy_convert_to (Memory::pointer addr, MetaType *meta_type) const
	Tentatively converts the value stored in this Any to a type and if successful, store it at a specified address.

template<class T >
const T &	value_as () const
	Gets the value as a specific type.

void	destroy ()
	Deallocates the stored variable.

void	copy (const Any &rhs)
	Copies another Any.

Static Protected Member Functions
static std::string	meta_type_name (const MetaType *mt)

Detailed Description

A class that stores a variable of arbitrary type.

Definition at line 62 of file any.h.

Constructor & Destructor Documentation

◆ Any() [1/2]

OGF::Any::Any ( )

inline

Any constructor.

Definition at line 76 of file any.h.

◆ ~Any()

OGF::Any::~Any ( )

inline

Any destructor.

Definition at line 82 of file any.h.

◆ Any() [2/2]

OGF::Any::Any ( const Any & rhs )

inline

Any copy constructor.

Parameters

[in] rhs the Any to be copied.

Definition at line 114 of file any.h.

Member Function Documentation

◆ as_string()

std::string OGF::Any::as_string ( ) const

inline

Gets a string representation.

Returns: a string representation of the stored argument

Definition at line 136 of file any.h.

◆ convert_from_string()

static bool OGF::Any::convert_from_string	(	MetaType *	meta_type,
		const std::string &	string,
		Memory::pointer	value
	)

static

Converts a string into an object of a given type.

It does the same thing as ogf_convert_from_string(), namely it uses the Serializer registered in the Meta repository. We cannot use ogf_convert_from_string() since it would introduce a circular dependency in Meta, that uses ArgList. If conversion was not successful, an error message is displayed.

Parameters

[in]	meta_type	a pointer to the MetaType
[in]	string	a const reference to the string
[out]	value	a pointer to the converted value

Return values

true	if conversion was successful, false otherwise

◆ convert_to_string()

static bool OGF::Any::convert_to_string	(	MetaType *	meta_type,
		std::string &	string,
		Memory::pointer	value
	)

static

Converts an object of a given type into a string.

It does the same thing as ogf_convert_to_string(), namely it uses the Serializer registered in the Meta repository. We cannot use ogf_convert_to_string() since it would introduce a circular dependency in Meta, that uses ArgList. If conversion was not successful, an error message is displayed.

Parameters

[in]	meta_type	a pointer to the MetaType
[out]	string	the string representation of the object
[in]	value	a pointer to the object

Return values

true	if conversion was successful, false otherwise

◆ copy()

void OGF::Any::copy ( const Any & rhs )

inlineprotected

Copies another Any.

Parameters

[in] rhs the Any to be copied.

Definition at line 660 of file any.h.

◆ copy_convert_to()

bool OGF::Any::copy_convert_to	(	Memory::pointer	addr,
		MetaType *	meta_type
	)		const

protected

Tentatively converts the value stored in this Any to a type and if successful, store it at a specified address.

Parameters

[out]	addr	a memory address where to store the value
[in]	meta_type	the MetaType

Return values

true	on success
false	if no conversion is available.

◆ copy_from()

void OGF::Any::copy_from	(	Memory::pointer	addr,
		MetaType *	meta_type
	)

inline

Assigns a value from a specifed address and specified type to this Any.

Parameters

[in]	addr	a memory address
[in]	meta_type	the MetaType

Definition at line 484 of file any.h.

◆ copy_to()

bool OGF::Any::copy_to	(	Memory::pointer	addr,
		MetaType *	meta_type
	)		const

inline

Copies the value stored in this Any at a specified address.

Parameters

[out]	addr	a memory address where to store the value
[in]	meta_type	the MetaType

Return values

true	on success
false	if type mistmatches stored type and no conversion is available.

Definition at line 511 of file any.h.

◆ create()

void OGF::Any::create ( MetaType * meta_type )

inline

Initializes this Any with the default value of a specified MetaType.

Parameters

[in] meta_type a pointer to the MetaType.

Definition at line 465 of file any.h.

◆ data()

Memory::pointer OGF::Any::data ( )

inline

Gets a pointer to the stored value.

Use at your own risk !

Returns: a raw untyped pointer to the stored value

Definition at line 685 of file any.h.

◆ destroy()

void OGF::Any::destroy ( )

inlineprotected

Deallocates the stored variable.

Definition at line 642 of file any.h.

◆ get_value() [1/8]

bool OGF::Any::get_value ( double & value ) const

inline

Gets the stored value (double overload).

Parameters

[out] value the stored value.

Return values

true	if the specified type was correct.
false	otherwise.

Definition at line 379 of file any.h.

◆ get_value() [2/8]

bool OGF::Any::get_value ( float & value ) const

inline

Gets the stored value (float overload).

Parameters

[out] value the stored value.

Return values

true	if the specified type was correct.
false	otherwise.

Definition at line 345 of file any.h.

◆ get_value() [3/8]

bool OGF::Any::get_value ( index_t & value ) const

inline

Gets the stored value (index_t overload).

Parameters

[out] value the stored value.

Return values

true	if the specified type was correct.
false	otherwise.

Definition at line 273 of file any.h.

◆ get_value() [4/8]

bool OGF::Any::get_value ( signed_index_t & value ) const

inline

Gets the stored value (signed_index_t overload).

Parameters

[out] value the stored value.

Return values

true	if the specified type was correct.
false	otherwise.

Definition at line 309 of file any.h.

◆ get_value() [5/8]

template<class T >

bool OGF::Any::get_value ( SmartPointer< T > & value ) const

inline

Gets the stored value as a SmartPointer.

Parameters

[out] value the stored value.

Return values

true	if the specified type T corresponded to the stored value.
false	otherwise.

Definition at line 220 of file any.h.

◆ get_value() [6/8]

bool OGF::Any::get_value ( std::string & value ) const

inline

Gets the stored value (std::string overload).

Parameters

[out] value the stored value.

Return values

true	if the specified type was correct.
false	otherwise.

Definition at line 262 of file any.h.

◆ get_value() [7/8]

template<class T >

bool OGF::Any::get_value ( T & value ) const

inline

Gets the stored value.

Parameters

[out] value the stored value.

Return values

true	if the specified type T corresponded to the stored value.
false	otherwise.

Definition at line 235 of file any.h.

◆ get_value() [8/8]

template<class T >

bool OGF::Any::get_value ( T *& value ) const

inline

Gets the stored value (pointers overload).

More complicated than using the default function, this is because AnyStore is not a subtype of AnyStore if B is a subclass of A (inheritance does not play well with templates).

Parameters

[out] value the stored value.

Return values

true if the specified type was correct.

false otherwise.

Definition at line 417 of file any.h.

◆ is_a()

bool OGF::Any::is_a ( const MetaType * type ) const

Tests whether the stored object inherits a given type.

Parameters

[in] type a const pointer to the MetaType to be tested.

Return values

true	if this object inherits `type`
false	otherwise

◆ is_null()

bool OGF::Any::is_null ( ) const

inline

Tests whether this Any is null.

Return values

true	if the Any does not store a value.
false	otherwise.

Definition at line 91 of file any.h.

◆ is_pointer_type()

static bool OGF::Any::is_pointer_type ( const MetaType * mtype )

static

Tests whether a MetaType is a pointer type.

Return values

true	if MetaType is a pointer type.
false	otherwise.

◆ is_smart_pointer_type()

static bool OGF::Any::is_smart_pointer_type ( const MetaType * mtype )

static

Tests whether a MetaType is a smart pointer type.

Return values

true	if MetaType is SmartPointer<Counted>.
false	otherwise.

◆ life_cycle()

LifeCycle * OGF::Any::life_cycle ( ) const

Gets the LifeCycle.

The LifeCycle knows how to construct, copy, and destroy objects of a given type.

Returns: a pointer to the LifeCycle.

◆ meta_type()

MetaType * OGF::Any::meta_type ( ) const

inline

Gets the MetaType of the stored value.

Returns: a pointer to the MetaType or nullptr if there is no stored value.

Definition at line 149 of file any.h.

◆ operator=()

Any & OGF::Any::operator= ( const Any & rhs )

inline

Any affectation operator.

Parameters

[in] rhs the Any to be copied.

Returns: a reference to this Any after affectation.

Definition at line 124 of file any.h.

◆ pointed_type()

static MetaType * OGF::Any::pointed_type ( const MetaType * mtype )

static

Gets the deferenced type.

Parameters

[in] mtype a pointer MetaType.

Returns: the deferenced type.

◆ pointer_can_be_casted_to()

static bool OGF::Any::pointer_can_be_casted_to	(	const MetaType *	derived_pointer_type,
		const MetaType *	base_pointer_type
	)

static

Tests whether a pointer type can be casted to an object type.

Parameters

[in]	derived_pointer_type	the MetaType of the derived pointer type.
[in]	base_pointer_type	the MetaType of the base pointer type.

Return values

true	if pointers of type derived_pointer_type can be casted to pointers of type base_pointer_type.
false	otherwise.

◆ reset()

void OGF::Any::reset ( )

inline

Resets this Any to the initial null value.

Definition at line 106 of file any.h.

◆ resolve_meta_type()

template<class T >

static MetaType * OGF::Any::resolve_meta_type ( )

inlinestatic

Gets the MetaType associated with a type.

Returns: a pointer to the MetaType.

Definition at line 610 of file any.h.

◆ resolve_meta_type_by_typeid_name()

static MetaType * OGF::Any::resolve_meta_type_by_typeid_name ( const std::string & typeid_name )

static

Finds a MetaType by typeid name.

Parameters

[in] typeid_name the C++ RTTI name of the system, as obtained by typeid<T>.name()

Returns: the MetaType associated with type_name if it exists or nullptr otherwise

Redirects to Meta::resolve_meta_type_by_typeid_name(). It is there because we cannot include <meta.h> since it uses ArgList that in turn uses Any.

◆ set_value() [1/2]

void OGF::Any::set_value ( const char * value )

inline

Sets the value of this Any (overload for string literals).

Strings literals are stored internally as std::string.

Parameters

[in] value the string to be stored.

Definition at line 210 of file any.h.

◆ set_value() [2/2]

template<class T >

void OGF::Any::set_value ( const T & value )

inline

Sets the value of this Any.

Parameters

[in] value the value to be stored.

Definition at line 165 of file any.h.

◆ value_as()

template<class T >

const T & OGF::Any::value_as ( ) const

inlineprotected

Gets the value as a specific type.

Template Parameters

T the type.

Returns: a reference to the stored value as type T.

This is a brute-force cast, check before that type matches.

Definition at line 635 of file any.h.

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

OGF/gom/types/any.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Any() [1/2]

◆ ~Any()

◆ Any() [2/2]

Member Function Documentation

◆ as_string()

◆ convert_from_string()

◆ convert_to_string()

◆ copy()

◆ copy_convert_to()

◆ copy_from()

◆ copy_to()

◆ create()

◆ data()

◆ destroy()

◆ get_value() [1/8]

◆ get_value() [2/8]

◆ get_value() [3/8]

◆ get_value() [4/8]

◆ get_value() [5/8]

◆ get_value() [6/8]

◆ get_value() [7/8]

◆ get_value() [8/8]

◆ is_a()

◆ is_null()

◆ is_pointer_type()

◆ is_smart_pointer_type()

◆ life_cycle()

◆ meta_type()

◆ operator=()

◆ pointed_type()

◆ pointer_can_be_casted_to()

◆ reset()

◆ resolve_meta_type()

◆ resolve_meta_type_by_typeid_name()

◆ set_value() [1/2]

◆ set_value() [2/2]

◆ value_as()