OGF::MetaTypesScope Class Reference

A Scope that contains MetaTypes. More...

#include <OGF/gom/interpreter/interpreter.h>

Inheritance diagram for OGF::MetaTypesScope:

Public Member Functions
	MetaTypesScope (const std::string &prefix="")
	MetaTypesScope constructor.
	~MetaTypesScope () override
	MetaTypesScope destructor.
Any	resolve (const std::string &name) override
	Finds a variable by id.
void	list_names (std::vector< std::string > &names) const override
	Lists all the variable names available in this scope.
public::MetaTypesScope *	create_subscope (const std::string &name)
Public Member Functions inherited from OGF::Scope
	Scope (Object *object)
	Scope constructor.
	~Scope () override
	Scope destructor.
void	search (const std::string &needle, const std::string &path="") override
	Displays the names of all objects that contain a substring.
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.
unsigned int	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.

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.
Public Attributes inherited from OGF::Object
	: virtual index_t get_nb_elements() const
	: bool equals(const Object* other) const
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.
Protected Member Functions inherited from GEO::Counted
	Counted ()
	Creates a reference counted object.
virtual	~Counted ()
	Destroys a reference counted object.
Protected Attributes inherited from OGF::Scope
Object *	object_

Detailed Description

A Scope that contains MetaTypes.

Encapsulates query_interface() in such a way that automatic completion works when using object.I.

Definition at line 179 of file interpreter.h.

Constructor & Destructor Documentation

MetaTypesScope()

OGF::MetaTypesScope::MetaTypesScope

(

const std::string &

prefix = ""

)

MetaTypesScope constructor.

Parameters

[in]

prefix

optional prefix for object names, for instance "OGF::" or "std::"

Member Function Documentation

list_names()

void OGF::MetaTypesScope::list_names ( std::vector< std::string > &  names ) const

overridevirtual

Lists all the variable names available in this scope.

Parameters

[out]

names

the variable names.

Reimplemented from OGF::Scope.

resolve()

Any OGF::MetaTypesScope::resolve ( const std::string &  name )

overridevirtual

Finds a variable by id.

Parameters

[in]

name

the name, can be either a previously bound id

Returns

an Any with the variable, or a null Any if name is not bound to a variable.

Implements OGF::Scope.

---

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

• OGF/gom/interpreter/interpreter.h