SidreTypes.hpp File Reference

File containing types used in the Sidre component of axom. More...

#include "SidreDataTypeIds.h"
#include "conduit.hpp"
#include "axom/core/Types.hpp"
#include "axom/core/memory_management.hpp"
#include "axom/core/utilities/StringUtilities.hpp"
#include "axom/fmt.hpp"

Classes
struct	axom::fmt::formatter< axom::sidre::DataTypeId >

Namespaces
	axom
	axom::sidre
	axom::fmt

Typedefs
using	axom::sidre::Node = conduit::Node
	The Node class is the primary object in Conduit. More...
using	axom::sidre::DataType = conduit::DataType
	DataType is a general Conduit descriptor. More...
using	axom::sidre::Schema = conduit::Schema
	A Conduit Schema describes the data in a Node. More...
using	axom::sidre::IndexType = axom::IndexType
	IndexType is used for any labeling of a sidre object by an integer identifier. More...
using	axom::sidre::TypeID = DataTypeId
	TypeID is used to identify the type of a buffer (SIDRE_INT8_ID, etc). More...

Enumerations
enum	axom::sidre::DataTypeId {   axom::sidre::NO_TYPE_ID = CONDUIT_EMPTY_ID , axom::sidre::INT8_ID = CONDUIT_INT8_ID , axom::sidre::INT16_ID = CONDUIT_INT16_ID , axom::sidre::INT32_ID = CONDUIT_INT32_ID ,   axom::sidre::INT64_ID = CONDUIT_INT64_ID , axom::sidre::UINT8_ID = CONDUIT_UINT8_ID , axom::sidre::UINT16_ID = CONDUIT_UINT16_ID , axom::sidre::UINT32_ID = CONDUIT_UINT32_ID ,   axom::sidre::UINT64_ID = CONDUIT_UINT64_ID , axom::sidre::FLOAT32_ID = CONDUIT_FLOAT32_ID , axom::sidre::FLOAT64_ID = CONDUIT_FLOAT64_ID , axom::sidre::CHAR8_STR_ID = CONDUIT_CHAR8_STR_ID ,   axom::sidre::INT_ID = CONDUIT_NATIVE_INT_ID , axom::sidre::UINT_ID = CONDUIT_NATIVE_UNSIGNED_INT_ID , axom::sidre::LONG_ID = CONDUIT_NATIVE_LONG_ID , axom::sidre::ULONG_ID = CONDUIT_NATIVE_UNSIGNED_LONG_ID ,   axom::sidre::FLOAT_ID = CONDUIT_NATIVE_FLOAT_ID , axom::sidre::DOUBLE_ID = CONDUIT_NATIVE_DOUBLE_ID }
	Enum that holds the numeric data type id options for sidre types. More...

Functions
bool	axom::sidre::indexIsValid (IndexType idx)
	Returns true if idx is valid, else false. More...
bool	axom::sidre::nameIsValid (const std::string &name)
	Returns true if name is valid, else false. More...
constexpr int	axom::sidre::getInvalidAllocatorID () noexcept
	Return Axom's identifier for an invalid allocator. More...
constexpr int	axom::sidre::getMallocAllocatorID () noexcept
	Return Axom's identifier for the malloc allocator. More...
TypeID	axom::sidre::getTypeID (const int typeID)
	Convenience function to convert int to TypeID type. More...

Variables
constexpr IndexType	axom::sidre::InvalidIndex = axom::InvalidIndex
	Common invalid index identifier used in sidre. More...
const std::string	axom::sidre::InvalidName = axom::utilities::string::InvalidName
	Common invalid name string usde in sidre. More...

Detailed Description

File containing types used in the Sidre component of axom.