ModuleIO::Input_Item Class Reference

#include <input_item.h>

Collaboration diagram for ModuleIO::Input_Item:

Public Member Functions
	Input_Item ()
	Input_Item (const std::string &label_in)
	Input_Item (const Input_Item &item)
bool	is_read () const
	< check if the input item is read
size_t	get_size () const
	< get size of the input item

Public Attributes
std::string	label
	label of the input item
std::vector< std::string >	str_values
	string values of the input item
std::stringstream	final_value
	final value for writing to output INPUT file
std::string	category
	category for grouping (e.g., "System variables")
std::string	type
	data type ("Integer", "Real", "String", "Boolean")
std::string	description
	full description (supports multi-line, lists, notes)
std::string	default_value
	default value as string
std::string	unit
	unit of measurement (empty if none)
std::string	availability
	availability conditions (empty if always)
std::string	annotation
	brief annotation (kept for backward compatibility)
std::function< void(const Input_Item &, Parameter &)>	read_value = [](const Input_Item& item, Parameter& param) {}
	read value function
std::function< void(const Input_Item &, const Parameter &)>	check_value = nullptr
	check value function
std::function< void(const Input_Item &, Parameter &)>	reset_value = nullptr
std::function< void(Input_Item &, const Parameter &)>	get_final_value = nullptr
	get final_value function for output INPUT file

Constructor & Destructor Documentation

Input_Item() [1/3]

ModuleIO::Input_Item::Input_Item ( )

inline

Input_Item() [2/3]

ModuleIO::Input_Item::Input_Item ( const std::string &  label_in )

inline

Input_Item() [3/3]

ModuleIO::Input_Item::Input_Item ( const Input_Item &  item )

inline

Member Function Documentation

get_size()

size_t ModuleIO::Input_Item::get_size ( ) const

inline

< get size of the input item

Here is the caller graph for this function:

is_read()

bool ModuleIO::Input_Item::is_read ( ) const

inline

< check if the input item is read

Here is the caller graph for this function:

Member Data Documentation

annotation

std::string ModuleIO::Input_Item::annotation

brief annotation (kept for backward compatibility)

availability

std::string ModuleIO::Input_Item::availability

availability conditions (empty if always)

category

std::string ModuleIO::Input_Item::category

category for grouping (e.g., "System variables")

check_value

std::function<void(const Input_Item&, const Parameter&)> ModuleIO::Input_Item::check_value = nullptr

check value function

default_value

std::string ModuleIO::Input_Item::default_value

default value as string

description

std::string ModuleIO::Input_Item::description

full description (supports multi-line, lists, notes)

final_value

std::stringstream ModuleIO::Input_Item::final_value

final value for writing to output INPUT file

get_final_value

std::function<void(Input_Item&, const Parameter&)> ModuleIO::Input_Item::get_final_value = nullptr

get final_value function for output INPUT file

label

std::string ModuleIO::Input_Item::label

label of the input item

read_value

std::function<void(const Input_Item&, Parameter&)> ModuleIO::Input_Item::read_value = [](const Input_Item& item, Parameter& param) {}

read value function

reset_value

std::function<void(const Input_Item&, Parameter&)> ModuleIO::Input_Item::reset_value = nullptr

reset this value when some conditions are met e.g. should only reset the value of this item

str_values

std::vector<std::string> ModuleIO::Input_Item::str_values

string values of the input item

type

std::string ModuleIO::Input_Item::type

data type ("Integer", "Real", "String", "Boolean")

unit

std::string ModuleIO::Input_Item::unit

unit of measurement (empty if none)

---

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

• /home/runner/work/abacus-develop/abacus-develop/source/source_io/module_parameter/input_item.h