Wrapper class for raw ptr arrays allocated by new[]/malloc/calloc. More...

#include <CommWrapper.hpp>

Public Member Functions
	~CommWrapperPtr ()
	destructor More...

	CommWrapperPtr (const std::string &name)

void	setup (T *&data, const int size, const unsigned int stride, const bool needs_update)

void	setup (T **data, const int size, const unsigned int stride, const bool needs_update)

const void *	pack (std::vector< int > &map, void *buf=nullptr) const

const void *	pack (void *buf=nullptr) const

void	unpack (void *buf, std::vector< int > &map) const

void	unpack (void *buf) const

void	resize (const int size)

int	size_of () const

int	size () const

int	stride () const

bool	is_data_type_Uint () const

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

template<typename T >
void	pack (std::vector< T > &buf, std::vector< int > &map) const

template<typename T >
void	pack (std::vector< T > &buf) const

template<typename T >
void	unpack (std::vector< T > &buf, std::vector< int > &map) const

template<typename T >
void	unpack (std::vector< T > &buf) const

bool	needs_update () const

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 CommWrapper
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
void *	start_view ()

void	end_view (void *data)

Private Attributes
T **	m_data
	holder of the pointer More...

int	m_size
	holder of the element size 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...

Protected Attributes inherited from CommWrapper
int	m_stride
	number of elements to be groupped together and treat as once in communication pattern More...

bool	m_needs_update
	bool holding the info if data to be synchronized & kept up-to-date with commpattern or only keep up-to-date More...

Detailed Description

template<typename T>
class cf3::common::PE::CommWrapperPtr< T >

Wrapper class for raw ptr arrays allocated by new[]/malloc/calloc.

Definition at line 225 of file CommWrapper.hpp.

Constructor & Destructor Documentation

~CommWrapperPtr ( )

inline

destructor

Definition at line 229 of file CommWrapper.hpp.

CommWrapperPtr ( const std::string & name )

inline

constructor

Parameters

name	the component will appear under this name

Definition at line 233 of file CommWrapper.hpp.

Member Function Documentation

void end_view ( void * data )

inlineprivatevirtual

Finalizes view to the raw data held by the class wrapped by the commwrapper.

Warning: if the underlying data is not linear the data is copied back, therefore performance is degraded

Parameters

data	pointer to the data

Implements CommWrapper.

Definition at line 361 of file CommWrapper.hpp.

bool is_data_type_Uint ( ) const

inlinevirtual

Check for Uint, necessary for cheking type of gid in commpattern

Returns: true or false depending if registered data's type was Uint or not

Implements CommWrapper.

Definition at line 349 of file CommWrapper.hpp.

const void* pack	(	std::vector< int > &	map,
		void *	buf = `nullptr`
	)		const

inlinevirtual

extraction of sub-data from data wrapped by the objectwrapper, pattern specified by map if nullptr is passed (also default parameter), memory is allocated.

Parameters

map	vector of map

Returns: pointer to the newly allocated data which is of size size_of()*stride()*map.size()

Implements CommWrapper.

Definition at line 270 of file CommWrapper.hpp.

const void* pack ( void * buf = nullptr ) const

inlinevirtual

extraction of data from the wrapped object, returned memory is a copy, not a view if nullptr is passed (also default parameter), memory is allocated.

Returns: pointer to the newly allocated data which is of size size_of()*stride()*size()

Implements CommWrapper.

Definition at line 286 of file CommWrapper.hpp.

void resize ( const int size )

inlinevirtual

resizes the underlying wrapped object NOT SUPPORTED, because it would require messing with the pointers internally. If you are forced to use plain dynamic arrays (interface to an old code), Not even considering that CommWrapperPtr cannot know if new, new[] or malloc, calloc, realloc was used to allocate it. you need to take care of your own data in order not to loose the pointers outside CommWrapperPtr. However, if you catch the throw, the integer storing the size gets set to the new value before throw.

Parameters

size	new dimension size

Implements CommWrapper.

Definition at line 329 of file CommWrapper.hpp.

void setup	(	T *&	data,
		const int	size,
		const unsigned int	stride,
		const bool	needs_update
	)

inline

setup of passing by reference

Parameters

data	pointer to data
size	length of the data
stride	number of array element grouping

Definition at line 242 of file CommWrapper.hpp.

void setup	(	T **	data,
		const int	size,
		const unsigned int	stride,
		const bool	needs_update
	)

inline

setup of passing by pointer

Parameters

data	pointer to data
size	length of the data
stride	number of array element grouping

Definition at line 256 of file CommWrapper.hpp.

int size ( ) const

inlinevirtual

accessor to the size of the array (without divided by stride)

Returns: length of the array

Implements CommWrapper.

Definition at line 341 of file CommWrapper.hpp.

int size_of ( ) const

inlinevirtual

acts like a sizeof() operator

Returns: size of the data members in bytes

Implements CommWrapper.

Definition at line 337 of file CommWrapper.hpp.

void* start_view ( )

inlineprivatevirtual

Create an access to the raw data inside the wrapped class.

Warning: if underlying raw data is not linear, a copy is being made.

Returns: pointer to data

Implements CommWrapper.

Definition at line 356 of file CommWrapper.hpp.

int stride ( ) const

inlinevirtual

accessor to the stride which tells how many array elements count as one in the communication pattern

Returns: number of items to be treated as one

Implements CommWrapper.

Definition at line 345 of file CommWrapper.hpp.

static std::string type_name ( )

inlinestatic

Get the class name.

Definition at line 236 of file CommWrapper.hpp.

void unpack	(	void *	buf,
		std::vector< int > &	map
	)		const

inlinevirtual

returning back values into the data wrapped by objectwrapper

Parameters

map	vector of map
pointer	to the data to be committed back

Implements CommWrapper.

Definition at line 301 of file CommWrapper.hpp.

void unpack ( void * buf ) const

inlinevirtual

returning back values into the data wrapped by objectwrapper

Parameters

pointer to the data to be committed back

Implements CommWrapper.

Definition at line 313 of file CommWrapper.hpp.

Member Data Documentation

T** m_data

private

holder of the pointer

Definition at line 366 of file CommWrapper.hpp.

int m_size

private

holder of the element size

Definition at line 369 of file CommWrapper.hpp.

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

cf3/common/PE/CommWrapper.hpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<typename T> class cf3::common::PE::CommWrapperPtr< T >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename T>
class cf3::common::PE::CommWrapperPtr< T >