coan  6.0.1
A C/C++ Configuration Analyzer
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
dataset Struct Reference

struct dataset encapsulates the tree of input files to be processed by coan. More...

#include <dataset.h>

Inheritance diagram for dataset:
no_copy

Classes

struct  driver
 struct driver encapsulates traversal of an input dataset to select and process files. More...
 
struct  selector
 Encapsulates the selection of files for processing. More...
 

Static Public Member Functions

static void set_filter (std::string extensions)
 Specify the filtering of files in the dataset. More...
 
static void add (std::string const &path)
 Add files to the dataset. More...
 
static void traverse ()
 Traverse the dataset processing the selected files.
 
static unsigned files ()
 Get the number of files in the dataset.
 
static unsigned done_files ()
 Get the number of files reached by traversal of the dataset
 
static unsigned error_files ()
 Get the number of files abandoned due to errors in traversal of the dataset.
 

Static Private Attributes

static selector _selector_
 The selector for including files in the dataset
 
static driver _driver_
 The driver for traversing dataset
 
static file_tree _ftree_
 The tree of input files.
 

Detailed Description

struct dataset encapsulates the tree of input files to be processed by coan.

Definition at line 50 of file dataset.h.

Member Function Documentation

void dataset::add ( std::string const &  path)
static

Add files to the dataset.

Parameters
pathName of file or directory to be included in the dataset.

If path is a file that satisfies any --filter option it is added to the dataset.

If path is a directory then files recursively beneath it that satisfy any --filter option are added to the dataset.

Definition at line 144 of file dataset.cpp.

static void dataset::set_filter ( std::string  extensions)
inlinestatic

Specify the filtering of files in the dataset.

Parameters
extensionsAn empty string or else a comma-punctuated list of the extensions of files that are to be selected.

Definition at line 113 of file dataset.h.


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