OksSystem::Path Class Reference

Path list handling mechanism. More...

#include <Path.hpp>

Public Member Functions
	Path ()
	Path (const Path &other)
	Path (const std::string &path_list)
	contructor with a string
	operator std::string () const
void	add (const OksSystem::File &dir)
	add a directory to the path
OksSystem::File	which (const std::string &name) const
	resolve a name in the path
void	write_to (std::ostream &stream) const
	displays the path in a stream
std::string	to_string () const
	converts path into a string

Static Public Attributes
static const char	PATH_SEPARATOR = ':'
	char used as separator in strings (semi-colon)

Protected Member Functions
void	parse_path_list (const std::string &path_list)
	parse string containing path

Protected Attributes
File::file_list_t	m_directories
	list of directories

Detailed Description

Path list handling mechanism.

This class represents an ordered set of directories. The main goal of this class is to proved tools to find a file in this set.

Author

Matthias Wiesmann

Version

1.0

Definition at line 25 of file Path.hpp.

Constructor & Destructor Documentation

Path() [1/3]

OksSystem::Path::Path

(

)

Empty constructor

Definition at line 20 of file Path.cpp.

{} 

Path() [2/3]

OksSystem::Path::Path

(

const Path &

other

)

Copy constructor

Parameters

other

the original object

Definition at line 26 of file Path.cpp.

                                     {
    m_directories = other.m_directories;
}

Path() [3/3]

OksSystem::Path::Path

(

const std::string &

path_list

)

contructor with a string

Constructor

Parameters

path_list

string containing the list of directories

Definition at line 34 of file Path.cpp.

                                              {
    parse_path_list(path_list); 
} // Path

Member Function Documentation

add()

void OksSystem::Path::add

(

const OksSystem::File &

dir

)

add a directory to the path

Add a directory to the path

Parameters

dir	the file to add

Definition at line 48 of file Path.cpp.

                                                {
    m_directories.push_back(dir); 
} // add

operator std::string()

OksSystem::Path::operator std::string

(

)

const

Definition at line 38 of file Path.cpp.

                                        {
    return to_string(); 
} // operator std::string()

parse_path_list()

void OksSystem::Path::parse_path_list ( const std::string & path_list )

protected

parse string containing path

Parses a string containing the path separated by semi-colons.

Parameters

path_list

the path

Definition at line 57 of file Path.cpp.

                                                               {
    std::string rest = path_list;
    while(! rest.empty()) {
    std::string::size_type semi_colon = rest.find(PATH_SEPARATOR);
    std::string name;
    
    if(semi_colon==std::string::npos) {
        name = rest;
        rest.clear(); 
    } else {
        name = rest.substr(0,semi_colon);
        rest = rest.substr(semi_colon+1); 
    }
 
    if(!name.empty()) {
      const OksSystem::File directory(name); 
      add(directory);
    }
    } // while
} // parse_path_list

to_string()

std::string OksSystem::Path::to_string

(

)

const

converts path into a string

Prints the path into a string

Returns

string containing description

See also

write_to()

Definition at line 99 of file Path.cpp.

                                         {
    std::ostringstream stream;
    write_to(stream);
    return stream.str(); 
} // to_string

which()

OksSystem::File OksSystem::Path::which

(

const std::string &

name

)

const

resolve a name in the path

Finds the first occurence of a named file in the path.

Parameters

name	the name of the file to search for

Returns

a File object representing the file

Exceptions

EntityNotFoundIssue

if no matching file is found

Definition at line 111 of file Path.cpp.

                                                              {
    for(File::file_list_t::const_iterator pos = m_directories.begin(); pos!=m_directories.end();pos++) {
    File child = pos->child(name);
    if (child.exists()) return child;
    } // for
    throw OksSystem::NotFoundIssue( ERS_HERE, name.c_str() ); 
} // which 

write_to()

void OksSystem::Path::write_to

(

std::ostream &

stream

)

const

displays the path in a stream

Prints the path into a stream

Parameters

stream

destination stream

Definition at line 82 of file Path.cpp.

                                                     {
    bool first = true;
    for(File::file_list_t::const_iterator pos = m_directories.begin(); pos!=m_directories.end();pos++) {
    if (!first) {
        stream << PATH_SEPARATOR;
    } else {
        first = false;
    } 
    stream  << pos->full_name();
    } // for
} // write_to

Member Data Documentation

m_directories

File::file_list_t OksSystem::Path::m_directories

protected

list of directories

Definition at line 28 of file Path.hpp.

PATH_SEPARATOR

const char OksSystem::Path::PATH_SEPARATOR = ':'

static

char used as separator in strings (semi-colon)

Definition at line 31 of file Path.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/okssystem/include/okssystem/Path.hpp
• /github/workspace/dunedaq/sourcecode/okssystem/src/Path.cpp