#include <OGF/gom/reflection/meta_enum.h>

Inheritance diagram for OGF::MetaEnum:

Public Member Functions
	MetaEnum (const std::string &name)
	MetaEnum constructor.

	~MetaEnum () override
	MetaEnum destructor.

int	ith_value (index_t i) const
	Gets a value by index.

const std::string &	ith_name (index_t i) const
	Gets a symbolic name by index.

bool	has_value (int value) const
	Tests whether a MetaEnum has a value.

bool	has_value (const std::string &name) const
	Tests whether a MetaEnum has a symbolic name.

int	get_value_by_name (const std::string &name) const
	Gets a value by symbolic name.

const std::string &	get_name_by_value (int value) const
	Gets a symbolic name by value.

bool	add_value (const std::string &name, int value, bool allow_aliases=false)
	Adds a new value to this MetaEnum.

bool	add_values (const ArgList &values)
	Adds values to this MegaEnum.

Public Member Functions inherited from OGF::MetaType
	MetaType (const std::string &name)
	MetaType constructor.

	~MetaType () override
	MetaType destructor.

const std::string &	name () const
	Gets the C++ name of the type.

void	set_typeid_name (const std::string &typeid_name)
	Sets the typeid name.

const std::string &	typeid_name () const
	Gets the typeid name.

LifeCycle *	life_cycle () const
	Gets the LifeCycle associated with the type.

void	set_life_cycle (LifeCycle *life_cycle)
	Sets the LifeCycle associated with the type.

Serializer *	serializer () const
	Gets the serializer associated with the type.

void	set_serializer (Serializer *ser)
	Sets the serializer associated with the type.

virtual void	pre_delete ()
	Removes all variables that use the meta type system before deleting.

Public Member Functions inherited from OGF::MetaInformation
void	search (const std::string &needle, const std::string &path="") override
	Displays the names of all objects that contain a substring.

bool	has_custom_attribute (const std::string &name) const
	Tests whether a given custom attribute exists.

std::string	ith_custom_attribute_name (index_t i) const
	Gets the name of a custom attribute by index.

std::string	ith_custom_attribute_value (index_t i) const
	Gets the value of a custom attribute by index.

std::string	custom_attribute_value (const std::string &name) const
	Gets the value of a new custom attribute.

void	create_custom_attribute (const std::string &name, const std::string &value)
	Creates a new custom attribute.

void	set_custom_attribute (const std::string &name, const std::string &value)
	Sets the value of a new custom attribute.

Public Member Functions inherited from OGF::Object
	Object (bool transient=false)
	Object constructor.

	~Object () override
	Object destructor.

virtual MetaClass *	meta_class () const
	Gets the meta class.

virtual void	set_meta_class (MetaClass *mclass)
	Sets the meta class.

Numeric::uint32	id () const
	Gets the identifier of this object.

std::string	string_id () const
	Gets the unique string identifier.

bool	has_method (const std::string &method_name) const
	Tests whether a method is defined.

virtual bool	invoke_method (const std::string &method_name, const ArgList &args, Any &ret_val)
	Invokes a method by method name and argument list, and gets the return value.

bool	invoke_method (const std::string &method_name, const ArgList &args)
	Invokes a method by method name and argument list.

bool	invoke_method (const std::string &method_name)
	Invokes a method by method name.

bool	has_property (const std::string &prop_name) const
	Tests whether a property is defined.

virtual bool	get_property (const std::string &prop_name, std::string &prop_value) const
	Gets a property.

virtual Connection *	connect_signal_to_slot (const std::string &signal_name, Object *to, const std::string &slot_name)
	Connects a signal with a slot of another object.

virtual void	add_connection (Connection *connection)
	Adds a connection to this object.

virtual void	remove_connection (Connection *connection)
	Removes a connection to this object.

virtual void	get_element (index_t i, Any &value) const
	Gets an element by index.

virtual void	set_element (index_t i, const Any &value)
	Sets an element by index.

void	get_element (index_t item, index_t component, Any &value) const
	Gets an element by item and component.

void	set_element (index_t item, index_t component, const Any &value)
	Sets an element by item and component.

virtual index_t	get_dimension () const
	Gets the number of elements per item.

bool	get_signals_enabled () const
	Tests wheter signals are enabled.

void	set_signals_enabled (bool value)
	Enables or disables signals.

bool	get_slots_enabled () const
	Tests wheter slots are enabled.

void	set_slots_enabled (bool value)
	Enables or disables slots.

MetaClass *	get_meta_class () const
	Gets the meta class.

std::string	get_string_id () const
	Gets the unique string identifier.

virtual std::string	get_doc () const
	Gets the documentation.

virtual Sign	compare (const Object *other) const
	Compares this object with another one.

virtual bool	is_a (const MetaType *type) const
	Tests whether this object inherits a given type.

void	disconnect ()
	Removes all connections from signals of this objects.

void	enable_signals ()
	Enables signals.

void	disable_signals ()
	Disables signals.

void	enable_slots ()
	Enables slots.

void	disable_slots ()
	Disables slots.

void	set_properties (const ArgList &args)
	Sets several properties in a single call.

virtual bool	set_property (const std::string &name, const std::string &value)
	Sets an individual property.

void	help () const
	Displays some help about this object.

virtual bool	set_property (const std::string &name, const Any &value)
	Sets an individual property.

virtual bool	get_property (const std::string &prop_name, Any &prop_value) const
	Gets a property.

Public Member Functions inherited from GEO::Counted
void	ref () const
	Increments the reference count.

void	unref () const
	Decrements the reference count.

bool	is_shared () const
	Check if the object is shared.

int	nb_refs () const
	Gets the number of references that point to this object.

Public Member Functions inherited from OGF::CustomAttributes
size_t	nb_custom_attributes () const
	Gets the number of custom attributes.

std::string	ith_custom_attribute_name (index_t i) const
	Gets the name of a custom attribute by index.

std::string	ith_custom_attribute_value (index_t i) const
	Gets the value of a custom attribute by index.

bool	has_custom_attribute (const std::string &name) const
	Tests whether a given custom attribute exists.

void	create_custom_attribute (const std::string &name, const std::string &value)
	Creates a new custom attribute.

void	set_custom_attribute (const std::string &name, const std::string &value)
	Sets the value of a new custom attribute.

std::string	custom_attribute_value (const std::string &name) const
	Gets the value of a new custom attribute.

void	clear_custom_attributes ()
	Clears the custom attributes.

Public Attributes
	: size_t nb_values() const { return values_.size()

Public Attributes inherited from OGF::MetaType
	: virtual bool is_subtype_of(const MetaType* other) const

	: const std::string& get_name() const { return name()

Public Attributes inherited from OGF::MetaInformation
	: size_t nb_custom_attributes() const

Public Attributes inherited from OGF::Object
	: virtual index_t get_nb_elements() const

	: bool equals(const Object* other) const

Additional Inherited Members
Static Public Member Functions inherited from OGF::Object
static Object *	id_to_object (unsigned int id)
	Gets an object from a unique object id.

Static Public Member Functions inherited from GEO::Counted
static void	ref (const Counted *counted)
	Increments the reference count.

static void	unref (const Counted *counted)
	Decrements the reference count.

Static Public Attributes inherited from OGF::Object
static constexpr Numeric::uint32	INVALID_ID = 0xbadbeef

Protected Member Functions inherited from OGF::Object
virtual bool	set_property_and_record_to_history (const std::string &name, const Any &value, Interpreter *interpreter)
	Sets an individual property and record modification to history.

virtual bool	emit_signal (const std::string &signal_name, const ArgList &args, bool called_from_slot=false)
	Emits a signal and calls the slots it is connected to.

Protected Member Functions inherited from GEO::Counted
	Counted ()
	Creates a reference counted object.

virtual	~Counted ()
	Destroys a reference counted object.

Detailed Description

MetaType for enums.

Gives the symbolic names and associated values.

Definition at line 56 of file meta_enum.h.

Constructor & Destructor Documentation

◆ MetaEnum()

OGF::MetaEnum::MetaEnum ( const std::string & name )

MetaEnum constructor.

Parameters

[in] name C++ type name of the enum

Member Function Documentation

◆ add_value()

bool OGF::MetaEnum::add_value	(	const std::string &	name,
		int	value,
		bool	allow_aliases = `false`
	)

Adds a new value to this MetaEnum.

Parameters

[in]	name	symbolic name
[in]	value	associated value. Can be negative.
[in]	allow_aliases	if set, then one can add the same value several times with different names

Returns: true if the value could be added; false otherwise, that is, value already existed in enum and allow_aliases was not set

◆ add_values()

bool OGF::MetaEnum::add_values ( const ArgList & values )

Adds values to this MegaEnum.

Parameters

[in] values an arglist with name,value pairs

Returns: true if the values could be added; false otherwise, that is, one or several values already existed in enum.

◆ get_name_by_value()

const std::string & OGF::MetaEnum::get_name_by_value ( int value ) const

Gets a symbolic name by value.

Parameters

[in] value the value

Returns: the symbolic name associated with value

Precondition: has_value(value)

◆ get_value_by_name()

int OGF::MetaEnum::get_value_by_name ( const std::string & name ) const

Gets a value by symbolic name.

Parameters

[in] name the symbolic name

Returns: the value associated with name

Precondition: has_value(name)

◆ has_value() [1/2]

bool OGF::MetaEnum::has_value ( const std::string & name ) const

Tests whether a MetaEnum has a symbolic name.

Parameters

[in] name the symbolic name

Return values

true	if this MetaEnum has a value with name `name`
false	otherwise

◆ has_value() [2/2]

bool OGF::MetaEnum::has_value ( int value ) const

Tests whether a MetaEnum has a value.

Parameters

[in] value the value

Return values

true	if this MetaEnum has `value`
false	otherwise

◆ ith_name()

const std::string & OGF::MetaEnum::ith_name ( index_t i ) const

inline

Gets a symbolic name by index.

Parameters

[in] i index, in 0..nb_values() - 1

Returns: the symbolic name associated with index i

Definition at line 95 of file meta_enum.h.

◆ ith_value()

int OGF::MetaEnum::ith_value ( index_t i ) const

inline

Gets a value by index.

Parameters

[in] i index, in 0..nb_values() - 1

Returns: the value associated with index i

Definition at line 85 of file meta_enum.h.

Member Data Documentation

◆ pad0

OGF::MetaEnum::__pad0__

Definition at line 68 of file meta_enum.h.

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

OGF/gom/reflection/meta_enum.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MetaEnum()

Member Function Documentation

◆ add_value()

◆ add_values()

◆ get_name_by_value()

◆ get_value_by_name()

◆ has_value() [1/2]

◆ has_value() [2/2]

◆ ith_name()

◆ ith_value()

Member Data Documentation

◆ __pad0__

◆ pad0