ioda::detail Namespace Reference

Namespaces
	compat
	Compatibility functions.
	EigenCompat
	Functions to work with Eigen.
	Engines
	python_bindings
	Implements wrappers that isolate the read and write functions.

Classes
class	Attribute_Base
	Base class for Attributes. More...
class	Attribute_Backend
	Attribute backends inherit from this. More...
class	Attribute_Creator_Base
	Flywheel creation of ioda::Attribute. More...
class	CanAddAttributes
	Describes the functions that can add attributes. More...
class	CanReadAttributes
	Describes the functions that can read attributes. More...
class	Has_Attributes_Base
class	Has_Attributes_Backend
class	Group_Base
	Hidden base class to prevent constructor confusion. More...
class	Group_Backend
class	DataLayoutPolicy
	Policy used for setting locations for Variable access. More...
struct	Object_Accessor_Complex
struct	Object_Accessor_Regular
struct	Object_Accessor_Fixed_Array
struct	Object_Accessor_Variable_Array_With_Data_Method
struct	Object_Accessor_Variable_Raw_Array
struct	Object_AccessorTypedef
struct	Object_AccessorTypedef< std::string >
struct	Object_AccessorTypedef< int[2]>
struct	Object_AccessorTypedef< std::array< int, 2 > >
class	Type_Base
class	Type_Backend
class	Type_Provider
	Backends implement type providers in conjunction with Attributes, Has_Attributes, Variables and Has_Variables. The backend objects pass through their underlying logic to represent types. More...
struct	FillValueData_t
	Container used to store and manipulate fill values. More...
class	Has_Variables_Base
class	Has_Variables_Backend
class	Variable_Base
	Exists to prevent constructor conflicts when passing a backend into a frontend object. More...
class	Variable_Backend
	Variable backends inherit from this. More...
class	DataLayoutPolicy_ObsGroup
	Layout for ObsGroup-like data. More...
struct	variableStorageInformation
class	DataLayoutPolicy_ObsGroup_ODB
	Layout for ObsGroup-like data. More...
class	VariableParameters
class	ComplementaryVariablesParameters
class	ODBLayoutParameters

Enumerations
enum class	PointerOwner { Engine , Caller }
	Who owns (and should free) pointers passed across the frontend / backend interface? More...

Functions
double	celsiusToKelvin (double temp)
double	knotsToMetersPerSecond (double knots)
double	percentageToFraction (double percentage)
double	hectopascalToPascal (double hPa)
double	degreesToRadians (double deg)
double	oktaToFraction (double okta)
IODA_DL size_t	COMPAT_strncpy_s (char *dest, size_t destSz, const char *src, size_t srcSz)
	Safe char array copy. More...
template<class T >
T	getFillValue (FillValueData_t &data)
template<>
std::string	getFillValue (FillValueData_t &data)
template<class T >
void	assignFillValue (FillValueData_t &data, T val)
template<>
void	assignFillValue< std::string > (FillValueData_t &data, std::string val)

Variables
const std::unordered_map< std::string, std::function< double(double)> >	unitConversionEquations
const std::unordered_map< std::string, std::string >	equivalentSIUnit

Function Documentation

celsiusToKelvin()

double ioda::detail::celsiusToKelvin ( double  temp )

inline

Definition at line 21 of file UnitConversions.h.

COMPAT_strncpy_s()

size_t ioda::detail::COMPAT_strncpy_s	(	char *	dest,
		size_t	destSz,
		const char *	src,
		size_t	srcSz
	)

Safe char array copy.

Returns

the number of characters actually written.

Parameters

dest	is the pointer to the destination. Always null terminated.
destSz	is the size of the destination buller, including the trailing null character.
src	is the pointer to the source. Characters from src are copied either until the first null character or until srcSz. Note that null termination comes later.
srcSz	is the max size of the source buffer.

Deprecated:

This function is old and should not be used!

Definition at line 25 of file Type.cpp.

Here is the caller graph for this function:

degreesToRadians()

double ioda::detail::degreesToRadians ( double  deg )

inline

Definition at line 37 of file UnitConversions.h.

hectopascalToPascal()

double ioda::detail::hectopascalToPascal ( double  hPa )

inline

Definition at line 33 of file UnitConversions.h.

knotsToMetersPerSecond()

double ioda::detail::knotsToMetersPerSecond ( double  knots )

inline

Definition at line 25 of file UnitConversions.h.

oktaToFraction()

double ioda::detail::oktaToFraction ( double  okta )

inline

Definition at line 41 of file UnitConversions.h.

percentageToFraction()

double ioda::detail::percentageToFraction ( double  percentage )

inline

Definition at line 29 of file UnitConversions.h.

Variable Documentation

equivalentSIUnit

const std::unordered_map<std::string, std::string> ioda::detail::equivalentSIUnit

Initial value:

{
  {"celsius", "kelvin"},
  {"knot", "meters per second"},
  {"percentage", "-"},
  {"hectopascal", "pascal"},
  {"degree", "radian"},
  {"okta", "-"}
}

Todo:

Move to source file.

Definition at line 56 of file UnitConversions.h.

unitConversionEquations

const std::unordered_map<std::string, std::function<double(double)> > ioda::detail::unitConversionEquations

Initial value:

{
  {"celsius", celsiusToKelvin},
  {"knot", knotsToMetersPerSecond},
  {"percentage", percentageToFraction},
  {"hectopascal", hectopascalToPascal},
  {"degree", degreesToRadians},
  {"okta", oktaToFraction}
}

Todo:

Move to source file.

Definition at line 46 of file UnitConversions.h.