Client root. This class is wrapper for cf3::common::Root class on the client side. A NRoot object may never have any child. Add them to the internal Root componenent instead. It can be obtained by calling root() method. More...

#include <NRoot.hpp>

Inherits QObject, and CNode.

Public Member Functions
	NRoot (const std::string &name)
	Constructor. More...

virtual QString	tool_tip () const
	Gives the text to put on a tool tip. More...

Handle< CNode const >	child_from_root (cf3::Uint number) const
	Gets a child node bqsed on its number. More...

Handle< CNode >	child_from_root (cf3::Uint number)
	Gets a child node bqsed on its number. More...

const common::UUCount &	uuid () const
	Gives the client UuiD. More...

Public Member Functions inherited from CNode
	CNode (const std::string &name, const QString &component_type, Type type)

std::string	derived_type_name () const
	Component::derived_type_name implementation. More...

QString	component_type () const

Handle< CNode >	child (Uint index)

bool	is_local_component () const

Type	type () const

bool	is_root ()

void	set_properties (const common::SignalArgs &node)

void	set_signals (const common::SignalArgs &node)

void	modify_options (const QMap< QString, QString > &options)
	Modifies options. More...

void	list_options (QList< boost::shared_ptr< common::Option > > &list)

void	list_properties (QMap< QString, QString > &props)

void	list_signals (QList< ActionInfo > &actions)

template<class TYPE >
Handle< const TYPE >	castTo () const

template<class TYPE >
Handle< TYPE >	castTo ()

void	connect_notifier (QObject reciever, const char signal, const char *slot)

void	add_node (boost::shared_ptr< CNode > node)
	Adds a sub-node. More...

void	remove_node (const QString &node_name)
	Removes a sub-node. More...

CNodeNotifier *	notifier () const

void	list_child_paths (QStringList &list, bool recursive, bool client_node=true) const
	Lists all children paths in a string list. More...

void	request_signal_signature (const QString &name)

void	local_signature (const QString &name, common::SignalArgs &node)
	Retrieves the signature of a local signal. More...

void	finish_setup ()

virtual void	about_to_be_removed ()

void	reply_update_tree (common::SignalArgs &node)

void	reply_configure (common::SignalArgs &node)

void	reply_list_content (common::SignalArgs &node)

void	reply_signal_signature (common::SignalArgs &node)
	Method called when the server replies to a signal. More...

Public Member Functions inherited from Component
	Component (const std::string &name)

virtual	~Component ()
	Virtual destructor. More...

const std::string &	name () const
	Access the name of the component. More...

void	rename (const std::string &name)
	Rename the component. More...

URI	uri () const
	Construct the full path. More...

void	complete_path (URI &path) const

Handle< Component >	access_component (const URI &path) const

Handle< Component >	access_component_checked (const URI &path)

Handle< Component const >	access_component_checked (const URI &path) const

Handle< Component >	handle ()
	Get a handle to the component. More...

Handle< Component const >	handle () const

template<typename ComponentT >
Handle< ComponentT >	handle ()

template<typename ComponentT >
Handle< ComponentT const >	handle () const

Handle< Component >	parent () const

Handle< Component const >	root () const

Handle< Component >	root ()

Handle< Component >	get_child (const std::string &name)

Handle< Component const >	get_child (const std::string &name) const

Handle< Component >	get_child_checked (const std::string &name)

Handle< Component const >	get_child_checked (const std::string &name) const

Handle< Component >	create_component (const std::string &name, const std::string &builder)
	Build a (sub)component of this component using the extended type_name of the component. More...

template<typename T >
Handle< T >	create_component (const std::string &name)
	Create a (sub)component of this component automatically cast to the specified type. More...

template<typename T >
Handle< T >	create_static_component (const std::string &name)
	Create a static "always there" subcomponent. More...

Component &	add_component (const boost::shared_ptr< Component > &subcomp)
	Add the passed component as a subcomponent. More...

void	add_link (Component &linked_component)

boost::shared_ptr< Component >	remove_component (const std::string &name)
	Remove a (sub)component of this component. More...

boost::shared_ptr< Component >	remove_component (Component &subcomp)
	Remove a (sub)component of this component. More...

void	clear ()
	Remove all sub-components of this component, except for the static ones. More...

void	move_to (Component &to_parent)

std::string	tree (bool basic_mode=false, Uint depth=0, Uint recursion_level=0) const

std::string	info (const std::string &what=std::string("cospt")) const

size_t	count_children () const

PropertyList &	properties ()

const PropertyList &	properties () const

OptionList &	options ()

const OptionList &	options () const

void	reset_options ()
	Reset all options to their default value. More...

void	configure_option_recursively (const std::string &optname, const boost::any &val)

Component &	mark_basic ()
	marks this component as basic. More...

template<typename ComponentT >
void	put_components (std::vector< boost::shared_ptr< ComponentT > > &vec, const bool recurse)

template<typename ComponentT >
void	put_components (std::vector< boost::shared_ptr< ComponentT const > > &vec, const bool recurse) const

template<>
void	put_components (std::vector< boost::shared_ptr< Component > > &vec, const bool recurse)

template<>
void	put_components (std::vector< boost::shared_ptr< Component const > > &vec, const bool recurse) const

Component::iterator	begin ()
	The begin iterator for a range containing Components. More...

Component::iterator	end ()
	The end iterator for a range containing Components. More...

Component::const_iterator	begin () const
	The begin iterator for a range containing Components (const version) More...

Component::const_iterator	end () const
	The end iterator for a range containing Components (const version) More...

Component::iterator	recursive_begin ()
	The begin iterator for a recursive range containing Components. More...

Component::iterator	recursive_end ()
	The end iterator for a recursive range containing Components. More...

Component::const_iterator	recursive_begin () const
	The begin iterator for a recursive range containing Components (const version) More...

Component::const_iterator	recursive_end () const
	The end iterator for a recursive range containing Components (const version) More...

template<typename T >
Handle< T >	create_component (const std::string &name, const std::string &builder)
	Create a component using the reduced builder name. More...

void	signal_configure (SignalArgs &args)
	configures all the options on this class More...

void	signal_create_component (SignalArgs &args)
	creates a component from this component More...

void	signal_delete_component (SignalArgs &args)
	delete this component More...

void	signal_move_component (SignalArgs &args)
	moves a component from this component to another More...

void	signal_list_tree (SignalArgs &args) const
	lists the sub components and puts them on the xml_tree More...

void	signal_list_tree_recursive (SignalArgs &args) const
	prints tree recursively More...

void	signal_list_properties (SignalArgs &args) const
	lists the properties of this component More...

void	signal_list_options (SignalArgs &args) const
	lists the properties of this component More...

void	signal_list_options_recursive (SignalArgs &args) const
	prints all options recursive More...

void	signal_list_signals (SignalArgs &args) const
	lists the signals of this component More...

void	signal_list_signals_recursive (SignalArgs &args) const
	prints all signals recursive More...

void	signal_print_info (SignalArgs &args) const
	gets info on this component More...

void	signal_print_tree (SignalArgs &args) const
	signal to print the tree More...

void	signature_print_tree (SignalArgs &args) const
	signature to signal_print_tree More...

void	signal_rename_component (SignalArgs &args)
	renames this component More...

void	signal_save_tree (SignalArgs &args)
	dumps the tree to a file More...

void	signal_list_content (SignalArgs &args)
	gives information about this component such as options, signals, ... More...

void	signal_signature (SignalArgs &args)
	Gives a signal signature, if any. More...

void	signature_create_component (SignalArgs &args)

void	signature_rename_component (SignalArgs &args)

void	signature_move_component (SignalArgs &args)

void	signal_store_timings (SignalArgs &args)
	Signal to store the timings (if enabled) into properties, i.e. for readout from python or the GUI. More...

void	signal_clear (SignalArgs &args)
	Signal to remove all sub-components. More...

void	signal_reset_options (SignalArgs &args)
	Signal to set all options to their default value. More...

void	signal_add_tag (SignalArgs &args)
	Signal to add a tag. More...

void	signature_add_tag (SignalArgs &args)

Public Member Functions inherited from SignalHandler
	~SignalHandler ()

const storage_t &	signal_list () const

SignalPtr	signal (const SignalID &sname)

SignalCPtr	signal (const SignalID &sname) const

SignalRet	call_signal (const SignalID &sname, SignalArgs &sinput)
	Calls the signal by providing its name and input. More...

SignalRet	call_signal (const SignalID &sname, std::vector< std::string > &sinput)
	Calls the signal by providing its name and input. More...

bool	signal_exists (const SignalID &sname) const
	Checks if a signal exists or not. More...

Signal &	regist_signal (const SignalID &sname)
	Regist signal. More...

void	unregist_signal (const SignalID &sname)
	Unregist signal. More...

Public Member Functions inherited from ConnectionManager
	~ConnectionManager ()
	destructor closes all connections More...

Connection *	connection (const std::string &name)

Connection *	manage_connection (const std::string &name)
	manages a connection (creates if necessary) More...

Public Member Functions inherited from TaggedObject
	TaggedObject ()
	Constructor. More...

bool	has_tag (const std::string &tag) const

void	add_tag (const std::string &tag)

std::vector< std::string >	get_tags () const

void	remove_tag (const std::string &tag)

Signals
common::UUCount	m_uuid
	Client UuiD. More...

void	signature_connect_server (common::SignalArgs &frame)

void	signature_disconnect_server (common::SignalArgs &frame)

void	signal_connect_server (common::SignalArgs &frame)

void	signal_disconnect_server (common::SignalArgs &frame)

void	connected ()

void	network_disconnected (common::SignalArgs &args)

void	network_connected (common::SignalArgs &)
	Slot called when the client is connected to the server. More...

virtual void	disable_local_signals (QMap< QString, bool > &localSignals) const

void	shutdown (common::SignalArgs &args)
	Method called when the server sends a shutdown event. More...

void	client_registration (common::SignalArgs &node)
	Method called when the server confirms/rejects the client registration. More...

void	frame_rejected (common::SignalArgs &node)
	Method called when the server rejects a request. More...

Additional Inherited Members
Public Types inherited from CNode
enum	Type { STANDARD_NODE = 0, LOCAL_NODE = 1, DEBUG_NODE = 2 }
	Defines the sub-node types. More...

Public Types inherited from Component
typedef ComponentIterator< Component >	iterator
	type of the iterator to Component More...

typedef ComponentIterator< Component const >	const_iterator
	type of the iterator to constant Component More...

Public Types inherited from SignalHandler
typedef std::vector< SignalPtr >	storage_t
	storage type for signals More...

Static Public Member Functions inherited from CNode
static std::string	type_name ()

static boost::shared_ptr< CNode >	create_from_xml (common::XML::XmlNode node)
	Creates an object tree from a given node. More...

Static Public Member Functions inherited from Component
static std::string	type_name ()
	Get the class name. More...

Public Attributes inherited from SignalHandler
storage_t	m_signals
	storage of the signals More...

Protected Member Functions inherited from CNode
virtual void	setup_finished ()

Protected Member Functions inherited from Component
Component &	add_static_component (const boost::shared_ptr< Component > &subcomp)
	Add a static (sub)component of this component. More...

void	raise_tree_updated_event ()
	raise event that the path has changed More...

Protected Attributes inherited from CNode
CNodeNotifier *	m_notifier
	This internal notifier. More...

QStringList	m_local_signals
	Lists the names of the local signals. More...

QMutex *	m_mutex

bool	m_content_listed

bool	m_listing_content

bool	m_is_root

QList< ActionInfo >	m_action_sigs
	List of signals that can be remotely executed. More...

Detailed Description

Client root. This class is wrapper for cf3::common::Root class on the client side. A NRoot object may never have any child. Add them to the internal Root componenent instead. It can be obtained by calling root() method.

Author: Quentin Gasper.

Definition at line 34 of file NRoot.hpp.

Constructor & Destructor Documentation

NRoot ( const std::string & name )

Constructor.

Parameters

name Node name

Definition at line 40 of file NRoot.cpp.

Member Function Documentation

Handle< CNode const > child_from_root ( cf3::Uint number ) const

Gets a child node bqsed on its number.

Parameters

number Child number.

Returns: Returns the child, or a null pointer if the number is not valid.

Definition at line 97 of file NRoot.cpp.

Handle< CNode > child_from_root ( cf3::Uint number )

Gets a child node bqsed on its number.

Parameters

number Child number.

Returns: Returns the child, or a null pointer if the number is not valid.

Definition at line 113 of file NRoot.cpp.

void client_registration ( common::SignalArgs & node )

private

Method called when the server confirms/rejects the client registration.

Parameters

node	Signal parameters. Should contain a boolean value named "accepted". If this value is `true`, the server has accepted the registration. Otherwise the server rejects the registration, in this case, the method closes the network connection.

Definition at line 168 of file NRoot.cpp.

void connected ( )

signal

void disable_local_signals ( QMap< QString, bool > & localSignals ) const

protectedvirtual

Disables the local signals that need to.

Parameters

localSignals Map of local signals. All values are set to true by default.

Implements CNode.

Definition at line 199 of file NRoot.cpp.

void frame_rejected ( common::SignalArgs & node )

private

Method called when the server rejects a request.

Parameters

node	Signal parameters. Should contain two values: a string named "uuid" that contains the rejected frame UuiD a string named "reason" that contains the reason of the reject

Definition at line 185 of file NRoot.cpp.

void network_connected ( common::SignalArgs & )

privateslot

Slot called when the client is connected to the server.

Definition at line 136 of file NRoot.cpp.

void network_disconnected ( common::SignalArgs & args )

privateslot

Definition at line 152 of file NRoot.cpp.

void shutdown ( common::SignalArgs & args )

private

Method called when the server sends a shutdown event.

Parameters

node	Signal parameters. This parameter is not used.

Definition at line 160 of file NRoot.cpp.

void signal_connect_server ( common::SignalArgs & frame )

Definition at line 235 of file NRoot.cpp.

void signal_disconnect_server ( common::SignalArgs & frame )

Definition at line 247 of file NRoot.cpp.

void signature_connect_server ( common::SignalArgs & frame )

Definition at line 209 of file NRoot.cpp.

void signature_disconnect_server ( common::SignalArgs & frame )

Definition at line 224 of file NRoot.cpp.

QString tool_tip ( ) const

virtual

Gives the text to put on a tool tip.

Returns: The name of the class.

Implements CNode.

Definition at line 90 of file NRoot.cpp.

const UUCount & uuid ( ) const

Gives the client UuiD.

Returns: Returns the Client UuiD

Definition at line 129 of file NRoot.cpp.

Member Data Documentation

common::UUCount m_uuid

private

Client UuiD.

Definition at line 103 of file NRoot.hpp.

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

cf3/ui/core/NRoot.hpp
cf3/ui/core/NRoot.cpp

Public Member Functions

Signals

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation