A generic variable. Almost useless, use the overloaded classes instead of this one. More...

#include <Variable.h>

Inheritance diagram for Aqua::InputOutput::Variable:

[legend]

Public Member Functions
	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 Member Functions
void	sync ()
	Wait for variable underlying event to be complete.

Detailed Description

A generic variable. Almost useless, use the overloaded classes instead of this one.

Constructor & Destructor Documentation

◆ Variable()

Aqua::InputOutput::Variable::Variable	(	const std::string	varname,
		const std::string	vartype
	)

Constructor.

Parameters

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

Here is the call graph for this function:

◆ ~Variable()

virtual Aqua::InputOutput::Variable::~Variable ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ asString()

virtual const std::string Aqua::InputOutput::Variable::asString ( )

inlinevirtual

Get the variable text representation.

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

◆ get()

virtual void * Aqua::InputOutput::Variable::get ( )

inlinevirtual

Get variable pointer basis pointer.

Returns: Implementation pointer, NULL for this class.

◆ getEvent()

cl_event Aqua::InputOutput::Variable::getEvent ( )

inline

Returns the last event associated to this variable.

Returns: OpenCL event

◆ getPythonObject()

virtual PyObject * Aqua::InputOutput::Variable::getPythonObject	(	int	i0 = `0`,
		int	n = `0`
	)

inlinevirtual

Get a Python interpretation of the variable.

Parameters

i0	First component to be read, just for array variables.
n	Number of component to be read, just for array variables.

Returns: Python object, NULL for this class.

Reimplemented in Aqua::InputOutput::IntVariable, Aqua::InputOutput::UIntVariable, Aqua::InputOutput::FloatVariable, Aqua::InputOutput::Vec2Variable, Aqua::InputOutput::Vec3Variable, Aqua::InputOutput::Vec4Variable, Aqua::InputOutput::IVec2Variable, Aqua::InputOutput::IVec3Variable, Aqua::InputOutput::IVec4Variable, Aqua::InputOutput::UIVec2Variable, Aqua::InputOutput::UIVec3Variable, Aqua::InputOutput::UIVec4Variable, and Aqua::InputOutput::ArrayVariable.

◆ isArray()

virtual bool Aqua::InputOutput::Variable::isArray ( )

pure virtual

Let efficiently know whether the variable is an array or not.

Returns: true if the variable is an array, false if the variable is a scalar

◆ isScalar()

virtual bool Aqua::InputOutput::Variable::isScalar ( )

inlinevirtual

Let efficiently know whether the variable is a scalar or not.

Returns: true if the variable is a scalar, false if the variable is an array

Here is the call graph for this function:

◆ name()

std::string Aqua::InputOutput::Variable::name ( ) const

inline

Name of the variable.

Returns: The name of the variable

◆ set()

virtual void Aqua::InputOutput::Variable::set ( void * ptr )

pure virtual

Set variable from memory.

Parameters

ptr	Memory to copy.

◆ setEvent()

void Aqua::InputOutput::Variable::setEvent ( cl_event event )

Set the variable current event.

clRetainEvent() is called on top of the provided event, while any previous event is conveniently released calling clReleaseEvent()

Might exists other events linked to this variable, but since those are considered predecessors, we can just forgive about them.

Remarks: Events are used even for non-OpenCL variables

Parameters

event OpenCL event

Here is the call graph for this function:

◆ setFromPythonObject()

virtual bool Aqua::InputOutput::Variable::setFromPythonObject	(	PyObject *	obj,
		int	i0 = `0`,
		int	n = `0`
	)

inlinevirtual

Set the variable from a Python object.

Parameters

obj	Python object.
i0	First component to be set, just for array variables.
n	Number of component to be set, just for array variables.

Returns: true, i.e. an error.

Reimplemented in Aqua::InputOutput::IntVariable, Aqua::InputOutput::UIntVariable, Aqua::InputOutput::FloatVariable, Aqua::InputOutput::Vec2Variable, Aqua::InputOutput::Vec3Variable, Aqua::InputOutput::Vec4Variable, Aqua::InputOutput::IVec2Variable, Aqua::InputOutput::IVec3Variable, Aqua::InputOutput::IVec4Variable, Aqua::InputOutput::UIVec2Variable, Aqua::InputOutput::UIVec3Variable, Aqua::InputOutput::UIVec4Variable, and Aqua::InputOutput::ArrayVariable.

◆ size()

virtual size_t Aqua::InputOutput::Variable::size ( ) const

inlinevirtual

Get the variable type size.

Returns: Variable type size (in bytes)

Reimplemented in Aqua::InputOutput::ArrayVariable.

Here is the call graph for this function:

◆ sync()

void Aqua::InputOutput::Variable::sync ( )

protected

Wait for variable underlying event to be complete.

This function is tracking the syncing state, avoiding calling clWaitForEvents() more than once, while the event is not updated.

This is obviously a blocking function

Here is the call graph for this function:

◆ type()

virtual std::string Aqua::InputOutput::Variable::type ( ) const

inlinevirtual

Type of the variable.

Returns: The type of the variable

◆ typesize()

virtual size_t Aqua::InputOutput::Variable::typesize ( ) const

inlinevirtual

Get the variable type size.

Returns: Variable type size (in bytes)

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Variable()

◆ ~Variable()

Member Function Documentation

◆ asString()

◆ get()

◆ getEvent()

◆ getPythonObject()

◆ isArray()

◆ isScalar()

◆ name()

◆ set()

◆ setEvent()

◆ setFromPythonObject()

◆ size()

◆ sync()

◆ type()

◆ typesize()