#include <node.hpp>

Inheritance diagram for hdf5::node::Node:

[legend]

Collaboration diagram for hdf5::node::Node:

Public Member Functions
	Node (ObjectHandle &&handle, const Link &link)
	constructor More...

	Node ()
	default constructor More...

	Node (const Node &)
	copy constructor More...

Node &	operator= (const Node &node)
	copy assignment More...

virtual	~Node ()
	destructor More...

NodeType	type () const
	return the node type More...

ObjectId	id () const
	get unique ID More...

	operator hid_t () const

bool	is_valid () const
	true if an object is valid More...

void	close ()
	close the node More...

const Link &	link () const
	return link to object More...

Public Attributes
attribute::AttributeManager	attributes
	access to the attribute manager More...

Constructor & Destructor Documentation

◆ Node() [1/3]

hdf5::node::Node::Node	(	ObjectHandle &&	handle,
		const Link &	link
	)

Parameters

handle	rvalue reference to a handle instance
link	the path to the node

◆ Node() [2/3]

hdf5::node::Node::Node ( )

In order to store objects in a container like a std::vector they must be default constructible. A default constructed object cannot be used for anything. Use the is_valid() function to check whether or not a Node instance refers to a valid HDF5 object or not.

See also: is_valid()

◆ Node() [3/3]

hdf5::node::Node::Node ( const Node & )

We use the default implementation

◆ ~Node()

virtual hdf5::node::Node::~Node ( )

virtual

Must be virtual as we want to derive child classes from here.

Member Function Documentation

◆ close()

void hdf5::node::Node::close ( )

Closes the node object and renders the node instance as invalid.

◆ id()

ObjectId hdf5::node::Node::id ( ) const

Return the unique ID of an object. This identifier must not be confused with an HDF5 handle (called hid_t in the C-API. This ID identifies an object uniquely within a program context.

Returns: instance of ObjectId

◆ is_valid()

bool hdf5::node::Node::is_valid ( ) const

See also: Node()

◆ link()

const Link& hdf5::node::Node::link ( ) const

This returns the link which was used to access the node.

◆ operator hid_t()

hdf5::node::Node::operator hid_t ( ) const

inlineexplicit

◆ operator=()

Node& hdf5::node::Node::operator= ( const Node & node )

◆ type()

NodeType hdf5::node::Node::type ( ) const

Member Data Documentation

◆ attributes

attribute::AttributeManager hdf5::node::Node::attributes

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

/home/jenkins/h5cpp/src/h5cpp/node/node.hpp

Public Member Functions

Public Attributes