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

#include <gfield.h>

Collaboration diagram for GFieldDefinition:

Public Member Functions
	GFieldDefinition ()=default
	Default constructor.

void	add_map_parameter (const std::string &key, const std::string &value)
	Adds a parameter to the field parameters map.

std::string	gfieldPluginName () const
	Gets the plugin name for the field.

Data Fields
std::string	name
	Key in the gmagneto maps.

std::string	integration_stepper
	Type of integration stepper.

double	minimum_step
	Minimum step size for integration.

std::string	type
	Type of the field.

std::map< std::string, std::string >	field_parameters
	Field parameters as key-value pairs.

Detailed Description

Definition at line 18 of file gfield.h.

Constructor & Destructor Documentation

◆ GFieldDefinition()

GFieldDefinition::GFieldDefinition ( )

default

Member Function Documentation

◆ add_map_parameter()

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

inline

Parameters

key	Parameter key.
value	Parameter value.

Definition at line 36 of file gfield.h.

◆ gfieldPluginName()

std::string GFieldDefinition::gfieldPluginName ( ) const

inline

Returns: Plugin name as a string.

Definition at line 42 of file gfield.h.

Field Documentation

◆ field_parameters

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

Definition at line 29 of file gfield.h.

◆ integration_stepper

std::string GFieldDefinition::integration_stepper

Definition at line 25 of file gfield.h.

◆ minimum_step

double GFieldDefinition::minimum_step

Definition at line 26 of file gfield.h.

◆ name

std::string GFieldDefinition::name

Definition at line 24 of file gfield.h.

◆ type

std::string GFieldDefinition::type

Definition at line 27 of file gfield.h.

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

gfield.h

Public Member Functions

Data Fields