Home Libraries Author Links

stm::tools::CtExceptions Class Reference
[CtAids: ClearCase cleartool Aids]

Inheritance diagram for stm::tools::CtExceptions:

Inheritance graph
[legend]
Collaboration diagram for stm::tools::CtExceptions:

Collaboration graph
[legend]

List of all members.


Detailed Description

ClearCase cleartool exceptions class.

A CtExceptions object is a stm::filespeclist designating those file system elements which have to be handled specially.

Definition at line 265 of file ctaids.hpp.


Bitwise orable flags

No flag.

static const word NoFlags = 0x0000
static const word PlainFile = 0x0001
 Directory content flag.
static const word Directory = 0x0002
 Plain file content flag.
static const word Content = PlainFile | Directory
 Bit mask for possible content flags.
static const word Include = 0x0004
 Include action flag.
static const word Exclude = 0x0008
 Exclude action flag.
static const word Actions = Include | Exclude
 Bit mask for possible action flags.

Public Types

typedef
filespeclist::const_iterator 
const_iterator
 Constant iterator inherited from stm::filespeclist.

Public Member Functions

void add (const std::string &spec, word flags=NoFlags)
 If spec begins with a path separator, it is appended to the exception list without this path separator.
bool excludes (const std::string &path, bool directory=false) const
 Returns true, if this CtExceptions object excludes the plain file (if directory is false, the default) or the directory designated by the relative path path, else false.
void clear ()
 Clears the exception list.

Member Typedef Documentation

typedef filespeclist::const_iterator stm::tools::CtExceptions::const_iterator

Constant iterator inherited from stm::filespeclist.

Reimplemented from stm::filespeclist.

Definition at line 269 of file ctaids.hpp.


Member Function Documentation

void stm::tools::CtExceptions::add ( const std::string &  spec,
word  flags = NoFlags 
)

If spec begins with a path separator, it is appended to the exception list without this path separator.

Else it is modified to match an arbitrary amount of directories in its front and this relative path is then appended to the exception list.

bool stm::tools::CtExceptions::excludes ( const std::string &  path,
bool  directory = false 
) const

Returns true, if this CtExceptions object excludes the plain file (if directory is false, the default) or the directory designated by the relative path path, else false.

void stm::tools::CtExceptions::clear (  ) 

Clears the exception list.

Reimplemented from stm::filespeclist.


Member Data Documentation

const word stm::tools::CtExceptions::PlainFile = 0x0001 [static]

Directory content flag.

Definition at line 281 of file ctaids.hpp.

const word stm::tools::CtExceptions::Directory = 0x0002 [static]

Plain file content flag.

Definition at line 284 of file ctaids.hpp.

const word stm::tools::CtExceptions::Content = PlainFile | Directory [static]

Bit mask for possible content flags.

Definition at line 287 of file ctaids.hpp.

const word stm::tools::CtExceptions::Include = 0x0004 [static]

Include action flag.

Definition at line 290 of file ctaids.hpp.

const word stm::tools::CtExceptions::Exclude = 0x0008 [static]

Exclude action flag.

Definition at line 293 of file ctaids.hpp.

const word stm::tools::CtExceptions::Actions = Include | Exclude [static]

Bit mask for possible action flags.

Definition at line 296 of file ctaids.hpp.


© Copyright Tom Michaelis 2002-2007

Distributed under the SysToMath Software License (See the accompanying file license.txt or a copy at www.SysToMath.com).