echelon::hdf5::object_reference Class Reference

A reference to an HDF5 object. More...

#include <object_reference.hpp>

Public Member Functions
	object_reference ()
	Creates a null reference.
	object_reference (const object &referenced_object)
	Creates a reference to a given object. More...
object	operator* () const
	Dereferences this reference. More...
	operator bool () const
	Tests, if the reference is non-null. More...
const hdf5::precursor::object_reference &	raw_ref () const
	The underlying low-level reference.

Detailed Description

A reference to an HDF5 object.

Note

Note that the concept of a HDF5 reference has nothing to do with C++ references. Since a HDF5 reference has a null state, it resembles a C++ pointer without pointer arithmetic and correspondingly it has a similar interface.

Constructor & Destructor Documentation

echelon::hdf5::object_reference::object_reference ( const object &  referenced_object )

explicit

Creates a reference to a given object.

Parameters

referenced_object

referenced object

Member Function Documentation

echelon::hdf5::object_reference::operator bool ( ) const

explicit

Tests, if the reference is non-null.

Returns

true, if the reference is non-null and false otherwise

object echelon::hdf5::object_reference::operator*

(

)

const

Dereferences this reference.

Returns

handle to the referenced object

---

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

• hdf5/object_reference.hpp
• hdf5/object_reference.cpp