Aqua::InputOutput::ScalarVariable< T > Class Template Reference

A generic Scalar variable. More...

#include <Variable.h>

Inheritance diagram for Aqua::InputOutput::ScalarVariable< T >:

Collaboration diagram for Aqua::InputOutput::ScalarVariable< T >:

Public Member Functions
	ScalarVariable (const std::string varname, const std::string vartype)
	Constructor.
	~ScalarVariable ()
	Destructor.
bool	isArray ()
	Report that the varaible is not an array.
size_t	typesize () const
	Get the variable type size.
void *	get ()
	Get variable pointer basis pointer.
void *	get_async ()
	Get variable pointer basis pointer.
void	set (void *ptr)
	Set variable from memory.
void	set_async (void *ptr)
	Set variable from memory.
virtual const std::string	asString ()=0
	Get the variable text representation.
Public Member Functions inherited from Aqua::InputOutput::Variable
	Variable (const std::string varname, const std::string vartype)
	Constructor.
virtual	~Variable ()
	Destructor.
virtual bool	isArray ()=0
	Let efficiently know whether the variable is an array or not.
virtual bool	isScalar ()
	Let efficiently know whether the variable is a scalar or not.
std::string	name () const
	Name of the variable.
virtual std::string	type () const
	Type of the variable.
virtual size_t	typesize () const
	Get the variable type size.
virtual size_t	size () const
	Get the variable type size.
virtual void *	get ()
	Get variable pointer basis pointer.
virtual void	set (void *ptr)=0
	Set variable from memory.
virtual PyObject *	getPythonObject (int i0=0, int n=0)
	Get a Python interpretation of the variable.
virtual bool	setFromPythonObject (PyObject *obj, int i0=0, int n=0)
	Set the variable from a Python object.
virtual const std::string	asString ()
	Get the variable text representation.
void	setEvent (cl_event event)
	Set the variable current event.
cl_event	getEvent ()
	Returns the last event associated to this variable.

Protected Attributes
T	_value
	Variable value.

Additional Inherited Members
Protected Member Functions inherited from Aqua::InputOutput::Variable
void	sync ()
	Wait for variable underlying event to be complete.

Detailed Description

template<class T>
class Aqua::InputOutput::ScalarVariable< T >

A generic Scalar variable.

Constructor & Destructor Documentation

ScalarVariable()

template<class T >

Aqua::InputOutput::ScalarVariable< T >::ScalarVariable	(	const std::string	varname,
		const std::string	vartype
	)

Constructor.

Parameters

varname	Name of the variable.
vartype	Type of the variable.

~ScalarVariable()

template<class T >

Aqua::InputOutput::ScalarVariable< T >::~ScalarVariable ( )

inline

Destructor.

Member Function Documentation

asString()

template<class T >

virtual const std::string Aqua::InputOutput::ScalarVariable< T >::asString ( )

pure virtual

Get the variable text representation.

Returns

The variable represented as a string, NULL in case of errors.

Reimplemented from Aqua::InputOutput::Variable.

Implemented in Aqua::InputOutput::ScalarNumberVariable< T >, Aqua::InputOutput::ScalarNumberVariable< float >, Aqua::InputOutput::ScalarNumberVariable< int >, Aqua::InputOutput::ScalarNumberVariable< unsigned int >, Aqua::InputOutput::ScalarVecVariable< T >, Aqua::InputOutput::ScalarVecVariable< ivec2 >, Aqua::InputOutput::ScalarVecVariable< ivec3 >, Aqua::InputOutput::ScalarVecVariable< ivec4 >, Aqua::InputOutput::ScalarVecVariable< uivec2 >, Aqua::InputOutput::ScalarVecVariable< uivec3 >, Aqua::InputOutput::ScalarVecVariable< uivec4 >, Aqua::InputOutput::ScalarVecVariable< vec2 >, Aqua::InputOutput::ScalarVecVariable< vec3 >, and Aqua::InputOutput::ScalarVecVariable< vec4 >.

get()

template<class T >

void * Aqua::InputOutput::ScalarVariable< T >::get ( )

inlinevirtual

Get variable pointer basis pointer.

This is a blocking operation, that will retain the program until the underlying variable event is complete. For asynchronous variable retrieval see get_async()

Returns

Implementation pointer

Reimplemented from Aqua::InputOutput::Variable.

Here is the call graph for this function:

get_async()

template<class T >

void * Aqua::InputOutput::ScalarVariable< T >::get_async ( )

inline

Get variable pointer basis pointer.

Sometimes a tool would make events micromanagement, becoming useful to can retrieve the value in an asynchronous way. That is for instance the case of events manipulated in callbacks

Returns

Implementation pointer

isArray()

template<class T >

bool Aqua::InputOutput::ScalarVariable< T >::isArray

inlinevirtual

Report that the varaible is not an array.

Returns

false

Implements Aqua::InputOutput::Variable.

set()

template<class T >

void Aqua::InputOutput::ScalarVariable< T >::set ( void *  ptr )

inlinevirtual

Set variable from memory.

This is a blocking operation, that will retain the program until the underlying variable event is complete.

Parameters

ptr	Memory to copy

Implements Aqua::InputOutput::Variable.

Here is the call graph for this function:

set_async()

template<class T >

void Aqua::InputOutput::ScalarVariable< T >::set_async ( void *  ptr )

inline

Set variable from memory.

Sometimes a tool would make events micromanagement, becoming useful to can retrieve the value in an asynchronous way. That is for instance the case of events manipulated in callbacks

Parameters

ptr	Memory to copy

typesize()

template<class T >

size_t Aqua::InputOutput::ScalarVariable< T >::typesize ( ) const

inlinevirtual

Get the variable type size.

Returns

Variable type size (in bytes)

Reimplemented from Aqua::InputOutput::Variable.

Field Documentation

_value

template<class T >

T Aqua::InputOutput::ScalarVariable< T >::_value

protected

Variable value.

---

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

• /home/pepe/SPH/Code/aquagpusph/include/Variable.h
• /home/pepe/SPH/Code/aquagpusph/src/Variable.cpp