Template Class ParameterReader

Class Documentation

template<PhasorDynamics::ModelData ModelDataT>
class ParameterReader

Reads typed parameters out of a model data container.

A read method returns the provided value or std::nullopt when the parameter is omitted. The model chooses a default or requires a value. Invalid values are rejected with std::invalid_argument naming the model and parameter. Real parameters accept integer values and must be finite.

Template Parameters:

ModelDataT – A model data container satisfying PhasorDynamics::ModelData.

Public Functions

inline ParameterReader(const ModelDataT &data, const char *model)
Parameters:

  • data – [in] Model data container to read from.

  • model – [in] Model name used in rejection messages.

inline std::optional<RealT> readReal(ParametersT key) const

Read an optional real parameter.

inline std::optional<RealT> readNonNegative(ParametersT key) const

Read an optional non-negative real parameter.

inline std::optional<bool> readBool(ParametersT key) const

Read an optional boolean parameter.

inline std::optional<IdxT> readInteger(ParametersT key) const

Read an optional integer parameter.