h5cpp  0.3.3
A modern C++ wrapper for the HDF5 C library
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
hdf5::property::CopyFlags Class Reference

encapsulate copy flags More...

#include <object_copy.hpp>

Public Member Functions

 CopyFlags () noexcept
 default constructor More...
 
 CopyFlags (unsigned flags) noexcept
 constructor More...
 
 CopyFlags (const CopyFlags &flags)=default
 copy constructor More...
 
CopyFlagsoperator|= (const CopyFlag &flag) noexcept
 unary logical or operator More...
 
CopyFlagsoperator|= (const CopyFlags &flags) noexcept
 unary logical or operator More...
 
 operator unsigned () const noexcept
 allow for explicit conversion to unsigned More...
 
bool shallow_hierarchy () const noexcept
 get state of the shallow hierarchy flag More...
 
void shallow_hierarchy (bool flag) noexcept
 set the state of the shallo hierarchy flag More...
 
bool expand_soft_links () const noexcept
 get the state of the expand soft links flag More...
 
void expand_soft_links (bool flag) noexcept
 set the state of the expand soft links flag More...
 
bool expand_external_links () const noexcept
 get the state of the expand external links flag More...
 
void expand_external_links (bool flag) noexcept
 set the state of the expand external links flag More...
 
bool expand_references () const noexcept
 get the state of the expand reference flag More...
 
void expand_references (bool flag) noexcept
 set the state of the expand reference flag More...
 
bool without_attributes () const noexcept
 get the state of the without attribute flag More...
 
void without_attributes (bool flag) noexcept
 set the state of the without attribute flag More...
 
bool merge_committed_types () const noexcept
 get the state of the merge committed attribute flag More...
 
void merge_committed_types (bool flag) noexcept
 

Detailed Description

This class encapsulates copy flags and provides easy access to the flags without using logical operators.

Constructor & Destructor Documentation

◆ CopyFlags() [1/3]

hdf5::property::CopyFlags::CopyFlags ( )
noexcept

Setup the flags with 0.

◆ CopyFlags() [2/3]

hdf5::property::CopyFlags::CopyFlags ( unsigned  flags)
explicitnoexcept

Construct a CopyFlags instance from a raw unsigned value.

Parameters
flagsraw flags value

◆ CopyFlags() [3/3]

hdf5::property::CopyFlags::CopyFlags ( const CopyFlags flags)
default

Use default implementation for this.

Member Function Documentation

◆ expand_external_links() [1/2]

bool hdf5::property::CopyFlags::expand_external_links ( ) const
noexcept

◆ expand_external_links() [2/2]

void hdf5::property::CopyFlags::expand_external_links ( bool  flag)
noexcept

◆ expand_references() [1/2]

bool hdf5::property::CopyFlags::expand_references ( ) const
noexcept

◆ expand_references() [2/2]

void hdf5::property::CopyFlags::expand_references ( bool  flag)
noexcept

◆ expand_soft_links() [1/2]

bool hdf5::property::CopyFlags::expand_soft_links ( ) const
noexcept

◆ expand_soft_links() [2/2]

void hdf5::property::CopyFlags::expand_soft_links ( bool  flag)
noexcept

◆ merge_committed_types() [1/2]

bool hdf5::property::CopyFlags::merge_committed_types ( ) const
noexcept

◆ merge_committed_types() [2/2]

void hdf5::property::CopyFlags::merge_committed_types ( bool  flag)
noexcept

set the state of the merge comitted attribute flag

◆ operator unsigned()

hdf5::property::CopyFlags::operator unsigned ( ) const
inlineexplicitnoexcept

◆ operator|=() [1/2]

CopyFlags& hdf5::property::CopyFlags::operator|= ( const CopyFlag flag)
noexcept

◆ operator|=() [2/2]

CopyFlags& hdf5::property::CopyFlags::operator|= ( const CopyFlags flags)
noexcept

◆ shallow_hierarchy() [1/2]

bool hdf5::property::CopyFlags::shallow_hierarchy ( ) const
noexcept

◆ shallow_hierarchy() [2/2]

void hdf5::property::CopyFlags::shallow_hierarchy ( bool  flag)
noexcept

◆ without_attributes() [1/2]

bool hdf5::property::CopyFlags::without_attributes ( ) const
noexcept

◆ without_attributes() [2/2]

void hdf5::property::CopyFlags::without_attributes ( bool  flag)
noexcept

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