Nektar::LibUtilities::H5::CanHaveAttributes Class Reference

Mixin for objects that can have attributes (Group, DataSet, DataType) More...

#include <H5.h>

Inheritance diagram for Nektar::LibUtilities::H5::CanHaveAttributes:

Classes
class	AttrIterator

Public Member Functions
AttributeSharedPtr	CreateAttribute (const std::string &name, DataTypeSharedPtr type, DataSpaceSharedPtr space)
AttributeSharedPtr	OpenAttribute (const std::string &name)
template<class T >
void	SetAttribute (const std::string &name, const T &value)
template<class T >
void	SetAttribute (const std::string &name, const std::vector< T > &value)
template<class T >
void	GetAttribute (const std::string &name, T &value)
template<class T >
void	GetAttribute (const std::string &name, std::vector< T > &value)
int	GetNumAttr () const
AttrIterator	attr_begin ()
AttrIterator	attr_end ()
Public Member Functions inherited from Nektar::LibUtilities::H5::Object
void	Close ()
hid_t	GetId () const
	operator hid_t () const

Additional Inherited Members
Protected Member Functions inherited from Nektar::LibUtilities::H5::Object
	Object ()
	Object (hid_t id)
virtual	~Object ()
virtual void	v_Close ()=0
Protected Attributes inherited from Nektar::LibUtilities::H5::Object
hid_t	m_Id

Detailed Description

Mixin for objects that can have attributes (Group, DataSet, DataType)

Definition at line 259 of file H5.h.

Member Function Documentation

attr_begin()

CanHaveAttributes::AttrIterator Nektar::LibUtilities::H5::CanHaveAttributes::attr_begin

(

)

Definition at line 346 of file H5.cpp.

{
    // Have to use dynamic because of virtual inheritance
    CanHaveAttributesSharedPtr thisSh =
        std::dynamic_pointer_cast<CanHaveAttributes>(shared_from_this());
    return CanHaveAttributes::AttrIterator(thisSh);
}

attr_end()

CanHaveAttributes::AttrIterator Nektar::LibUtilities::H5::CanHaveAttributes::attr_end

(

)

Definition at line 353 of file H5.cpp.

{
    // Have to use dynamic because of virtual inheritance
    CanHaveAttributesSharedPtr thisSh =
        std::dynamic_pointer_cast<CanHaveAttributes>(shared_from_this());
    return CanHaveAttributes::AttrIterator(thisSh, GetNumAttr());
}

CreateAttribute()

AttributeSharedPtr Nektar::LibUtilities::H5::CanHaveAttributes::CreateAttribute	(	const std::string &	name,
		DataTypeSharedPtr	type,
		DataSpaceSharedPtr	space
	)

Definition at line 327 of file H5.cpp.

{
    return Attribute::Create(m_Id, name, type, space);
}

References Nektar::LibUtilities::H5::Attribute::Create(), Nektar::LibUtilities::H5::Object::m_Id, and CellMLToNektar.pycml::name.

Referenced by SetAttribute().

GetAttribute() [1/2]

template<typename T >

void Nektar::LibUtilities::H5::CanHaveAttributes::GetAttribute	(	const std::string &	name,
		std::vector< T > &	value
	)

Definition at line 776 of file H5.h.

{
    typedef std::vector<
        typename DataTypeConversionPolicy<T>::ConvertedVectorElemType>
        Vec;
    Vec converted_vals;
    DataTypeSharedPtr type   = DataTypeTraits<T>::GetType();
    AttributeSharedPtr attr  = OpenAttribute(name);
    DataSpaceSharedPtr space = attr->GetSpace();
    ASSERTL0(H5Sget_simple_extent_ndims(space->GetId()) == 1,
             "vector data not 1D");
    hsize_t len, maxdim;
    H5Sget_simple_extent_dims(space->GetId(), &len, &maxdim);
 
    value.resize(len);
    void *converted_buf = nullptr;
    if (DataTypeConversionPolicy<T>::MustConvert)
    {
        converted_vals.resize(len);
        converted_buf = &converted_vals[0];
    }
    else
    {
        converted_buf = &value[0];
    }
 
    H5_CALL(H5Aread, (attr->GetId(), type->GetId(), converted_buf));
 
    if (DataTypeConversionPolicy<T>::MustConvert)
    {
        typename Vec::iterator src             = converted_vals.begin(),
                               end             = converted_vals.end();
        typename std::vector<T>::iterator dest = value.begin();
        for (; src != end; ++src, ++dest)
        {
            *dest = DataTypeTraits<T>::Deconvert(*src);
        }
    }
}

References ASSERTL0, Nektar::LibUtilities::H5::DataTypeTraits< T >::Deconvert(), Nektar::LibUtilities::H5::DataTypeTraits< T >::GetType(), H5_CALL, CellMLToNektar.pycml::name, and OpenAttribute().

GetAttribute() [2/2]

template<typename T >

void Nektar::LibUtilities::H5::CanHaveAttributes::GetAttribute	(	const std::string &	name,
		T &	value
	)

Definition at line 762 of file H5.h.

{
    DataTypeSharedPtr type   = DataTypeTraits<T>::GetType();
    DataSpaceSharedPtr space = DataSpace::Scalar();
    AttributeSharedPtr attr  = OpenAttribute(name);
 
    typename DataTypeTraits<T>::ConvertedType conv;
 
    H5_CALL(H5Aread, (attr->GetId(), type->GetId(),
                      DataTypeTraits<T>::GetAddress(conv)));
    value = DataTypeTraits<T>::Deconvert(conv);
}

References Nektar::LibUtilities::H5::DataTypeTraits< T >::Deconvert(), Nektar::LibUtilities::H5::DataTypeTraits< T >::GetType(), H5_CALL, CellMLToNektar.pycml::name, OpenAttribute(), and Nektar::LibUtilities::H5::DataSpace::Scalar().

GetNumAttr()

int Nektar::LibUtilities::H5::CanHaveAttributes::GetNumAttr

(

)

const

Definition at line 339 of file H5.cpp.

{
    H5O_info_t info;
    H5_CALL(H5Oget_info, (m_Id, &info));
    return info.num_attrs;
}

References H5_CALL, and Nektar::LibUtilities::H5::Object::m_Id.

OpenAttribute()

AttributeSharedPtr Nektar::LibUtilities::H5::CanHaveAttributes::OpenAttribute

(

const std::string &

name

)

Definition at line 334 of file H5.cpp.

{
    return Attribute::Open(m_Id, name);
}

References Nektar::LibUtilities::H5::Object::m_Id, CellMLToNektar.pycml::name, and Nektar::LibUtilities::H5::Attribute::Open().

Referenced by GetAttribute().

SetAttribute() [1/2]

template<typename T >

void Nektar::LibUtilities::H5::CanHaveAttributes::SetAttribute	(	const std::string &	name,
		const std::vector< T > &	value
	)

Definition at line 732 of file H5.h.

{
    typedef std::vector<
        typename DataTypeConversionPolicy<T>::ConvertedVectorElemType>
        Vec;
    Vec converted_vals;
    DataTypeSharedPtr type   = DataTypeTraits<T>::GetType();
    DataSpaceSharedPtr space = DataSpace::OneD(value.size());
    AttributeSharedPtr attr  = CreateAttribute(name, type, space);
 
    const void *converted_buf = nullptr;
    if (DataTypeConversionPolicy<T>::MustConvert)
    {
        converted_vals.resize(value.size());
        for (size_t i = 0; i < value.size(); ++i)
        {
            converted_vals[i] = DataTypeConversionPolicy<T>::Convert(value[i]);
        }
        converted_buf = &converted_vals[0];
    }
    else
    {
        converted_buf = &value[0];
    }
 
    H5_CALL(H5Awrite, (attr->GetId(), type->GetId(), converted_buf));
}

References Nektar::LibUtilities::H5::DataTypeConversionPolicy< T >::Convert(), CreateAttribute(), Nektar::LibUtilities::H5::DataTypeTraits< T >::GetType(), H5_CALL, CellMLToNektar.pycml::name, and Nektar::LibUtilities::H5::DataSpace::OneD().

SetAttribute() [2/2]

template<typename T >

void Nektar::LibUtilities::H5::CanHaveAttributes::SetAttribute	(	const std::string &	name,
		const T &	value
	)

Definition at line 719 of file H5.h.

{
    DataTypeSharedPtr type   = DataTypeTraits<T>::GetType();
    DataSpaceSharedPtr space = DataSpace::Scalar();
    AttributeSharedPtr attr  = CreateAttribute(name, type, space);
 
    typename DataTypeTraits<T>::ConvertedType conv =
        DataTypeTraits<T>::Convert(value);
    H5_CALL(H5Awrite, (attr->GetId(), type->GetId(),
                       DataTypeTraits<T>::GetAddress(conv)));
}

References Nektar::LibUtilities::H5::DataTypeTraits< T >::Convert(), CreateAttribute(), Nektar::LibUtilities::H5::DataTypeTraits< T >::GetType(), H5_CALL, CellMLToNektar.pycml::name, and Nektar::LibUtilities::H5::DataSpace::Scalar().