#include <NJournalBrowser.hpp>

Inherits QAbstractItemModel, and CNode.

Signals
void	update_view ()

Public Member Functions
	NJournalBrowser (const common::XML::XmlNode rootNode, QObject parent=0)

const common::SignalArgs &	signal (const QModelIndex &index) const

void	set_root_node (const common::XML::XmlNode *root_node)

void	request_journal ()

void	list_journal (common::SignalArgs &node)

void	send_exec_signal (const QModelIndex &index)

VIRTUAL FUNCTIONS
virtual QVariant	data (const QModelIndex &index, int role) const
	Implementation of `QAbstractItemModel::data()`. More...

virtual QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const
	Implementation of `QAbstractItemModel::index()`. More...

virtual QModelIndex	parent (const QModelIndex &child) const
	Implementation of `QAbstractItemModel::parent()->` More...

virtual int	rowCount (const QModelIndex &parent=QModelIndex()) const
	Implementation of `QAbstractItemModel::rowCount()`. More...

virtual int	columnCount (const QModelIndex &parent=QModelIndex()) const
	Implementation of `QAbstractItemModel::columnCount()`. More...

virtual QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
	Gives header titles. More...

virtual QString	tool_tip () const
	Gives the tool tip text. 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)

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

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

Private Member Functions
common::SignalArgs *	index_to_xml_node (const QModelIndex &index) const
	Converts an index to a signal node. More...

QString	read_attribute (const common::SignalArgs &sig, const char *name) const

Private Attributes
QStringList	m_columns

common::XML::XmlNode	m_root_node

QList< common::SignalArgs * >	m_children

boost::shared_ptr< common::XML::XmlDoc >	m_doc

boost::shared_ptr< common::XML::XmlDoc >	m_current_doc

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

Definition at line 39 of file NJournalBrowser.hpp.

Constructor & Destructor Documentation

NJournalBrowser	(	const common::XML::XmlNode *	rootNode,
		QObject *	parent = `0`
	)

Definition at line 37 of file NJournalBrowser.cpp.

Member Function Documentation

int columnCount ( const QModelIndex & parent = QModelIndex() ) const

virtual

Implementation of QAbstractItemModel::columnCount().

Returns: Always returns 1.

Definition at line 134 of file NJournalBrowser.cpp.

QVariant data	(	const QModelIndex &	index,
		int	role
	)		const

virtual

Implementation of QAbstractItemModel::data().

Only the role Qt::DisplayRole and Qt::DecorationRole are accepted. Other roles will result to the return of an empty QVariant object (built with the default construtor).

Parameters

index	Concerned item index.
role	Role of the returned value (only `Qt::DisplayRole` or `Qt::DecorationRole`).

Returns: Returns an empty QVariant object if the role is neither Qt::DisplayRole nor Qt::DecorationRole or if the index.isValid() returns false. Otherwise, returns the nodename of the the item at the specified index.

Definition at line 53 of file NJournalBrowser.cpp.

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

inlineprotectedvirtual

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 136 of file NJournalBrowser.hpp.

QVariant headerData	(	int	section,
		Qt::Orientation	orientation,
		int	role = `Qt::DisplayRole`
	)		const

virtual

Gives header titles.

Overrides QAbstractItemModel::headerData().

Parameters

section	Section number.
orientation	Header orientation.
role	Data role. Only `Qt::DisplayRole` is accepted.

Returns: Returns the data or an empty QVariant on error.

Definition at line 141 of file NJournalBrowser.cpp.

QModelIndex index	(	int	row,
		int	column,
		const QModelIndex &	parent = `QModelIndex()`
	)		const

virtual

Implementation of QAbstractItemModel::index().

Gives the index of the item at the given row and column under the given parent. If the parent index is not valid, the root item is taken as parent.

Parameters

row	Item row from the parent.
column	Item column.
parent	Item parent.

Returns: Returns the requested index, or a nullptr index if hasIndex(row, column, parent) returns false.

Definition at line 95 of file NJournalBrowser.cpp.

common::SignalArgs* index_to_xml_node ( const QModelIndex & index ) const

inlineprivate

Converts an index to a signal node.

Parameters

index Node index to convert

Returns: Returns the tree node, or nullptr if the index could not be converted (i.e. index is invalid)

Definition at line 153 of file NJournalBrowser.hpp.

void list_journal ( common::SignalArgs & node )

Definition at line 212 of file NJournalBrowser.cpp.

QModelIndex parent ( const QModelIndex & child ) const

virtual

Implementation of QAbstractItemModel::parent()->

Parameters

child Item index of which we would like to know the parent.

Returns: Returns the parent index of the given child or a nullptr index if the child is not a valid index.

Definition at line 116 of file NJournalBrowser.cpp.

QString read_attribute	(	const common::SignalArgs &	sig,
		const char *	name
	)		const

private

Definition at line 254 of file NJournalBrowser.cpp.

void request_journal ( )

Definition at line 203 of file NJournalBrowser.cpp.

int rowCount ( const QModelIndex & parent = QModelIndex() ) const

virtual

Implementation of QAbstractItemModel::rowCount().

If the parent index is not valid, the root item is taken as parent.

Returns: Returns the row count (number of children) of a given parent.

Definition at line 123 of file NJournalBrowser.cpp.

void send_exec_signal ( const QModelIndex & index )

Definition at line 222 of file NJournalBrowser.cpp.

void set_root_node ( const common::XML::XmlNode * root_node )

Definition at line 175 of file NJournalBrowser.cpp.

const SignalArgs & signal ( const QModelIndex & index ) const

Definition at line 164 of file NJournalBrowser.cpp.

QString tool_tip ( ) const

virtual

Gives the tool tip text.

Returns: Returns The class name

Implements CNode.

Definition at line 157 of file NJournalBrowser.cpp.

void update_view ( )

signal

Member Data Documentation

QList<common::SignalArgs *> m_children

private

Definition at line 144 of file NJournalBrowser.hpp.

QStringList m_columns

private

Definition at line 140 of file NJournalBrowser.hpp.

boost::shared_ptr<common::XML::XmlDoc> m_current_doc

private

Definition at line 160 of file NJournalBrowser.hpp.

boost::shared_ptr<common::XML::XmlDoc> m_doc

private

Definition at line 146 of file NJournalBrowser.hpp.

common::XML::XmlNode m_root_node

private

Definition at line 142 of file NJournalBrowser.hpp.

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

cf3/ui/core/NJournalBrowser.hpp
cf3/ui/core/NJournalBrowser.cpp

Signals

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation