Aqua::InputOutput::ULongVariable Class Reference

An integer variable. More...

#include <Variable.hpp>

Inheritance diagram for Aqua::InputOutput::ULongVariable:

Collaboration diagram for Aqua::InputOutput::ULongVariable:

Public Member Functions
	ULongVariable (const std::string varname)
	Constructor.
	~ULongVariable ()
	Destructor.
PyObject *	getPythonObject (int i0=0, int n=0)
	Get a PyLongObject interpretation of the variable.
bool	setFromPythonObject (PyObject *obj, int i0=0, int n=0)
	Set the variable from a Python object.
Public Member Functions inherited from Aqua::InputOutput::ScalarNumberVariable< ulcl >
	ScalarNumberVariable (const std::string varname, const std::string vartype)
	Constructor.
	~ScalarNumberVariable ()
	Destructor.
virtual const std::string	asString (bool synced=true)
	Get the variable text representation.
Public Member Functions inherited from Aqua::InputOutput::ScalarVariable< ulcl >
	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 (bool synced=true)
	Get variable pointer basis pointer.
void	set (void *ptr, bool synced=true)
	Set variable from memory.
ulcl	value (bool synced=true)
	Get the variable value.
Public Member Functions inherited from Aqua::InputOutput::Variable
	Variable (const std::string varname, const std::string vartype)
	Constructor.
virtual	~Variable ()
	Destructor.
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	size () const
	Get the variable type size.
virtual void *	get (bool UNUSED_PARAM synced=true)
	Get variable pointer basis pointer.
void *	get_async ()
	Get variable pointer basis pointer.
void	set_async (void *ptr)
	Set variable from memory.
virtual PyObject *	getPythonObject (int UNUSED_PARAM i0=0, int UNUSED_PARAM n=0)
	Get a Python interpretation of the variable.
virtual bool	setFromPythonObject (PyObject UNUSED_PARAM *obj, int UNUSED_PARAM i0=0, int UNUSED_PARAM n=0)
	Set the variable from a Python object.
virtual const std::string	asString (bool UNUSED_PARAM synced=true)
	Get the variable text representation.
void	setEvent (cl_event event)
	Set the variable current writing event.
void	setWritingEvent (cl_event event)
	Alias of InputOutput::Variable::setEvent()
cl_event	getEvent () const
	Returns the last writing event associated to this variable.
cl_event	getWritingEvent () const
	Alias of InputOutput::Variable::getEvent()
void	addReadingEvent (cl_event event)
	Add a new reading event to the variable.
std::vector< cl_event >	getReadingEvents () const
	Get the list of reading events.
void	sync (bool readonly=false)
	Wait for variable reading and writing events to be completed.

Additional Inherited Members
Protected Member Functions inherited from Aqua::InputOutput::Variable
void	cleanReadingEvents ()
	Clean up the list of reading events.
Static Protected Member Functions inherited from Aqua::InputOutput::Variable
static cl_event	createDummyEvent ()
	Create a competed user event to be set as the writing event when synced writing operations are carried out.
Protected Attributes inherited from Aqua::InputOutput::ScalarVariable< ulcl >
ulcl	_value
	Variable value.

Detailed Description

An integer variable.

Constructor & Destructor Documentation

ULongVariable()

Aqua::InputOutput::ULongVariable::ULongVariable

(

const std::string

varname

)

Constructor.

Parameters

varname

Name of the variable.

Here is the call graph for this function:

~ULongVariable()

Aqua::InputOutput::ULongVariable::~ULongVariable ( )

inline

Destructor.

Member Function Documentation

getPythonObject()

PyObject * Aqua::InputOutput::ULongVariable::getPythonObject ( int i0 = 0, int n = 0 )

virtual

Get a PyLongObject interpretation of the variable.

Parameters

i0	ignored parameter.
n	ignored parameter

Returns

PyLongObject Python object.

Implements Aqua::InputOutput::ScalarVariable< ulcl >.

Here is the call graph for this function:

setFromPythonObject()

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

virtual

Set the variable from a Python object.

Parameters

obj	PyLongObject object.
i0	ignored parameter.
n	ignored parameter

Returns

false if all gone right, true otherwise.

Implements Aqua::InputOutput::ScalarVariable< ulcl >.

Here is the call graph for this function:

---

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

• /home/pepe/SPH/Code/aquagpusph/aquagpusph/Variable.hpp
• /home/pepe/SPH/Code/aquagpusph/aquagpusph/Variable.cpp