Disk ARchive  2.4.2
Public Member Functions
libdar::mask Class Reference

the generic class, parent of all masks More...

#include <mask.hpp>

Inherited by libdar::bool_mask, libdar::et_mask, libdar::exclude_dir_mask, libdar::mask_list, libdar::not_mask, libdar::regular_mask, libdar::same_path_mask, libdar::simple_mask, and libdar::simple_path_mask.

List of all members.

Public Member Functions

virtual bool is_covered (const std::string &expression) const =0
 check wether the given string is covered by the mask
virtual bool is_covered (const path &chemin) const
 check whether the given path is covered by the mask
virtual maskclone () const =0

Detailed Description

the generic class, parent of all masks

this is a pure virtual class that is used in API call any of the following mask classes inherit from this class


Member Function Documentation

virtual mask* libdar::mask::clone ( ) const [pure virtual]

this is to be able to copy a mask without knowing its exact class and without loosing its specialized data

Implemented in libdar::exclude_dir_mask, libdar::same_path_mask, libdar::simple_path_mask, libdar::ou_mask, libdar::et_mask, libdar::not_mask, libdar::regular_mask, libdar::simple_mask, libdar::bool_mask, and libdar::mask_list.

virtual bool libdar::mask::is_covered ( const std::string expression) const [pure virtual]

check wether the given string is covered by the mask

Parameters:
[in]expressionis the filename to check
Returns:
true if the given filename is covered by the mask
Note:
only libdar internally needs to call this method

Implemented in libdar::exclude_dir_mask, libdar::same_path_mask, libdar::simple_path_mask, libdar::ou_mask, libdar::et_mask, libdar::not_mask, libdar::regular_mask, libdar::simple_mask, libdar::bool_mask, and libdar::mask_list.

Referenced by libdar::not_mask::is_covered().

virtual bool libdar::mask::is_covered ( const path chemin) const [inline, virtual]

check whether the given path is covered by the mask

Parameters:
[in]cheminis the path to check
Returns:
true if the given path is covered by the mask
Note:
only libdar internally needs to call this method
this is an optional method to the previous one, it can be overwritten

Reimplemented in libdar::exclude_dir_mask, libdar::simple_path_mask, libdar::ou_mask, libdar::et_mask, libdar::not_mask, and libdar::bool_mask.

Definition at line 80 of file mask.hpp.

References is_covered(), and libdar::path::display().

Referenced by is_covered().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines