gfields Namespace Reference

Functions
std::vector< GFieldDefinition >	get_GFieldDefinition (const std::shared_ptr< GOptions > &gopts)
	Build the list of field definitions from the provided options.
GOptions	defineOptions ()
	Define all options used by the GField module and its built-in field factories.
bool	runFieldQueries (const std::shared_ptr< GOptions > &gopts)
	Evaluate configured fields from fieldAt and fieldMapPoints options, if requested.

Function Documentation

defineOptions()

GOptions gfields::defineOptions

(

)

Returns

A GOptions instance containing module option definitions and logger registrations.

This function registers:

• options for field plugins implemented in this module (currently gmultipoles),
• and the loggers used by the module (gfield, gmagneto, and plugin).

Definition at line 192 of file gfield_options.cc.

get_GFieldDefinition()

std::vector< GFieldDefinition > gfields::get_GFieldDefinition

(

const std::shared_ptr< GOptions > &

gopts

)

Parameters

gopts

Shared options container that holds user configuration (e.g. YAML-derived data).

Returns

Vector of field definitions describing which field plugins to load and how to configure them.

The returned vector is typically consumed by GMagneto() during construction.

Definition at line 114 of file gfield_options.cc.

runFieldQueries()

bool gfields::runFieldQueries

(

const std::shared_ptr< GOptions > &

gopts

)

Parameters

gopts

Shared options container with field definitions and query options.

Returns

True when at least one query option was present and processed.

The query options are intended for command-line inspection workflows:

• fieldAt accepts one coordinate triplet with units, for example "10*cm 0*mm 2*m".
• fieldMapPoints accepts an ASCII file with one x y z coordinate triplet per line.

Definition at line 250 of file gfield_options.cc.