PUMA Library Reference Manual
Puma::PathInfo Class Reference

#include <Puma/PathInfo.h>

Description

A path information object consists of a source and optionally its destination path. For comparison purposes the canonical version of the source path can be stored.

Public Member Functions

 PathInfo ()
 Contruct a new empty path information object. More...
 
 PathInfo (const PathInfo &other)
 Copy-constructor. More...
 
 ~PathInfo ()
 Destroy this object and free the stored paths. More...
 
PathInfooperator= (const PathInfo &other)
 Assign another path information object to this one. More...
 
void src (const char *path)
 Set the source path. More...
 
void srcCanonical (const char *path)
 Set the canonical variant of the source path. More...
 
void dest (const char *path)
 Set the destination path. More...
 
const char * src () const
 Get the source path. More...
 
const char * srcCanonical () const
 Get the canonical variant of the source path. More...
 
const char * dest () const
 Get the destination path. More...
 

Constructor & Destructor Documentation

◆ PathInfo() [1/2]

Puma::PathInfo::PathInfo ( )
inline

Contruct a new empty path information object.

◆ PathInfo() [2/2]

Puma::PathInfo::PathInfo ( const PathInfo other)

Copy-constructor.

Parameters
otherThe other path information object to copy.

◆ ~PathInfo()

Puma::PathInfo::~PathInfo ( )

Destroy this object and free the stored paths.

Member Function Documentation

◆ dest() [1/2]

const char* Puma::PathInfo::dest ( ) const
inline

Get the destination path.

Returns
The destination path.

◆ dest() [2/2]

void Puma::PathInfo::dest ( const char *  path)

Set the destination path.

◆ operator=()

PathInfo& Puma::PathInfo::operator= ( const PathInfo other)

Assign another path information object to this one.

Parameters
otherThe other path information object to copy.
Returns
A reference to this object.

◆ src() [1/2]

const char* Puma::PathInfo::src ( ) const
inline

Get the source path.

Returns
The source path.

◆ src() [2/2]

void Puma::PathInfo::src ( const char *  path)

Set the source path.

◆ srcCanonical() [1/2]

const char* Puma::PathInfo::srcCanonical ( ) const
inline

Get the canonical variant of the source path.

Returns
The canonical source path.

◆ srcCanonical() [2/2]

void Puma::PathInfo::srcCanonical ( const char *  path)

Set the canonical variant of the source path.