4.21 sdds::convertUnits

• name:
  sdds::convertUnits
• description:
  Multiply a numeric parameter, array, or column by a conversion factor and replace its unit metadata in one immutable operation. Both layout and loaded data remain consistent in the returned page.
• synopsis:
  sdds::Page sdds::convertUnits(  
      const sdds::Page &page, sdds::FieldKind kind,  
      std::string_view name, std::optional<std::string> units,  
      long double factor);

• arguments:
  • page — Source page.
  • kind — Parameter, Array, or Column.
  • name — Numeric field name.
  • units — Replacement unit string, or no unit metadata.
  • factor — Multiplicative conversion factor.
• return value:
  A converted page that owns a correspondingly edited layout.
• exceptions:
  sdds::StateError for an absent or unloaded field, sdds::TypeError for nonnumeric data or overflow, and sdds::LimitError for excessive transformation output.
• see also:
  Sections 4.5 and 4.10.