A composite object in the GOM system. More...

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

Inheritance diagram for OGF::Node:

Public Member Functions
	Node (Node *parent=nullptr)
	Node constructor.

	~Node () override
	Node destructor.

virtual void	add_child (Node *child)
	Adds a child to this Node.

virtual void	remove_child (Node *child)
	Removes a child from this Node. \parma[in] child a pointer to the child to be removed.

Node *	get_parent () const
	Gets the parent.

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

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 Attributes
	: Node* ith_child(index_t i) const { ogf_assert(i < get_nb_children())

return	children_ [i]

	: size_t get_nb_children() const { return children_.size()

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

	: bool equals(const Object* other) const

Protected Member Functions
void	swap_children (Node n1, Node n2)
	Swaps two children by indices.

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.

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.

Detailed Description

A composite object in the GOM system.

By composite, we mean that it stores a list of references to children objects.

Definition at line 58 of file node.h.

Constructor & Destructor Documentation

◆ Node()

OGF::Node::Node ( Node * parent = nullptr )

explicit

Node constructor.

Parameters

[in] parent a pointer to this Node's parent if it exists, or nullptr otherwise.

Member Function Documentation

◆ add_child()

virtual void OGF::Node::add_child ( Node * child )

virtual

Adds a child to this Node.

Reference-counted pointers are stored in the Node (memory ownership is transferred to the Node).

Parameters

[in] child a pointer to the child to be added.

Reimplemented in OGF::CompositeGrob.

◆ get_parent()

Node * OGF::Node::get_parent ( ) const

inline

Gets the parent.

Returns: a pointer to the parent of this Node if it exists or nullptr otherwise

Definition at line 114 of file node.h.

◆ remove_child()

virtual void OGF::Node::remove_child ( Node * child )

virtual

Removes a child from this Node. \parma[in] child a pointer to the child to be removed.

Reimplemented in OGF::CompositeGrob.

◆ swap_children()

void OGF::Node::swap_children	(	Node *	n1,
		Node *	n2
	)

inlineprotected

Swaps two children by indices.

Parameters

[in] n1,n2 the two children to swap

Definition at line 123 of file node.h.

Member Data Documentation

◆ pad0

OGF::Node::__pad0__

Definition at line 86 of file node.h.

◆ pad1

OGF::Node::__pad1__

Definition at line 97 of file node.h.

◆ children_

return OGF::Node::children_[i]

Definition at line 97 of file node.h.

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

OGF/gom/types/node.h

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Node()

Member Function Documentation

◆ add_child()

◆ get_parent()

◆ remove_child()

◆ swap_children()

Member Data Documentation

◆ __pad0__

◆ __pad1__

◆ children_

◆ pad0

◆ pad1