Aqua::CalcServer::Conditional Class Reference

Base class for conditional tools like While or If. More...

#include <CalcServer/Conditional.h>

Inheritance diagram for Aqua::CalcServer::Conditional:

Collaboration diagram for Aqua::CalcServer::Conditional:

Public Member Functions
	Conditional (const std::string name, const std::string condition, bool once=false)
	Constructor.
	~Conditional ()
	Destructor.
void	setup ()
	Initialize the tool.
virtual Tool *	next_tool ()
const int	scope_modifier ()
Public Member Functions inherited from Aqua::CalcServer::Tool
	Tool (const std::string tool_name, bool once=false)
virtual	~Tool ()
void	name (const std::string tool_name)
const std::string	name ()
virtual void	setup ()
virtual void	execute ()
	Execute the tool measuring the elapsed time.
virtual Tool *	next_tool ()
size_t	allocatedMemory () const
unsigned int	used_times () const
float	elapsedTime (bool averaged=true) const
float	elapsedTimeVariance () const
float	elapsedTimeDeviation () const
virtual const int	scope_modifier ()

Protected Member Functions
cl_event	_execute (const std::vector< cl_event > events)
Protected Member Functions inherited from Aqua::CalcServer::Tool
int	id_in_pipeline ()
void	next_tool (Tool *tool)
void	allocatedMemory (size_t mem_size)
virtual cl_event	_execute (const std::vector< cl_event > events)
void	addElapsedTime (float elapsed_time)
	Add new data to the average and squared elapsed times.
void	setDependencies (std::vector< std::string > var_names)
	Set the depedencies of the tool.
void	setDependencies (std::vector< InputOutput::Variable * > vars)
	Set the depedencies of the tool.
const std::vector< InputOutput::Variable * >	getDependencies ()
	Get the depedencies of the tool.

Protected Attributes
bool	_result
	Condition result.

Additional Inherited Members
Static Protected Member Functions inherited from Aqua::CalcServer::Tool
static std::vector< cl_kernel >	compile (const std::string source, const std::vector< std::string > names, const std::string flags="")
	Compile an OpenCL source code and generate the corresponding kernel.
static cl_kernel	compile_kernel (const std::string source, const std::string kernel_name, const std::string flags="")
	Compile an OpenCL source code and generate the corresponding kernel.

Detailed Description

Base class for conditional tools like While or If.

If the result of evaluating the condition expression is equal to 0, the result will be considered false, and therefore all the tools until the next End tool will be disabled

Constructor & Destructor Documentation

Conditional()

Aqua::CalcServer::Conditional::Conditional	(	const std::string	name,
		const std::string	condition,
		bool	once = false
	)

Constructor.

Parameters

name	Tool name.
condition	Condition to evaluate. If the result is 0, false will be considered and all the subsequent tools will be disabled until an End tool is reached.
once	Run this tool just once. Useful to make initializations.

~Conditional()

Aqua::CalcServer::Conditional::~Conditional

(

)

Destructor.

Member Function Documentation

_execute()

cl_event Aqua::CalcServer::Conditional::_execute ( const std::vector< cl_event >  events )

protectedvirtual

Execute the tool

Parameters

events

List of events that shall be waited before safe execution

Returns

OpenCL event to be waited before accessing the dependencies

Reimplemented from Aqua::CalcServer::Tool.

Reimplemented in Aqua::CalcServer::If.

Here is the call graph for this function:

next_tool()

Tool * Aqua::CalcServer::Conditional::next_tool ( )

virtual

Get the next tool to be executed in the pipeline.

Depending on the condition value, that tool is the next one or the tool after the End tool which closes the scope

Returns

Next tool to be executed. NULL if no more tools shall be executed in the pipeline

Reimplemented from Aqua::CalcServer::Tool.

Reimplemented in Aqua::CalcServer::If.

Here is the call graph for this function:

scope_modifier()

const int Aqua::CalcServer::Conditional::scope_modifier ( )

inlinevirtual

Open a new scope

Returns

1

Note

The scope shall be close at some point by an EndIf tool

Reimplemented from Aqua::CalcServer::Tool.

setup()

void Aqua::CalcServer::Conditional::setup ( )

virtual

Initialize the tool.

Reimplemented from Aqua::CalcServer::Tool.

Reimplemented in Aqua::CalcServer::While, and Aqua::CalcServer::If.

Here is the call graph for this function:

Field Documentation

_result

bool Aqua::CalcServer::Conditional::_result

protected

Condition result.

---

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

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