iguana::bindings Namespace Reference

Detailed Description

General iguana bindings.

Namespaces
namespace	clas12
	CLAS12 algorithm action function bindings.
namespace	physics
	Physics algorithm action function bindings.

Classes
struct	algo_owner_t
	Algorithm instance owner type More...

Typedefs
typedef int	algo_idx_t
	Algorithm instance index type

Functions
void	iguana_print_log_ (char const *format,...)
void	iguana_print_error_ (char const *format,...)
Algorithm *	iguana_get_algo_ (algo_idx_t *algo_idx, bool verbose=false)
void	iguana_create_ ()
void	iguana_set_config_file_ (char const *name)
void	iguana_set_config_dir_ (char const *name)
void	iguana_start_ ()
void	iguana_stop_ ()
void	iguana_stop_and_keep_ ()
void	iguana_destroy_ ()
void	iguana_bindings_set_verbose_ ()
void	iguana_bindings_set_quiet_ ()
void	iguana_algo_create_ (algo_idx_t *algo_idx, char const *algo_name)
void	iguana_algo_set_name_ (algo_idx_t *algo_idx, char const *name)
void	iguana_algo_set_log_level_ (algo_idx_t *algo_idx, char const *level)
void	iguana_algo_set_config_file_ (algo_idx_t *algo_idx, char const *name)
void	iguana_algo_set_config_dir_ (algo_idx_t *algo_idx, char const *name)
void	iguana_algo_start_ (algo_idx_t *algo_idx)
void	iguana_algo_stop_ (algo_idx_t *algo_idx)
void	iguana_getconfiginstallationprefix_ (char *out)

Typedef Documentation

algo_idx_t

typedef int iguana::bindings::algo_idx_t

Algorithm instance index type

Definition at line 9 of file Bindings.h.

Function Documentation

iguana_algo_create_()

void iguana::bindings::iguana_algo_create_	(	algo_idx_t *	algo_idx,
		char const *	algo_name )

Create an algorithm. Be sure to run iguana_create_() before creating any algorithm.

Parameters

[out]	algo_idx	the algorithm index
[in]	algo_name	the name of the algorithm

iguana_algo_set_config_dir_()

void iguana::bindings::iguana_algo_set_config_dir_	(	algo_idx_t *	algo_idx,
		char const *	name )

Set a custom configuration file directory for this algorithm

Parameters

[in]	algo_idx	the algorithm index
[in]	name	the directory name

iguana_algo_set_config_file_()

void iguana::bindings::iguana_algo_set_config_file_	(	algo_idx_t *	algo_idx,
		char const *	name )

Set a custom configuration file for this algorithm

Parameters

[in]	algo_idx	the algorithm index
[in]	name	the configuration file name

iguana_algo_set_log_level_()

void iguana::bindings::iguana_algo_set_log_level_	(	algo_idx_t *	algo_idx,
		char const *	level )

Set the log level of an algorithm.

Parameters

[in]	algo_idx	the algorithm index
[in]	level	the log level

iguana_algo_set_name_()

void iguana::bindings::iguana_algo_set_name_	(	algo_idx_t *	algo_idx,
		char const *	name )

Set the name of an algorithm.

Parameters

[in]	algo_idx	the algorithm index
[in]	name	the name

iguana_algo_start_()

void iguana::bindings::iguana_algo_start_

(

algo_idx_t *

algo_idx

)

Start an algorithm by calling Algorithm::Start.

Parameters

[in]

algo_idx

the algorithm index

iguana_algo_stop_()

void iguana::bindings::iguana_algo_stop_

(

algo_idx_t *

algo_idx

)

Stop an algorithm by calling Algorithm::Stop.

Parameters

[in]

algo_idx

the algorithm index

iguana_bindings_set_quiet_()

void iguana::bindings::iguana_bindings_set_quiet_

(

)

Disable additional runtime printouts for these binding functions. This setting is not related to algorithm log levels.

See also

iguana_bindings_set_verbose_

iguana_bindings_set_verbose_()

void iguana::bindings::iguana_bindings_set_verbose_

(

)

Enable additional runtime printouts for these binding functions. This setting is not related to algorithm log levels.

See also

iguana_bindings_set_quiet_

iguana_create_()

void iguana::bindings::iguana_create_

(

)

Create the Iguana instance. You may only create one. This instance is the owner of algorithm instances.

iguana_destroy_()

void iguana::bindings::iguana_destroy_

(

)

Destroy the Iguana instance, along with its algorithms. This can be called when you are done using Iguana, to free the allocated memory.

Deprecated

This function is no longer required.

iguana_get_algo_()

Algorithm * iguana::bindings::iguana_get_algo_	(	algo_idx_t *	algo_idx,
		bool	verbose = false )

Get a pointer to an algorithm.

Warning

This function is not for Fortran

Parameters

[in]	algo_idx	the algorithm index
[in]	verbose	enable verbose printout

Returns

a pointer to the algorithm, if it exists; if not, nullptr

iguana_getconfiginstallationprefix_()

void iguana::bindings::iguana_getconfiginstallationprefix_

(

char *

out

)

Get the configuration file installation prefix

Parameters

[in,out]

out

will be set to the prefix

iguana_print_error_()

void iguana::bindings::iguana_print_error_	(	char const *	format,
			... )

Print an error message.

Warning

This function is not for Fortran

Parameters

format

printf arguments

iguana_print_log_()

void iguana::bindings::iguana_print_log_	(	char const *	format,
			... )

Print a log message, only if iguana_bindings_set_verbose_ was called.

Warning

This function is not for Fortran

Parameters

format

printf arguments

iguana_set_config_dir_()

void iguana::bindings::iguana_set_config_dir_

(

char const *

name

)

Set a custom configuration file directory for all algorithms

Parameters

[in]

name

the directory name

iguana_set_config_file_()

void iguana::bindings::iguana_set_config_file_

(

char const *

name

)

Set a custom configuration file for all algorithms

Parameters

[in]

name

the configuration file name

iguana_start_()

void iguana::bindings::iguana_start_

(

)

Start all created algorithm instances, calling Algorithm::Start on each.

iguana_stop_()

void iguana::bindings::iguana_stop_

(

)

Stop all created algorithm instances, calling Algorithm::Stop on each, and free the allocated memory.

See also

iguana_stop_and_keep_()

iguana_stop_and_keep_()

void iguana::bindings::iguana_stop_and_keep_

(

)

Stop all created algorithm instances, but do not destroy them