Open
Graph Drawing
Framework

 v. snapshot-2018-03-28
 

Files and Directories

Provides functionality for easy file and directory handling. More...

Classes

class  ogdf::GraphIO
 Utility class providing graph I/O in various exchange formats. More...
 

Enumerations

enum  ogdf::FileType { ogdf::FileType::Entry, ogdf::FileType::File, ogdf::FileType::Directory }
 The type of an entry in a directory. More...
 

Functions

bool ogdf::changeDir (const char *dirName)
 Changes current directory to dirName; returns true if successful. More...
 
void ogdf::getEntries (const char *dirName, List< string > &entries, const char *pattern="*")
 Returns in entries the list of all entries contained in directory dirName. More...
 
void ogdf::getEntries (const char *dirName, FileType t, List< string > &entries, const char *pattern="*")
 Returns in entries the list of all entries of type t contained in directory dirName. More...
 
void ogdf::getEntriesAppend (const char *dirName, List< string > &entries, const char *pattern="*")
 Appends to entries the list of all entries contained in directory dirName. More...
 
void ogdf::getEntriesAppend (const char *dirName, FileType t, List< string > &entries, const char *pattern="*")
 Appends to entries the list of all entries of type t contained in directory dirName. More...
 
void ogdf::getFiles (const char *dirName, List< string > &files, const char *pattern="*")
 Returns in files the list of files in directory dirName. More...
 
void ogdf::getFilesAppend (const char *dirName, List< string > &files, const char *pattern="*")
 Appends to files the list of files in directory dirName. More...
 
void ogdf::getSubdirs (const char *dirName, List< string > &subdirs, const char *pattern="*")
 Returns in subdirs the list of directories contained in directory dirName. More...
 
void ogdf::getSubdirsAppend (const char *dirName, List< string > &subdirs, const char *pattern="*")
 Appends to subdirs the list of directories contained in directory dirName. More...
 
bool ogdf::isDirectory (const char *fileName)
 Returns true iff fileName is a directory. More...
 
bool ogdf::isFile (const char *fileName)
 Returns true iff fileName is a regular file (not a directory). More...
 

Detailed Description

Provides functionality for easy file and directory handling.

Enumeration Type Documentation

◆ FileType

enum ogdf::FileType
strong

The type of an entry in a directory.

Enumerator
Entry 

file or directory

File 

file

Directory 

directory

Definition at line 44 of file filesystem.h.

Function Documentation

◆ changeDir()

bool ogdf::changeDir ( const char *  dirName)

Changes current directory to dirName; returns true if successful.

Deprecated:
"Please use another library (or C++17) for filesystem functions."

◆ getEntries() [1/2]

void ogdf::getEntries ( const char *  dirName,
List< string > &  entries,
const char *  pattern = "*" 
)

Returns in entries the list of all entries contained in directory dirName.

Entries may be files or directories. The optional argument pattern can be used to filter files.

Precondition
dirName is a directory
Deprecated:
"Please use another library (or C++17) for filesystem functions."

◆ getEntries() [2/2]

void ogdf::getEntries ( const char *  dirName,
FileType  t,
List< string > &  entries,
const char *  pattern = "*" 
)

Returns in entries the list of all entries of type t contained in directory dirName.

The optional argument pattern can be used to filter files.

Precondition
dirName is a directory
Deprecated:
"Please use another library (or C++17) for filesystem functions."

◆ getEntriesAppend() [1/2]

void ogdf::getEntriesAppend ( const char *  dirName,
List< string > &  entries,
const char *  pattern = "*" 
)

Appends to entries the list of all entries contained in directory dirName.

Entries may be files or directories. The optional argument pattern can be used to filter files.

Precondition
dirName is a directory
Deprecated:
"Please use another library (or C++17) for filesystem functions."

◆ getEntriesAppend() [2/2]

void ogdf::getEntriesAppend ( const char *  dirName,
FileType  t,
List< string > &  entries,
const char *  pattern = "*" 
)

Appends to entries the list of all entries of type t contained in directory dirName.

The optional argument pattern can be used to filter files.

Precondition
dirName is a directory
Deprecated:
"Please use another library (or C++17) for filesystem functions."

◆ getFiles()

void ogdf::getFiles ( const char *  dirName,
List< string > &  files,
const char *  pattern = "*" 
)

Returns in files the list of files in directory dirName.

The optional argument pattern can be used to filter files.

Precondition
dirName is a directory
Deprecated:
"Please use another library (or C++17) for filesystem functions."

◆ getFilesAppend()

void ogdf::getFilesAppend ( const char *  dirName,
List< string > &  files,
const char *  pattern = "*" 
)

Appends to files the list of files in directory dirName.

The optional argument pattern can be used to filter files.

Precondition
dirName is a directory
Deprecated:
"Please use another library (or C++17) for filesystem functions."

◆ getSubdirs()

void ogdf::getSubdirs ( const char *  dirName,
List< string > &  subdirs,
const char *  pattern = "*" 
)

Returns in subdirs the list of directories contained in directory dirName.

The optional argument pattern can be used to filter files.

Precondition
p dirName is a directory
Deprecated:
"Please use another library (or C++17) for filesystem functions."

◆ getSubdirsAppend()

void ogdf::getSubdirsAppend ( const char *  dirName,
List< string > &  subdirs,
const char *  pattern = "*" 
)

Appends to subdirs the list of directories contained in directory dirName.

The optional argument pattern can be used to filter files.

Precondition
dirName is a directory
Deprecated:
"Please use another library (or C++17) for filesystem functions."

◆ isDirectory()

bool ogdf::isDirectory ( const char *  fileName)

Returns true iff fileName is a directory.

Deprecated:
"Please use another library (or C++17) for filesystem functions."

◆ isFile()

bool ogdf::isFile ( const char *  fileName)

Returns true iff fileName is a regular file (not a directory).

Deprecated:
"Please use another library (or C++17) for filesystem functions."