The representation of a property in the Meta repository. More...

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

Inheritance diagram for OGF::MetaProperty:

Public Member Functions
	MetaProperty (const std::string &name, MetaClass *container, const std::string &type_name, bool read_only=false)
	MetaProperty constructor. More...

	MetaProperty (const std::string &name, MetaClass container, MetaType meta_type, bool read_only=false)
	MetaProperty constructor. More...

virtual	~MetaProperty ()
	MetaProperty destructor.

const std::string &	type_name () const
	Gets the type name. More...

MetaType *	type () const
	Gets the type. More...

virtual bool	set_value (Object *target, const std::string &value)
	Sets the value of this property in a target object. More...

virtual bool	get_value (const Object *target, std::string &value)
	Gets the value of this property from a target object. More...

virtual bool	set_value (Object *target, const Any &value)
	Sets the value of this property in a target object. More...

virtual bool	get_value (const Object *target, Any &value)
	Gets the value of this property from a target object. More...

void	set_read_only (bool x)
	Specify whether this MetaProperty is read only. More...

MetaMethod *	meta_method_get ()
	Gets the getter. More...

MetaMethod *	meta_method_set ()
	Gets the setter. More...

void	set_meta_method_get (MetaMethod *getter)
	Sets the getter. More...

void	set_meta_method_set (MetaMethod *setter)
	Sets the setter. More...

Public Member Functions inherited from OGF::MetaMember
	MetaMember (const std::string &name, MetaClass *container)
	MetaMember constructor. More...

	~MetaMember () override
	MetaMember destructor.

const std::string &	name () const
	Gets the name of this MetaMember. More...

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

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

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

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

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

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

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

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

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

virtual	~Object ()
	Object destructor.

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

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

unsigned int	id () const
	Gets the identifier of this object. More...

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

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

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. More...

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

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

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

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

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. More...

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

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

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

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

bool	get_signals_enabled () const
	Tests wheter signals are enabled. More...

void	set_signals_enabled (bool value)
	Enables or disables signals. More...

bool	get_slots_enabled () const
	Tests wheter slots are enabled. More...

void	set_slots_enabled (bool value)
	Enables or disables slots. More...

MetaClass *	get_meta_class () const
	Gets the meta class. More...

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

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

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

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

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

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. More...

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

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

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

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

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

void	unref () const
	Decrements the reference count. More...

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

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

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

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

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

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

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

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

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

void	clear_custom_attributes ()
	Clears the custom attributes.

Public Attributes
	__pad0__: bool read_only() const { return read_only_

Public Attributes inherited from OGF::MetaMember
	__pad0__: MetaClass* container_meta_class() const { return container_

	__pad1__: const std::string& get_name() const { return name_

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

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

	__pad1__: bool equals(const Object* other) const

Protected Member Functions
void	set_type_name (const std::string &type_name_in)
	Sets the type name of this property. More...

Protected Member Functions inherited from OGF::Object
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. More...

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

virtual	~Counted ()
	Destroys a reference counted object. More...

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. More...

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

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

Detailed Description

The representation of a property in the Meta repository.

Definition at line 145 of file meta_property.h.

Constructor & Destructor Documentation

◆ MetaProperty() [1/2]

OGF::MetaProperty::MetaProperty	(	const std::string &	name,
		MetaClass *	container,
		const std::string &	type_name,
		bool	read_only = `false`
	)

MetaProperty constructor.

Parameters

[in]	name	name of the property
[in]	container	the MetaClass this MetaProperty belongs to
[in]	type_name	the C++ type name of this property, as a string
[in]	read_only	true if the method has a getter but no setter

◆ MetaProperty() [2/2]

OGF::MetaProperty::MetaProperty	(	const std::string &	name,
		MetaClass *	container,
		MetaType *	meta_type,
		bool	read_only = `false`
	)

MetaProperty constructor.

Parameters

[in]	name	name of the property
[in]	container	the MetaClass this MetaProperty belongs to
[in]	meta_type	a pointer to the MetaType of the property
[in]	read_only	true if the method has a getter but no setter

Member Function Documentation

◆ get_value() [1/2]

virtual bool OGF::MetaProperty::get_value	(	const Object *	target,
		Any &	value
	)

virtual

Gets the value of this property from a target object.

Parameters

[in]	target	pointer to the object
[out]	value	value of the property, as an Any

◆ get_value() [2/2]

virtual bool OGF::MetaProperty::get_value	(	const Object *	target,
		std::string &	value
	)

virtual

Gets the value of this property from a target object.

Parameters

[in]	target	pointer to the object
[out]	value	value of the property, as a string

◆ meta_method_get()

MetaMethod* OGF::MetaProperty::meta_method_get ( )

inline

Gets the getter.

Returns: a pointer to the getter, as a MetaMethod.

Definition at line 247 of file meta_property.h.

◆ meta_method_set()

MetaMethod* OGF::MetaProperty::meta_method_set ( )

inline

Gets the setter.

Returns: a pointer to the setter, as a MetaMethod.

Definition at line 255 of file meta_property.h.

◆ set_meta_method_get()

void OGF::MetaProperty::set_meta_method_get ( MetaMethod * getter )

inline

Sets the getter.

Parameters

[in] getter a pointer to the getter, as a MetaMethod. Ownership is transfered to this MetaProperty.

Definition at line 264 of file meta_property.h.

◆ set_meta_method_set()

void OGF::MetaProperty::set_meta_method_set ( MetaMethod * setter )

inline

Sets the setter.

Parameters

[in] setter a pointer to the setter, as a MetaMethod. Ownership is transfered to this MetaProperty.

Definition at line 273 of file meta_property.h.

◆ set_read_only()

void OGF::MetaProperty::set_read_only ( bool x )

Specify whether this MetaProperty is read only.

Parameters

[in] x true if the property is set to read only, false otherwise

◆ set_type_name()

void OGF::MetaProperty::set_type_name ( const std::string & type_name_in )

inlineprotected

Sets the type name of this property.

Parameters

[in] type_name_in the C++ type name of this property, as a string

Definition at line 283 of file meta_property.h.

◆ set_value() [1/2]

virtual bool OGF::MetaProperty::set_value	(	Object *	target,
		const Any &	value
	)

virtual

Sets the value of this property in a target object.

Parameters

[in]	target	pointer to the object
[in]	value	new value of the property, as an Any

◆ set_value() [2/2]

virtual bool OGF::MetaProperty::set_value	(	Object *	target,
		const std::string &	value
	)

virtual

Sets the value of this property in a target object.

Parameters

[in]	target	pointer to the object
[in]	value	new value of the property, as a string

◆ type()

MetaType* OGF::MetaProperty::type ( ) const

Gets the type.

Returns: a pointer to the MetaType of this property.

◆ type_name()

const std::string& OGF::MetaProperty::type_name ( ) const

inline

Gets the type name.

Returns: the C++ type name of this MetaProperty, as a string.

Definition at line 194 of file meta_property.h.

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

OGF/gom/reflection/meta_property.h

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MetaProperty() [1/2]

◆ MetaProperty() [2/2]

Member Function Documentation

◆ get_value() [1/2]

◆ get_value() [2/2]

◆ meta_method_get()

◆ meta_method_set()

◆ set_meta_method_get()

◆ set_meta_method_set()

◆ set_read_only()

◆ set_type_name()

◆ set_value() [1/2]

◆ set_value() [2/2]

◆ type()

◆ type_name()