#include <VariablesDescriptor.hpp>

Inherits Component.

Classes
struct	Dimensionalities

struct	Implementation

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

virtual	~VariablesDescriptor ()
	virtual destructor More...

VariablesDescriptor interface
Functions to manage the list of variables that is stored in a field
Uint	nb_vars () const

Uint	size () const

Uint	size (const std::string &name) const

Uint	offset (const std::string &name) const

Uint	offset (const Uint var_nb) const

bool	has_variable (const std::string &name) const

Dimensionalities::Type	dimensionality (const std::string &name) const

Uint	var_number (const std::string &name) const

Uint	var_length (const std::string &name) const

Uint	var_length (const Uint var_nb) const

const std::string &	user_variable_name (const std::string &name) const

const std::string &	user_variable_name (const Uint var_nb) const

const std::string &	internal_variable_name (const Uint var_nb) const

void	set_variables (const std::string &description)
	Setup variables acording to a Field string description. More...

void	set_variables (const std::string &description, const Uint dimension)
	Setup variables together with their dimension. More...

std::string	description () const
	Get the string description for all the variables. More...

void	push_back (const std::string &name, const Dimensionalities::Type type)

void	push_back (const std::string &name, const Uint nb_vars)

void	prefix_variable_names (const std::string &prefix)

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
boost::scoped_ptr< Implementation >	m_implementation

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

Holds information related to a set of variables that are stored in the same field. Provides options: For each variable, an option composed of lowercase(internal variable name) + _variable_name dimensions: Dimension of the problem (i.e. number of spatial coordinates used)

Author: Bart Janssens; Tiago Quintino

Definition at line 30 of file VariablesDescriptor.hpp.

Constructor & Destructor Documentation

VariablesDescriptor ( const std::string & name )

constructor

Parameters

name	of the component

Definition at line 387 of file VariablesDescriptor.cpp.

~VariablesDescriptor ( )

virtual

virtual destructor

Definition at line 394 of file VariablesDescriptor.cpp.

Member Function Documentation

std::string description ( ) const

Get the string description for all the variables.

Definition at line 507 of file VariablesDescriptor.cpp.

VariablesDescriptor::Dimensionalities::Type dimensionality ( const std::string & name ) const

The dimensionality of the variable with the given name

Parameters

name	Internal name of the variable

Definition at line 456 of file VariablesDescriptor.cpp.

bool has_variable ( const std::string & name ) const

Return if the variable with a given name is found in this description

Parameters

name	Internal name of the variable

Returns: true if found, false if not found

Definition at line 449 of file VariablesDescriptor.cpp.

const std::string & internal_variable_name ( const Uint var_nb ) const

Return the internal unique name of a variable

Parameters

var_nb The variable number

Definition at line 500 of file VariablesDescriptor.cpp.

Uint nb_vars ( ) const

The number of variables This is not the same as the total number of scalars. Some variables can be vectors or tensors

Returns: the number of variables

Definition at line 414 of file VariablesDescriptor.cpp.

Uint offset ( const std::string & name ) const

Offset in the field for a variable, i.e. the start index of the variable in the Field row.

Exceptions

SetupError if dimensions is not set

Parameters

name	Internal name of the variable

Definition at line 435 of file VariablesDescriptor.cpp.

Uint offset ( const Uint var_nb ) const

Offset in the field for a variable, i.e. the start index of the variable in the Field row.

Exceptions

SetupError if dimensions is not set

Parameters

name	Internal name of the variable

Definition at line 442 of file VariablesDescriptor.cpp.

void prefix_variable_names ( const std::string & prefix )

Definition at line 528 of file VariablesDescriptor.cpp.

void push_back	(	const std::string &	name,
		const Dimensionalities::Type	type
	)

Append a variable to the back of the list. Does nothing if the variable with the given name already existed

Parameters

name	Internal name of the variable

Definition at line 400 of file VariablesDescriptor.cpp.

void push_back	(	const std::string &	name,
		const Uint	nb_vars
	)

Definition at line 407 of file VariablesDescriptor.cpp.

void set_variables ( const std::string & description )

Setup variables acording to a Field string description.

Definition at line 514 of file VariablesDescriptor.cpp.

void set_variables	(	const std::string &	description,
		const Uint	dimension
	)

Setup variables together with their dimension.

Definition at line 520 of file VariablesDescriptor.cpp.

Uint size ( ) const

Total size of the array of scalars to hold each variable, i.e. the required row size for the Field data table.

Exceptions

SetupError if dimensions is not set

Definition at line 421 of file VariablesDescriptor.cpp.

Uint size ( const std::string & name ) const

Size of a variable

Parameters

name	Internal name of the variable

Returns: the actual size of the variable

Exceptions

SetupError if dimensions is not set

Definition at line 428 of file VariablesDescriptor.cpp.

static std::string type_name ( )

inlinestatic

Get the class name.

Definition at line 42 of file VariablesDescriptor.hpp.

const std::string & user_variable_name ( const std::string & name ) const

Return the user-defined name of a variable

Parameters

name	Internal name of the variable

Definition at line 486 of file VariablesDescriptor.cpp.

const std::string & user_variable_name ( const Uint var_nb ) const

Return the user-defined name of a variable

Parameters

name	Internal name of the variable

Definition at line 493 of file VariablesDescriptor.cpp.

Uint var_length ( const std::string & name ) const

Get the variable size for a given variable name.

Exceptions

ValueNotFound if the variable is not found

Parameters

name	Internal name of the variable

Returns: variable length

Definition at line 471 of file VariablesDescriptor.cpp.

Uint var_length ( const Uint var_nb ) const

Get the variable size for a given variable name.

Exceptions

ValueNotFound if the variable is not found

Parameters

name	Internal name of the variable

Returns: variable length

Definition at line 479 of file VariablesDescriptor.cpp.

Uint var_number ( const std::string & name ) const

Find the variable number for a given variable name.

Exceptions

ValueNotFound if the variable is not found

Parameters

name	Internal name of the variable

Returns: variable number

Definition at line 464 of file VariablesDescriptor.cpp.

Member Data Documentation

boost::scoped_ptr<Implementation> m_implementation

private

Definition at line 149 of file VariablesDescriptor.hpp.

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

cf3/math/VariablesDescriptor.hpp
cf3/math/VariablesDescriptor.cpp

Classes

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation