hdf_path Class Reference

Collaboration diagram for hdf_path:

Public Member Functions
	hdf_path ()
	Constructs an empty path. More...
	hdf_path (std::string_view p)
	Constructs a path whose pathname is the same as that of p. More...
hdf_path &	append (std::string_view p)
	Appends elements to the path with a directory separator. More...
hdf_path &	append (const hdf_path &p)
hdf_path &	concat (std::string_view p)
	Concatenates two paths without introducing a directory separator. More...
hdf_path &	concat (const hdf_path &p)
hdf_path &	operator/= (std::string_view p)
	Appends elements to the path with a directory separator. More...
hdf_path &	operator/= (const hdf_path &p)
hdf_path &	operator+= (std::string_view p)
	Concatenates two paths without introducing a directory separator. More...
hdf_path &	operator+= (const hdf_path &p)
hdf_path &	remove_subgroup ()
	Remove last subgroup in path. More...
hdf_path &	replace_subgroup (std::string_view p)
	Replace the last subgroup in path. More...
const std::string &	string () const
	Return std::string for use with HDF5. More...
bool	has_root_directory () const
	Does the path absolute (true) or relative to the current group in hdf_archive (false)? More...

Private Attributes
std::string	path_

Detailed Description

Definition at line 22 of file hdf_path.h.

Constructor & Destructor Documentation

hdf_path() [1/2]

hdf_path ( )

default

Constructs an empty path.

Referenced by hdf_path::append().

hdf_path() [2/2]

hdf_path

(

std::string_view

p

)

Constructs a path whose pathname is the same as that of p.

Parameters

p

pathname

Definition at line 18 of file hdf_path.cpp.

: path_{p} {};

Member Function Documentation

append() [1/2]

hdf_path & append

(

std::string_view

p

)

Appends elements to the path with a directory separator.

Parameters

p

pathname

Definition at line 20 of file hdf_path.cpp.

References hdf_path::hdf_path().

Referenced by hdf_path::operator/=(), hdf_path::replace_subgroup(), and TEST_CASE().

{ return append(hdf_path(p)); }

append() [2/2]

hdf_path & append

(

const hdf_path &

p

)

Definition at line 22 of file hdf_path.cpp.

References hdf_path::concat(), hdf_path::has_root_directory(), and hdf_path::path_.

{
  if (p.has_root_directory())
    path_.clear();
  else if (!path_.empty() && path_.back() != '/')
    path_.push_back('/');
  return concat(p);
}

concat() [1/2]

hdf_path & concat

(

std::string_view

p

)

Concatenates two paths without introducing a directory separator.

Parameters

p

pathname

Returns

*this

Definition at line 31 of file hdf_path.cpp.

References hdf_path::path_.

Referenced by hdf_path::append(), hdf_path::concat(), hdf_path::operator+=(), and TEST_CASE().

{
  path_.append(p);
  return *this;
}

concat() [2/2]

hdf_path & concat

(

const hdf_path &

p

)

Definition at line 37 of file hdf_path.cpp.

References hdf_path::concat(), and hdf_path::string().

{ return concat(p.string()); }

has_root_directory()

bool has_root_directory

(

)

const

Does the path absolute (true) or relative to the current group in hdf_archive (false)?

Returns

does the path begin with '/'

Definition at line 73 of file hdf_path.cpp.

References hdf_path::path_.

Referenced by hdf_path::append(), hdf_path::remove_subgroup(), and TEST_CASE().

{ return (!path_.empty() && path_[0] == '/'); }

operator+=() [1/2]

hdf_path & operator+=

(

std::string_view

p

)

Concatenates two paths without introducing a directory separator.

Parameters

p

pathname

Returns

*this

Definition at line 43 of file hdf_path.cpp.

References hdf_path::concat().

{ return concat(p); }

operator+=() [2/2]

hdf_path & operator+=

(

const hdf_path &

p

)

Definition at line 45 of file hdf_path.cpp.

References hdf_path::concat().

{ return concat(p); }

operator/=() [1/2]

hdf_path & operator/=

(

std::string_view

p

)

Appends elements to the path with a directory separator.

Parameters

p

pathname

Returns

*this

Definition at line 39 of file hdf_path.cpp.

References hdf_path::append().

{ return append(p); }

operator/=() [2/2]

hdf_path & operator/=

(

const hdf_path &

p

)

Definition at line 41 of file hdf_path.cpp.

References hdf_path::append().

{ return append(p); }

remove_subgroup()

hdf_path & remove_subgroup

(

)

Remove last subgroup in path.

Returns

*this

Definition at line 47 of file hdf_path.cpp.

References hdf_path::has_root_directory(), and hdf_path::path_.

Referenced by hdf_path::replace_subgroup(), and TEST_CASE().

{
  // if path == '/' do nothing
  if (path_.size() == 1 && has_root_directory())
    return *this;

  auto pos = path_.find_last_of('/');

  // don't eliminate root group
  if (pos == 0 && has_root_directory())
    pos++;

  // if path is relative and only one group is present, clear the string
  if (pos == std::string::npos)
    path_.clear();
  else
    path_.erase(pos, std::string::npos);
  return *this;
}

replace_subgroup()

hdf_path & replace_subgroup

(

std::string_view

p

)

Replace the last subgroup in path.

Parameters

p	subgroup to replace last in path

Returns

*this

Definition at line 67 of file hdf_path.cpp.

References hdf_path::append(), and hdf_path::remove_subgroup().

Referenced by TEST_CASE().

{
  remove_subgroup();
  return append(p);
}

string()

const std::string& string ( ) const

inline

Return std::string for use with HDF5.

Returns

path as a std::string

Definition at line 67 of file hdf_path.h.

References hdf_path::path_.

Referenced by hdf_path::concat(), hdf_archive::push(), TEST_CASE(), and OneBodyDensityMatricesTests< T >::testRegisterAndWrite().

{ return path_; }

Member Data Documentation

path_

std::string path_

private

Definition at line 74 of file hdf_path.h.

Referenced by hdf_path::append(), hdf_path::concat(), hdf_path::has_root_directory(), hdf_path::remove_subgroup(), and hdf_path::string().

---

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

• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/io/hdf/hdf_path.h
• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/io/hdf/hdf_path.cpp