#include <UnifiedData.hpp>

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

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

template<typename T >
void	add (T &data)
	add a data component to the unified data table More...

boost::tuple< Handle< common::Component >, Uint >	location (const Uint data_glb_idx)

boost::tuple< Handle< common::Component >, Uint >	location (const Uint data_glb_idx) const

boost::tuple< common::Component &, Uint >	location_v2 (const Uint data_glb_idx)

boost::tuple< const common::Component &, Uint >	location_v2 (const Uint data_glb_idx) const

boost::tuple< Uint, Uint >	location_idx (const Uint data_glb_idx) const

Uint	location_comp_idx (const Component &data) const

Uint	size () const

std::vector< Handle< common::Component > > &	components ()

const std::vector< Handle< common::Component > > &	components () const

Component &	component (const Uint idx)

const Component &	component (const Uint idx) const

Uint	unified_idx (const common::Component &component, const Uint local_idx) const

Uint	unified_idx (const boost::tuple< Handle< common::Component >, Uint > &loc) const

void	reset ()

bool	contains (const common::Component &data) const

template<typename DATA >
void	add (DATA &data)

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 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 Attributes
std::vector< Handle< common::Component > >	m_data_vector
	vector of components to view as continuous More...

Handle< common::List< Uint > >	m_data_indices
	start index for each component in the continous view More...

Handle< common::Group >	m_data_links
	group with links to data components (links to elements of m_data_vector) More...

Uint	m_size
	total number of indices spanning all components More...

std::map< common::Component const *, Uint >	m_start_idx
	map component to start index 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

This class allows to access data spread over multiple components with a continuous index

Precondition: the data components must be of the same type and must have a member function "Uint size() const" defined.

Definition at line 31 of file UnifiedData.hpp.

Constructor & Destructor Documentation

UnifiedData ( const std::string & name )

Contructor

Parameters

name	of the component

Definition at line 24 of file UnifiedData.cpp.

virtual ~UnifiedData ( )

inlinevirtual

Virtual destructor.

Definition at line 43 of file UnifiedData.hpp.

Member Function Documentation

void add ( T & data )

add a data component to the unified data table

Parameters

[in] data component

Note: The data component must have a "size()" member function defined

void add ( DATA & data )

inline

Definition at line 118 of file UnifiedData.hpp.

Component& component ( const Uint idx )

inline

Definition at line 84 of file UnifiedData.hpp.

const Component& component ( const Uint idx ) const

inline

Definition at line 86 of file UnifiedData.hpp.

std::vector< Handle< common::Component > > & components ( )

non-const access to the unified data components

Returns: vector of data components

Definition at line 150 of file UnifiedData.cpp.

const std::vector< Handle< common::Component > > & components ( ) const

const access to the unified data components

Returns: vector of data components

Definition at line 159 of file UnifiedData.cpp.

bool contains ( const common::Component & data ) const

Definition at line 67 of file UnifiedData.cpp.

boost::tuple< Handle< common::Component >, Uint > location ( const Uint data_glb_idx )

Get the component and local index in the component given a continuous index spanning multiple components

Parameters

[in] data_glb_idx continuous index covering multiple components

Returns: boost::tuple<data_Handle< type > component, Uint idx_in_component>

Definition at line 78 of file UnifiedData.cpp.

boost::tuple< Handle< common::Component >, Uint > location ( const Uint data_glb_idx ) const

Definition at line 88 of file UnifiedData.cpp.

Uint location_comp_idx ( const Component & data ) const

Definition at line 132 of file UnifiedData.cpp.

boost::tuple< Uint, Uint > location_idx ( const Uint data_glb_idx ) const

Get the const component and local index in the component given a continuous index spanning multiple components

Parameters

[in] data_glb_idx continuous index covering multiple components

Returns: boost::tuple<Uint component_idx, Uint idx_in_component>

Definition at line 122 of file UnifiedData.cpp.

boost::tuple< common::Component &, Uint > location_v2 ( const Uint data_glb_idx )

Definition at line 98 of file UnifiedData.cpp.

boost::tuple< const common::Component &, Uint > location_v2 ( const Uint data_glb_idx ) const

Definition at line 108 of file UnifiedData.cpp.

void reset ( )

Definition at line 54 of file UnifiedData.cpp.

Uint size ( ) const

Get the total number of data spanning multiple components

Returns: the size

Definition at line 141 of file UnifiedData.cpp.

static std::string type_name ( )

inlinestatic

Get the class name.

Definition at line 46 of file UnifiedData.hpp.

Uint unified_idx	(	const common::Component &	component,
		const Uint	local_idx
	)		const

Definition at line 35 of file UnifiedData.cpp.

Uint unified_idx ( const boost::tuple< Handle< common::Component >, Uint > & loc ) const

Definition at line 44 of file UnifiedData.cpp.

Member Data Documentation

Handle<common::List<Uint> > m_data_indices

private

start index for each component in the continous view

Definition at line 102 of file UnifiedData.hpp.

Handle<common::Group> m_data_links

private

group with links to data components (links to elements of m_data_vector)

Definition at line 105 of file UnifiedData.hpp.

std::vector< Handle<common::Component> > m_data_vector

private

vector of components to view as continuous

Definition at line 99 of file UnifiedData.hpp.

Uint m_size

private

total number of indices spanning all components

Definition at line 108 of file UnifiedData.hpp.

std::map<common::Component const*,Uint> m_start_idx

private

map component to start index

Definition at line 111 of file UnifiedData.hpp.

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

cf3/mesh/UnifiedData.hpp
cf3/mesh/UnifiedData.cpp

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation