ARTS 2.5.4 (git: 31ce4f0e)
AgendaManip::AgendaCreator Struct Reference

Helper class to create an agenda. More...

#include <agenda_set.h>

Public Member Functions

 AgendaCreator (Workspace &workspace, const char *name)
 
Agenda finalize ()
 Check the agenda and return a copy of it (ignoring/touching all agenda input/output not dealt with) More...
 
template<typename... Input>
void add (const std::string_view method, Input &&... input)
 Add a method with as many inputs as you want. These inputs must be of type Wsv. More...
 
void set (const std::string_view var, const TokVal &value)
 Set a variable to a value. More...
 
void ignore (const std::string_view var)
 Ignores a variable (only call if the variable input is ignored despite being BOTH in- and output) More...
 

Public Attributes

Workspacews
 
Agenda agenda
 

Detailed Description

Helper class to create an agenda.

Definition at line 144 of file agenda_set.h.

Constructor & Destructor Documentation

◆ AgendaCreator()

AgendaManip::AgendaCreator::AgendaCreator ( Workspace workspace,
const char *  name 
)

Definition at line 172 of file agenda_set.cc.

References agenda, and Agenda::set_name().

Member Function Documentation

◆ add()

◆ finalize()

Agenda AgendaManip::AgendaCreator::finalize ( )

Check the agenda and return a copy of it (ignoring/touching all agenda input/output not dealt with)

Check the agenda and move it out of here.

Add Ignore(WSV)

Add Touch(WSV)

Finally check that the agenda is OK (it should be a developer error if this fails!)

Definition at line 178 of file agenda_set.cc.

References agenda, global_data::agenda_data, global_data::AgendaMap, Agenda::check(), global_data::MdMap, Agenda::Methods(), Agenda::name(), Agenda::push_back(), var_string(), ws, Workspace::wsv_data_ptr, and global_data::wsv_groups.

Referenced by AgendaManip::get_dobatch_calc_agenda(), AgendaManip::get_doit_conv_test_agenda(), AgendaManip::get_doit_mono_agenda(), AgendaManip::get_doit_rte_agenda(), AgendaManip::get_doit_scat_field_agenda(), AgendaManip::get_forloop_agenda(), AgendaManip::get_g0_agenda(), AgendaManip::get_gas_scattering_agenda(), AgendaManip::get_inversion_iterate_agenda(), AgendaManip::get_iy_cloudbox_agenda(), AgendaManip::get_iy_independent_beam_approx_agenda(), AgendaManip::get_iy_loop_freqs_agenda(), AgendaManip::get_iy_main_agenda(), AgendaManip::get_iy_radar_agenda(), AgendaManip::get_iy_space_agenda(), AgendaManip::get_iy_surface_agenda(), AgendaManip::get_jacobian_agenda(), AgendaManip::get_main_agenda(), AgendaManip::get_met_profile_calc_agenda(), AgendaManip::get_pha_mat_spt_agenda(), AgendaManip::get_ppath_agenda(), AgendaManip::get_ppath_step_agenda(), AgendaManip::get_propmat_clearsky_agenda(), AgendaManip::get_refr_index_air_agenda(), AgendaManip::get_sensor_response_agenda(), AgendaManip::get_spt_calc_agenda(), AgendaManip::get_surface_rtprop_agenda(), AgendaManip::get_surface_rtprop_sub_agenda(), AgendaManip::get_test_agenda(), AgendaManip::get_water_p_eq_agenda(), AgendaManip::get_ybatch_calc_agenda(), and propmat_clearsky_agendaAuto().

◆ ignore()

void AgendaManip::AgendaCreator::ignore ( const std::string_view  var)

Ignores a variable (only call if the variable input is ignored despite being BOTH in- and output)

Definition at line 224 of file agenda_set.cc.

References add(), and Raw::Average::var().

Referenced by AgendaManip::get_iy_main_agenda().

◆ set()

void AgendaManip::AgendaCreator::set ( const std::string_view  var,
const TokVal value 
)

Member Data Documentation

◆ agenda

Agenda AgendaManip::AgendaCreator::agenda

Definition at line 146 of file agenda_set.h.

Referenced by add(), AgendaCreator(), finalize(), and set().

◆ ws

Workspace& AgendaManip::AgendaCreator::ws

Definition at line 145 of file agenda_set.h.

Referenced by add(), finalize(), and set().


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