A naming scope in an Interpreter. More...

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

Inheritance diagram for OGF::Scope:

Public Member Functions
	Scope (Object *object)
	Scope constructor. More...

	~Scope () override
	Scope destructor.

virtual Any	resolve (const std::string &name)=0
	Finds a variable by id. More...

virtual void	list_names (std::vector< std::string > &names) const
	Lists all the variable names available in this scope. More...

void	search (const std::string &needle, const std::string &path="") override
	Displays the names of all objects that contain a substring. 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...

Protected Attributes
Object *	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. 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...

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

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

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

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

Detailed Description

A naming scope in an Interpreter.

Definition at line 69 of file interpreter.h.

Constructor & Destructor Documentation

◆ Scope()

OGF::Scope::Scope ( Object * object )

Scope constructor.

Parameters

[in] object a pointer to the object where this Scope accesses variables.

Member Function Documentation

◆ list_names()

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

virtual

Lists all the variable names available in this scope.

Parameters

[out] names the variable names.

Reimplemented in OGF::CompositeGrobScope, OGF::MetaTypesScope, OGF::InterfaceScope, and OGF::GlobalScope.

◆ resolve()

virtual Any OGF::Scope::resolve ( const std::string & name )

pure virtual

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.

Implemented in OGF::CompositeGrobScope, OGF::MetaTypesScope, OGF::InterfaceScope, and OGF::GlobalScope.

◆ search()

void OGF::Scope::search	(	const std::string &	needle,
		const std::string &	path = `""`
	)

overridevirtual

Displays the names of all objects that contain a substring.

Parameters

[in]	needle	the substring
[in]	path	the path to be prepended to the names

Reimplemented from OGF::Object.

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

OGF/gom/interpreter/interpreter.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Scope()

Member Function Documentation

◆ list_names()

◆ resolve()

◆ search()