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.

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 48 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 12 of file gfield_options.cc.