Aqua::InputOutput Namespace Reference

Input/Output data interfaces. More...

Namespaces
namespace	CommandLineArgs

Data Structures
class	ArrayVariable
	An array variable. More...
class	ASCII
	Plain text particles data files loader/saver. More...
class	CSV
	CSV particles data files loader/saver. More...
class	DoubleVariable
	A double variable. More...
class	FastASCII
	Plain text particles data files loader/saver. More...
class	FileManager
	Input/Output files manager. This class acts as a base class, controlling the subclasses which will load/save the files. More...
class	FloatVariable
	A float variable. More...
class	InputOutput
	Base class for input/output file managers. More...
class	IntVariable
	An integer variable. More...
class	Logger
	On screen and log file output manager. More...
class	LongVariable
	A 64bits integer variable. More...
class	Particles
	Particles file loader/saver base class. More...
class	ProblemSetup
	Simulation configuration data. More...
class	Report
	Base class for all the report file managers. More...
class	ScalarNumberVariable
class	ScalarVariable
	A generic Scalar variable. More...
class	ScalarVecVariable
	A generic Scalar variable, of 2 or more components. More...
class	State
	Load/Save the XML simulation definition files. More...
class	TimeManager
	Simulation time flow manager. More...
class	UIntVariable
	An unsigned integer variable. More...
class	ULongVariable
	An integer variable. More...
class	Variable
	A generic variable. Almost useless, use the overloaded classes instead of this one. More...
class	Variables
	Variables manager, which can interpret the types on the fly. More...
class	VTK
	VTK particles data files loader/saver. More...

Typedefs
Variable aliases
Some alias to make easier to create preprocessor directives
typedef IntVariable	iclVariable
typedef LongVariable	lclVariable
typedef UIntVariable	uiclVariable
typedef ULongVariable	ulclVariable
typedef FloatVariable	fclVariable
typedef DoubleVariable	dclVariable
typedef IVec2Variable	ivec2Variable
typedef IVec3Variable	ivec3Variable
typedef IVec4Variable	ivec4Variable
typedef IVec8Variable	ivec8Variable
typedef LVec2Variable	lvec2Variable
typedef LVec3Variable	lvec3Variable
typedef LVec4Variable	lvec4Variable
typedef LVec8Variable	lvec8Variable
typedef UIVec2Variable	uivec2Variable
typedef UIVec3Variable	uivec3Variable
typedef UIVec4Variable	uivec4Variable
typedef UIVec8Variable	uivec8Variable
typedef ULVec2Variable	ulvec2Variable
typedef ULVec3Variable	ulvec3Variable
typedef ULVec4Variable	ulvec4Variable
typedef ULVec8Variable	ulvec8Variable
typedef Vec2Variable	vec2Variable
typedef Vec3Variable	vec3Variable
typedef Vec4Variable	vec4Variable
typedef Vec8Variable	vec8Variable
typedef DVec2Variable	dvec2Variable
typedef DVec3Variable	dvec3Variable
typedef DVec4Variable	dvec4Variable
typedef DVec8Variable	dvec8Variable

Functions
std::atomic< Logger * >	g_logger_singleton_ptr (nullptr)
	Singleton instance of Aqua::InputOutput::Logger.
std::string	time_and_date ()
	Get a string with the date and time.
void CL_CALLBACK	particles_cb (cl_event event, cl_int event_command_status, void *user_data)
	Callback called when all the fields have been downloaded.
static std::vector< unsigned int >	_toolsList (std::string list, ProblemSetup &sim_data, std::string prefix)
	Helper function to get a list of tool placements from a list of names.
static std::vector< unsigned int >	_toolsName (std::string name, ProblemSetup &sim_data, std::string prefix)
	Helper function to get a list of tool placements from a wildcard.
static void	_toolAttr (ProblemSetup::sphTool *tool, DOMElement *elem, std::string attr, std::string def_val)
	Helper function to get and XML attribute for a tool.
static void	_toolAttr (ProblemSetup::sphTool *tool, DOMElement *elem, std::string attr)
	Helper function to get and XML attribute for a tool.
std::string	npy_type_name (int np_type)
template<typename T>
const std::string	valptr_as_string (T *ptr, unsigned int n)
	Stringify a value pointer.
std::string	tokNameToVarName (const std::string &name)
	Convert the names populated at the tokenizer to variable names.

Variables
static std::string	_remaining
static std::vector< unsigned int >	_tool_places
	Helper storage for the functions _toolsList() and _toolsName()
static std::ostringstream	pyerr

Detailed Description

Input/Output data interfaces.

Typedef Documentation

dclVariable

typedef DoubleVariable Aqua::InputOutput::dclVariable

dvec2Variable

typedef DVec2Variable Aqua::InputOutput::dvec2Variable

dvec3Variable

typedef DVec3Variable Aqua::InputOutput::dvec3Variable

dvec4Variable

typedef DVec4Variable Aqua::InputOutput::dvec4Variable

dvec8Variable

typedef DVec8Variable Aqua::InputOutput::dvec8Variable

fclVariable

typedef FloatVariable Aqua::InputOutput::fclVariable

iclVariable

typedef IntVariable Aqua::InputOutput::iclVariable

ivec2Variable

typedef IVec2Variable Aqua::InputOutput::ivec2Variable

ivec3Variable

typedef IVec3Variable Aqua::InputOutput::ivec3Variable

ivec4Variable

typedef IVec4Variable Aqua::InputOutput::ivec4Variable

ivec8Variable

typedef IVec8Variable Aqua::InputOutput::ivec8Variable

lclVariable

typedef LongVariable Aqua::InputOutput::lclVariable

lvec2Variable

typedef LVec2Variable Aqua::InputOutput::lvec2Variable

lvec3Variable

typedef LVec3Variable Aqua::InputOutput::lvec3Variable

lvec4Variable

typedef LVec4Variable Aqua::InputOutput::lvec4Variable

lvec8Variable

typedef LVec8Variable Aqua::InputOutput::lvec8Variable

uiclVariable

typedef UIntVariable Aqua::InputOutput::uiclVariable

uivec2Variable

typedef UIVec2Variable Aqua::InputOutput::uivec2Variable

uivec3Variable

typedef UIVec3Variable Aqua::InputOutput::uivec3Variable

uivec4Variable

typedef UIVec4Variable Aqua::InputOutput::uivec4Variable

uivec8Variable

typedef UIVec8Variable Aqua::InputOutput::uivec8Variable

ulclVariable

typedef ULongVariable Aqua::InputOutput::ulclVariable

ulvec2Variable

typedef ULVec2Variable Aqua::InputOutput::ulvec2Variable

ulvec3Variable

typedef ULVec3Variable Aqua::InputOutput::ulvec3Variable

ulvec4Variable

typedef ULVec4Variable Aqua::InputOutput::ulvec4Variable

ulvec8Variable

typedef ULVec8Variable Aqua::InputOutput::ulvec8Variable

vec2Variable

typedef Vec2Variable Aqua::InputOutput::vec2Variable

vec3Variable

typedef Vec3Variable Aqua::InputOutput::vec3Variable

vec4Variable

typedef Vec4Variable Aqua::InputOutput::vec4Variable

vec8Variable

typedef Vec8Variable Aqua::InputOutput::vec8Variable

Function Documentation

_toolAttr() [1/2]

void Aqua::InputOutput::_toolAttr ( ProblemSetup::sphTool * tool, DOMElement * elem, std::string attr )

static

Helper function to get and XML attribute for a tool.

This function will throw an exception if the attribute is missing

Parameters

tool	The tool to edit
elem	The XML element
attr	The XML element attribute

Exceptions

std::runtime_error

If attr is not an attribute of the elem XML element

Here is the call graph for this function:

_toolAttr() [2/2]

void Aqua::InputOutput::_toolAttr ( ProblemSetup::sphTool * tool, DOMElement * elem, std::string attr, std::string def_val )

static

Helper function to get and XML attribute for a tool.

This function will set the default value if the attribute is not found

Parameters

tool	The tool to edit
elem	The XML element
attr	The XML element attribute
def_val	The default string to be set if it cannot be found

Here is the call graph for this function:

_toolsList()

std::vector< unsigned int > Aqua::InputOutput::_toolsList ( std::string list, ProblemSetup & sim_data, std::string prefix )

static

Helper function to get a list of tool placements from a list of names.

Parameters

list	List of tools, separated by commas
prefix	prefix to become inserted at the beggining of the name of each tool of the list

Returns

The positions of the tools

Warning

This methos is not thread safe

_toolsName()

std::vector< unsigned int > Aqua::InputOutput::_toolsName ( std::string name, ProblemSetup & sim_data, std::string prefix )

static

Helper function to get a list of tool placements from a wildcard.

Parameters

name	Wildcard formatted tool name
prefix	prefix to become inserted at the beggining of the name of each tool of the list

Returns

The positions of the tools

Warning

This methos is not thread safe

Here is the call graph for this function:

g_logger_singleton_ptr()

std::atomic< Logger * > Aqua::InputOutput::g_logger_singleton_ptr

(

nullptr

)

Singleton instance of Aqua::InputOutput::Logger.

npy_type_name()

std::string Aqua::InputOutput::npy_type_name

(

int

np_type

)

particles_cb()

void CL_CALLBACK Aqua::InputOutput::particles_cb	(	cl_event	event,
		cl_int	event_command_status,
		void *	user_data )

Callback called when all the fields have been downloaded.

This function is just redirecting the work to Aqua::InputOutput::Particles::print_file()

Parameters

event	The triggering event
event_command_status	CL_COMPLETE upon all dependencies successfully fulfilled. A negative integer if one or more dependencies failed.
user_data	A casted pointer to the Aqua::InputOutput::Particles tool (or the inherited one)

time_and_date()

std::string Aqua::InputOutput::time_and_date

(

)

Get a string with the date and time.

Returns

The date and time string

See also

https://stackoverflow.com/questions/17223096/outputting-date-and-time-in-c-using-stdchrono

Here is the call graph for this function:

tokNameToVarName()

std::string Aqua::InputOutput::tokNameToVarName

(

const std::string &

name

)

Convert the names populated at the tokenizer to variable names.

Parameters

name	The name populated on the tokenizer

Returns

The variable name

Here is the call graph for this function:

valptr_as_string()

template<typename T>

const std::string Aqua::InputOutput::valptr_as_string	(	T *	ptr,
		unsigned int	n )

Stringify a value pointer.

Parameters

ptr	Pointer to the value
n	Number of fields into the data

Variable Documentation

_remaining

std::string Aqua::InputOutput::_remaining

static

_tool_places

std::vector<unsigned int> Aqua::InputOutput::_tool_places

static

Helper storage for the functions _toolsList() and _toolsName()

pyerr

std::ostringstream Aqua::InputOutput::pyerr

static