GFieldDefinition Struct Reference

Utility struct to load GFields from options. More...

#include <gfield.h>

Collaboration diagram for GFieldDefinition:

Public Member Functions
	GFieldDefinition ()
	Default constructor. More...
void	add_map_parameter (std::string key, std::string value)
	Adds a parameter to the field parameters map. More...
string	gfieldPluginName ()
	Gets the plugin name for the field. More...

Data Fields
std::string	name
	Key in the gmagneto maps. More...
std::string	integration_stepper
	Type of integration stepper. More...
double	minimum_step
	Minimum step size for integration. More...
std::string	type
	Type of the field. More...
int	verbosity
	Verbosity level. More...
map< std::string, string >	field_parameters
	Field parameters as key-value pairs. More...

Detailed Description

Definition at line 17 of file gfield.h.

Constructor & Destructor Documentation

GFieldDefinition()

GFieldDefinition::GFieldDefinition ( )

inline

Definition at line 21 of file gfield.h.

Member Function Documentation

add_map_parameter()

void GFieldDefinition::add_map_parameter ( std::string  key, std::string  value  )

inline

Parameters

key	Parameter key.
value	Parameter value.

Definition at line 36 of file gfield.h.

gfieldPluginName()

string GFieldDefinition::gfieldPluginName ( )

inline

Returns

Plugin name as a string.

Definition at line 44 of file gfield.h.

Field Documentation

field_parameters

map<std::string, string> GFieldDefinition::field_parameters

Definition at line 29 of file gfield.h.

integration_stepper

std::string GFieldDefinition::integration_stepper

Definition at line 24 of file gfield.h.

minimum_step

double GFieldDefinition::minimum_step

Definition at line 25 of file gfield.h.

name

std::string GFieldDefinition::name

Definition at line 23 of file gfield.h.

type

std::string GFieldDefinition::type

Definition at line 26 of file gfield.h.

verbosity

int GFieldDefinition::verbosity

Definition at line 27 of file gfield.h.

---

The documentation for this struct was generated from the following file:

• gfield.h