gmx::OptionValueConverterSimple< OutType > Class Template Reference

#include <gromacs/options/valueconverter.h>

Description

template<typename OutType>
class gmx::OptionValueConverterSimple< OutType >

Helper for converting from Variant to a given type.

Template Parameters

OutType

Type this converter converts to.

Default-constructed converter only supports identity mapping from the a Variant holding OutType. To add support for additional input types, provide conversion functions with addConverter(). To use a non-identity mapping for an OutType -> OutType conversion, provide an alternative conversion from OutType with addConverter().

Public Member Functions
OutType	convert (const Variant &value) const
	Converts a Variant value to the output type. More...
template<typename InType >
void	addConverter (std::function< OutType(const InType &)> func)
	Adds a supported conversion. More...
template<typename InType >
void	addCastConversion ()
	Adds a supported conversion from a type that can be directly cast. More...

Member Function Documentation

template<typename OutType>

template<typename InType >

void gmx::OptionValueConverterSimple< OutType >::addCastConversion ( )

inline

Adds a supported conversion from a type that can be directly cast.

Template Parameters

InType

Type to convert from with a simple cast.

template<typename OutType>

template<typename InType >

void gmx::OptionValueConverterSimple< OutType >::addConverter ( std::function< OutType(const InType &)>  func )

inline

Adds a supported conversion.

Template Parameters

InType

Type to convert from.

Parameters

func	Function to convert from InType to OutType.

template<typename OutType>

OutType gmx::OptionValueConverterSimple< OutType >::convert ( const Variant &  value ) const

inline

Converts a Variant value to the output type.

Returns

Converted value.

Exceptions

InvalidInputError

If the input Variant has a type that is not recognized by any conversion.

---

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

• src/gromacs/options/valueconverter.h