tools::hdf5::pages Class Reference

Public Member Functions
	pages (std::ostream &a_out, hid_t a_group, const std::string &a_name, const std::string &a_form, bool a_write, unsigned int a_compress)
virtual	~pages ()
bool	is_valid () const
const std::string &	name () const
const std::string &	form () const
tools::uint64	entries () const
tools::uint64	pos () const
void	reset_pos ()
template<class TYPE >
bool	write_page (size_t a_size, const TYPE *a_array)
template<class TYPE >
bool	read_page (size_t a_size, TYPE *a_array)
template<class TYPE >
bool	write_vlen (size_t a_size, const TYPE *a_array)
template<class TYPE >
bool	read_vlen (size_t &a_size, TYPE *&a_array)
bool	write_string (const std::string &a_string)
bool	read_string (std::string &a_string)

Protected Member Functions
	pages (const pages &a_from)
pages &	operator= (const pages &)

Protected Attributes
std::ostream &	m_out
std::string	m_name
std::string	m_form
hid_t	m_group
hid_t	m_dataset
bool	m_write
unsigned int	m_compress
tools::uint64	m_entries
tools::uint64	m_pos

Detailed Description

Definition at line 27 of file pages.

Constructor & Destructor Documentation

pages() [1/2]

tools::hdf5::pages::pages ( std::ostream &  a_out, hid_t  a_group, const std::string &  a_name, const std::string &  a_form, bool  a_write, unsigned int  a_compress  )

inline

Definition at line 30 of file pages.

  :m_out(a_out),m_name(a_name),m_form(a_form)
  //,m_type(0),m_size(0)
  ,m_group(-1),m_dataset(-1),m_write(a_write),m_compress(a_compress),m_entries(0),m_pos(0){
#ifdef TOOLS_MEM
    tools::mem::increment(s_class().c_str());
#endif
    if(m_write) {
      m_group = tools_H5Gcreate(a_group,m_name.c_str(),0);
      if(m_group<0) {
        m_out << "pages::pages : can't create group for column " << m_name << "." << std::endl;
        m_group = -1;
    return;
      }
      if(!write_atb(m_group,"class",s_class())) {
        m_out << "pages::pages : write_atb(class) failed." << std::endl;
        ::H5Gclose(m_group);
        m_group = -1;
        return;
      }
      int v = 1;
      if (!write_scalar_atb<int>(m_group,"version",v)) {
        m_out << "pages::pages : write_scalar_atb(version) failed." << std::endl;
        ::H5Gclose(m_group);
        m_group = -1;
        return;
      }
    } else {
      m_group = tools_H5Gopen(a_group,m_name.c_str());
      if(m_group<0) {
        m_out << "pages::pages : can't open group for column " << m_name << "." << std::endl;
        m_group = -1;
    return;
      }
      if(!read_scalar<tools::uint64>(m_group,s_entries(),m_entries)) {
        m_out << "pages::pages : read_scalar(entries) failed." << std::endl;
        ::H5Gclose(m_group);
        m_group = -1;
    return;
      }
    }
  }

~pages()

virtual tools::hdf5::pages::~pages ( )

inlinevirtual

Definition at line 74 of file pages.

                  {
    if(m_write) {
      if(!write_scalar<tools::uint64>(m_group,s_entries(),m_entries)) {
        m_out << "pages::~pages : write_scalar(entries) failed." << std::endl;
      }
      if(m_dataset>=0) ::H5Dclose(m_dataset);
    }
    ::H5Gclose(m_group);
#ifdef TOOLS_MEM
    tools::mem::decrement(s_class().c_str());
#endif
  }

pages() [2/2]

tools::hdf5::pages::pages ( const pages &  a_from )

inlineprotected

Definition at line 87 of file pages.

                            :m_out(a_from.m_out){
#ifdef TOOLS_MEM
    tools::mem::increment(s_class().c_str());
#endif
  }

Member Function Documentation

entries()

tools::uint64 tools::hdf5::pages::entries ( ) const

inline

Definition at line 100 of file pages.

{return m_entries;}

form()

const std::string& tools::hdf5::pages::form ( ) const

inline

Definition at line 97 of file pages.

{return m_form;}

is_valid()

bool tools::hdf5::pages::is_valid ( ) const

inline

Definition at line 94 of file pages.

{return m_group<0?false:true;}

name()

const std::string& tools::hdf5::pages::name ( ) const

inline

Definition at line 96 of file pages.

{return m_name;}

operator=()

pages& tools::hdf5::pages::operator= ( const pages &  )

inlineprotected

Definition at line 92 of file pages.

{return *this;}

pos()

tools::uint64 tools::hdf5::pages::pos ( ) const

inline

Definition at line 101 of file pages.

{return m_pos;}

read_page()

template<class TYPE >

bool tools::hdf5::pages::read_page ( size_t  a_size, TYPE *  a_array  )

inline

Definition at line 128 of file pages.

                                              {
    //it is assumed that a_array can contain a_size*sizeof(TYPE) bytes.
    unsigned int _size = a_size;
    unsigned int n = 0;
    TYPE* array = 0;
    if(!read_sub_array<TYPE>(m_group,s_pages(),(unsigned int)m_pos,(unsigned int)_size,n,array)) {
      m_out << "pages::read_page : read_sub_array<TYPE>() failed." << std::endl;
      return false;
    }
    if(n!=_size) {
      m_out << "pages::read_page : size mismatch. Requested " << _size << ", got "<< n << "." << std::endl;
      delete [] array;
      return false;
    }
 
   {TYPE* rpos = (TYPE*)array;
    TYPE* wpos = (TYPE*)a_array;
    for(size_t i=0;i<n;i++,rpos++,wpos++) *wpos = *rpos;
    for(size_t i=n;i<_size;i++,rpos++,wpos++) *wpos = TYPE();}
 
    delete [] array;
 
    m_pos += n;
    return true;
  }

read_string()

bool tools::hdf5::pages::read_string ( std::string &  a_string )

inline

Definition at line 215 of file pages.

                                        {
    if(!read_sub_string(m_group,s_pages(),(unsigned int)m_pos,a_string)) {
      m_out << "pages::read_string : read_sub_string() failed." << std::endl;
      a_string.clear();
      return false;
    }
    m_pos++;
    m_entries++;
    return true;
  }

read_vlen()

template<class TYPE >

bool tools::hdf5::pages::read_vlen ( size_t &  a_size, TYPE *&  a_array  )

inline

Definition at line 178 of file pages.

                                                {
    //it is assumed that a_array can contain a_size*sizeof(TYPE) bytes.
    unsigned int sz;
    if(!read_sub_vlen<TYPE>(m_group,s_pages(),(unsigned int)m_pos,sz,a_array)) {
      m_out << "pages::read_vlen : read_sub_vlen<TYPE>() failed." << std::endl;
      a_size = 0;
      a_array = 0;
      return false;
    }
    a_size = sz;
    m_pos++;
    m_entries++;
    return true;
  }

reset_pos()

void tools::hdf5::pages::reset_pos ( )

inline

Definition at line 102 of file pages.

{m_pos = 0;}

write_page()

template<class TYPE >

bool tools::hdf5::pages::write_page ( size_t  a_size, const TYPE *  a_array  )

inline

Definition at line 105 of file pages.

                                                     {
    if(!m_pos) {
      if(!write_array<TYPE>(m_group,s_pages(),a_size,a_array,a_size?a_size:32,m_compress)) {
        m_out << "pages::write_page : write_array<TYPE>() failed. Pos " << m_pos << std::endl;
        return false;
      }
      m_dataset = tools_H5Dopen(m_group,s_pages().c_str());
      if(m_dataset<0) {
        m_out << "pages::write_page : H5Dopen failed. Pos " << m_pos << std::endl;
        return false;
      }
    } else {
      if(!write_append_array_dataset<TYPE>(m_dataset,a_size,a_array)) {
        m_out << "pages::write_page : write_append_array_dataset<TYPE>() failed. Pos " << m_pos << std::endl;
        return false;
      }
    }
    m_pos += a_size;
    m_entries = m_pos;
    return true;
  }

write_string()

bool tools::hdf5::pages::write_string ( const std::string &  a_string )

inline

Definition at line 193 of file pages.

                                               {
    if(!m_pos) {
      if(!hdf5::write_string_dataset(m_group,s_pages(),a_string,128,m_compress)) { //32=>enforce extendable.
        m_out << "pages::write_string : hdf5::write_string() failed. Pos " << m_pos << std::endl;
        return false;
      }
      m_dataset = tools_H5Dopen(m_group,s_pages().c_str());
      if(m_dataset<0) {
        m_out << "pages::write_string : H5Dopen failed. Pos " << m_pos << std::endl;
        return false;
      }
    } else {
      if(!write_append_string_dataset(m_dataset,a_string)) {
        m_out << "pages::write_string : write_append_string_dataset() failed. Pos " << m_pos << std::endl;
        return false;
      }
    }
    m_pos++;
    m_entries++;
    return true;
  }

write_vlen()

template<class TYPE >

bool tools::hdf5::pages::write_vlen ( size_t  a_size, const TYPE *  a_array  )

inline

Definition at line 155 of file pages.

                                                     {
    if(!m_pos) {
      if(!hdf5::write_vlen<TYPE>(m_group,s_pages(),a_size,a_array,a_size?a_size:32,m_compress)) {
        m_out << "pages::write_vlen : write_vlen<TYPE>() failed. Pos " << m_pos << std::endl;
        return false;
      }
      m_dataset = tools_H5Dopen(m_group,s_pages().c_str());
      if(m_dataset<0) {
        m_out << "pages::write_vlen : H5Dopen failed. Pos " << m_pos << std::endl;
        return false;
      }
    } else {
      if(!write_append_vlen_dataset<TYPE>(m_dataset,a_size,a_array)) {
        m_out << "pages::write_vlen : write_append_vlen_dataset<TYPE>() failed. Pos " << m_pos << std::endl;
        return false;
      }
    }
    m_pos++;
    m_entries++;
    return true;
  }

Member Data Documentation

m_compress

unsigned int tools::hdf5::pages::m_compress

protected

Definition at line 312 of file pages.

m_dataset

hid_t tools::hdf5::pages::m_dataset

protected

Definition at line 310 of file pages.

m_entries

tools::uint64 tools::hdf5::pages::m_entries

protected

Definition at line 313 of file pages.

m_form

std::string tools::hdf5::pages::m_form

protected

Definition at line 306 of file pages.

m_group

hid_t tools::hdf5::pages::m_group

protected

Definition at line 309 of file pages.

m_name

std::string tools::hdf5::pages::m_name

protected

Definition at line 305 of file pages.

m_out

std::ostream& tools::hdf5::pages::m_out

protected

Definition at line 304 of file pages.

m_pos

tools::uint64 tools::hdf5::pages::m_pos

protected

Definition at line 314 of file pages.

m_write

bool tools::hdf5::pages::m_write

protected

Definition at line 311 of file pages.

---

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

• /Users/barrand/private/dev/softinex/g4tools/g4tools/tools/hdf5/pages