#include <Journal.hpp>

Inherits Component.

Public Member Functions
	Journal (const std::string &name)

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

void	load_journal_file (const URI &file_path)

void	dump_journal_to (const URI &file_path) const

void	add_signal (const SignalArgs &signal_node)

void	execute_signals (const URI &filename)

SIGNALS
void	list_journal (SignalArgs &node)

void	load_journal (SignalArgs &node)

void	save_journal (SignalArgs &node)

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

virtual std::string	derived_type_name () const =0

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)

Static Public Member Functions
static boost::shared_ptr< Journal >	create_from_file (const std::string &name, const URI &file_path)

static std::string	type_name ()
	Get the class name. More...

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

Private Member Functions
XML::XmlNode	copy_node (const XML::XmlNode &in, XML::XmlNode &out) const

Private Attributes
boost::shared_ptr< XML::XmlDoc >	m_xmldoc
	The journal XML document. More...

XML::Map	m_info_node

XML::Map	m_signals_map

std::vector< XML::XmlNode >	m_signals
	The pointers to signals. More...

Additional Inherited Members
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...

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

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

Detailed Description

Component that maintains a journal of signals.

Author: Quentin Gasper

Definition at line 28 of file Journal.hpp.

Constructor & Destructor Documentation

Journal ( const std::string & name )

Contructor

Parameters

name	of the journal

Exceptions

InvalidPath if name is not a valid component name.

Definition at line 38 of file Journal.cpp.

~Journal ( )

virtual

Virtual destructor.

Definition at line 79 of file Journal.cpp.

Member Function Documentation

void add_signal ( const SignalArgs & signal_node )

Adds a signal to the journal.

Parameters

signal_node Signal to add.

Definition at line 117 of file Journal.cpp.

XmlNode copy_node	(	const XML::XmlNode &	in,
		XML::XmlNode &	out
	)		const

private

Existing child nodes under out are not deleted and its name is not modified.

Parameters

in	Node to copy.
out	Node where the copy has to be appended to.

Returns: Returns the added node.

Todo:: This method should be removed when the new Xml layer is in place.

Definition at line 224 of file Journal.cpp.

boost::shared_ptr< Journal > create_from_file	(	const std::string &	name,
		const URI &	file_path
	)

static

Creates a Journal and loads its contents from a file.

Parameters

name	Journal name.
file_path	File with the journal contents.

Returns: Returns the built journal.

Exceptions

FileSystemError	if the file does not exist.
InvalidPath	if `name` is not a valid component name.

Definition at line 86 of file Journal.cpp.

void dump_journal_to ( const URI & file_path ) const

Dumps the journal contents to a file. If the file already exists, it is overwritten.

Parameters

file_path The file to where the journal is saved.

Exceptions

FileSystemError if the file can not be open with write access.

Definition at line 108 of file Journal.cpp.

void execute_signals ( const URI & filename )

Definition at line 133 of file Journal.cpp.

void list_journal ( SignalArgs & node )

Definition at line 198 of file Journal.cpp.

void load_journal ( SignalArgs & node )

Definition at line 207 of file Journal.cpp.

void load_journal_file ( const URI & file_path )

Loads journal contents from a file. The journal is cleared before loading.

Parameters

file_path The file with the new journal contents.

Todo:: handle m_info_node and m_signals_map

Definition at line 98 of file Journal.cpp.

void save_journal ( SignalArgs & node )

Definition at line 214 of file Journal.cpp.

static std::string type_name ( )

inlinestatic

Get the class name.

Definition at line 50 of file Journal.hpp.

Member Data Documentation

XML::Map m_info_node

private

Definition at line 85 of file Journal.hpp.

std::vector<XML::XmlNode> m_signals

private

The pointers to signals.

Definition at line 90 of file Journal.hpp.

XML::Map m_signals_map

private

Definition at line 87 of file Journal.hpp.

boost::shared_ptr<XML::XmlDoc> m_xmldoc

private

The journal XML document.

Definition at line 83 of file Journal.hpp.

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

cf3/common/Journal.hpp
cf3/common/Journal.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation