HelicsPrimaryTypes.hpp File Reference

naming a set of types that are interchangeable and recognizable inside the HELICS application API and core More...

#include "ValueConverter.hpp"
#include "helics/helics-config.h"
#include "helicsTypes.hpp"
#include "helics_cxx_export.h"
#include <cmath>
#include <complex>
#include <cstdint>
#include <string>
#include <utility>
#include <variant>
#include <vector>

Go to the source code of this file.

Namespaces
	helics
	the main namespace for the helics co-simulation library User functions will be in the helics namespace with internal functions possible in a lower level namespace

Typedefs
using	helics::defV = std::variant< double, int64_t, std::string, std::complex< double >, std::vector< double >, std::vector< std::complex< double > >, NamedPoint >

Enumerations
enum	helics::TypeLocation : decltype(std::declval< defV >().index()) {   double_loc = 0U , int_loc = 1U , string_loc = 2U , complex_loc = 3U ,   vector_loc = 4U , complex_vector_loc = 5U , named_point_loc = 6U }

Functions
bool	helics::isTrueString (const std::string_view str)
bool	helics::changeDetected (const defV &prevValue, const std::string &val, double)
bool	helics::changeDetected (const defV &prevValue, std::string_view val, double)
bool	helics::changeDetected (const defV &prevValue, const std::vector< double > &val, double deltaV)
bool	helics::changeDetected (const defV &prevValue, const std::vector< std::complex< double >> &val, double deltaV)
bool	helics::changeDetected (const defV &prevValue, const double *vals, size_t size, double deltaV)
bool	helics::changeDetected (const defV &prevValue, const std::complex< double > &val, double deltaV)
bool	helics::changeDetected (const defV &prevValue, double val, double deltaV)
bool	helics::changeDetected (const defV &prevValue, int64_t val, double deltaV)
bool	helics::changeDetected (const defV &prevValue, Time val, double deltaV)
bool	helics::changeDetected (const defV &prevValue, const NamedPoint &val, double deltaV)
bool	helics::changeDetected (const defV &prevValue, bool val, double)
int64_t	helics::make_valid (bool obj)
int64_t	helics::make_valid (uint64_t val)
int64_t	helics::make_valid (int16_t val)
int64_t	helics::make_valid (uint16_t val)
int64_t	helics::make_valid (char val)
int64_t	helics::make_valid (unsigned char val)
int64_t	helics::make_valid (int32_t val)
int64_t	helics::make_valid (uint32_t val)
int64_t	helics::make_valid (Time val)
double	helics::make_valid (float val)
std::complex< double >	helics::make_valid (const std::complex< float > &val)
template<class X >
decltype(auto)	helics::make_valid (X &&obj)
void	helics::valueExtract (const defV &data, std::string &val)
void	helics::valueExtract (const defV &data, std::complex< double > &val)
void	helics::valueExtract (const defV &data, std::vector< double > &val)
void	helics::valueExtract (const defV &data, std::vector< std::complex< double >> &val)
void	helics::valueExtract (const defV &data, NamedPoint &val)
void	helics::valueExtract (const defV &data, Time &val)
void	helics::valueExtract (const defV &data, char &val)
void	helics::valueExtract (const defV &data, bool &val)
defV	helics::readJsonValue (const data_view &data)
void	helics::valueExtract (const data_view &data, DataType baseType, std::string &val)
void	helics::valueExtract (const data_view &data, DataType baseType, std::vector< double > &val)
void	helics::valueExtract (const data_view &data, DataType baseType, std::complex< double > &val)
void	helics::valueExtract (const data_view &data, DataType baseType, std::vector< std::complex< double >> &val)
void	helics::valueExtract (const data_view &data, DataType baseType, NamedPoint &val)
void	helics::valueExtract (const data_view &data, DataType baseType, Time &val)
void	helics::valueExtract (const data_view &data, DataType baseType, bool &val)
void	helics::valueExtract (const data_view &data, DataType baseType, defV &val)
void	helics::valueExtract (const data_view &data, DataType baseType, char &val)
template<class X >
std::enable_if_t< std::is_arithmetic< X >::value &&(!std::is_same< X, char >::value)>	helics::valueExtract (const defV &data, X &val)
template<class X >
std::enable_if_t< std::is_arithmetic< X >::value &&(!std::is_same< X, char >::value)>	helics::valueExtract (const data_view &data, DataType baseType, X &val)
void	helics::valueConvert (defV &val, DataType newType)
SmallBuffer	helics::typeConvertDefV (DataType type, const defV &val)
SmallBuffer	helics::typeConvertDefV (const defV &val)

Detailed Description

naming a set of types that are interchangeable and recognizable inside the HELICS application API and core