PUMA Library Reference Manual
Puma::ProjectFile Class Reference

#include <Puma/ProjectFile.h>

Description

Project file abstraction used to store all filenames relevant for a specific file.

Public Types

typedef std::map< std::string, ProjectFileMap
 Project file's name to ProjectFile map type. More...
 
typedef Map::value_type MapPair
 Project file's name to ProjectFile map pair type. More...
 
typedef Map::const_iterator MapConstIter
 Project file's name to ProjectFile map constant iterator type. More...
 

Public Member Functions

 ProjectFile (const Filename &filename)
 Construct a project file from the given filename. More...
 
 ProjectFile (const Filename &filename, const Filename &destPath)
 Construct a project file from the given filename and destination path. More...
 
void dest (const Filename &destPath)
 Set the project file destination path. More...
 
Filename name () const
 Get the project file's name. More...
 
Filename dest () const
 Get the project file's destination path. More...
 

Member Typedef Documentation

◆ Map

typedef std::map<std::string, ProjectFile> Puma::ProjectFile::Map

Project file's name to ProjectFile map type.

◆ MapConstIter

typedef Map::const_iterator Puma::ProjectFile::MapConstIter

Project file's name to ProjectFile map constant iterator type.

◆ MapPair

typedef Map::value_type Puma::ProjectFile::MapPair

Project file's name to ProjectFile map pair type.

Constructor & Destructor Documentation

◆ ProjectFile() [1/2]

Puma::ProjectFile::ProjectFile ( const Filename filename)
inline

Construct a project file from the given filename.

Parameters
filenameThe filename.

◆ ProjectFile() [2/2]

Puma::ProjectFile::ProjectFile ( const Filename filename,
const Filename destPath 
)
inline

Construct a project file from the given filename and destination path.

Parameters
filenameThe filename.
destPathThe destination path.

Member Function Documentation

◆ dest() [1/2]

Filename Puma::ProjectFile::dest ( ) const
inline

Get the project file's destination path.

Returns
The destination path information.

◆ dest() [2/2]

void Puma::ProjectFile::dest ( const Filename destPath)
inline

Set the project file destination path.

Parameters
destPathThe destination path.

◆ name()

Filename Puma::ProjectFile::name ( ) const
inline

Get the project file's name.

Returns
The filename information.