Home Libraries Author Links

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

List of all members.


Detailed Description

Main ClearCase cleartool aids class.

Definition at line 109 of file ctaids.hpp.


Public Types

typedef logger Logger
 Type managing formatted logging to the console and/or into a protocol file.

Public Member Functions

 Ct (Logger &logger)
 Construct a Ct object prepared for logging with logger.
Loggerlogger () const
 Return the logging object of this Ct.
void setMode (int mode)
 Set the action mode of this Ct.
int getMode () const
 Return the action mode of this Ct.
void setCiCommentOption (const std::string &ciCommentOption)
 Set the check in comment option of this Ct.
const std::string & getCiCommentOption () const
 Return the check in comment option of this Ct.
void execCommand (const std::string &command) const
 The method execCommand executes the console command.

Static Public Member Functions

static bool isVobElement (const boost::filesystem::path &path)
 The static method isVobElement returns true, if path is a ClearCase VOB element, else false.
static bool isCheckedOut (const boost::filesystem::path &path)
 The static method isCheckedOut returns true, if path is checked out, else false.
static std::string getCurrentBranch (const std::string &path)
 Returns the current branch of the the ClearCase VOB element path.
static std::string getCurrentMasterReplica (const std::string &branch)
 Returns the current ClearCase master replica of branch.

Classes

class  ArgList
 Class to hold multiple arguments for a command. More...
struct  Mode
 Ct action modes. More...

Member Typedef Documentation

typedef logger stm::tools::Ct::Logger

Type managing formatted logging to the console and/or into a protocol file.

Definition at line 114 of file ctaids.hpp.


Constructor & Destructor Documentation

stm::tools::Ct::Ct ( Logger logger  ) 

Construct a Ct object prepared for logging with logger.


Member Function Documentation

Logger& stm::tools::Ct::logger (  )  const

Return the logging object of this Ct.

void stm::tools::Ct::setMode ( int  mode  ) 

Set the action mode of this Ct.

int stm::tools::Ct::getMode (  )  const

Return the action mode of this Ct.

void stm::tools::Ct::setCiCommentOption ( const std::string &  ciCommentOption  ) 

Set the check in comment option of this Ct.

const std::string& stm::tools::Ct::getCiCommentOption (  )  const

Return the check in comment option of this Ct.

void stm::tools::Ct::execCommand ( const std::string &  command  )  const

The method execCommand executes the console command.

If this Ct object is configured for action Verbose, additional diagnostics are logged according to this Ct object's logger. If this Ct object is configured for action Simulate, command is not executed but protocolled according to this Ct object's logger instead. On error a std::runtime_error exception is thrown.

static bool stm::tools::Ct::isVobElement ( const boost::filesystem::path &  path  )  [static]

The static method isVobElement returns true, if path is a ClearCase VOB element, else false.

Throws on error.

static bool stm::tools::Ct::isCheckedOut ( const boost::filesystem::path &  path  )  [static]

The static method isCheckedOut returns true, if path is checked out, else false.

Throws on error.

static std::string stm::tools::Ct::getCurrentBranch ( const std::string &  path  )  [static]

Returns the current branch of the the ClearCase VOB element path.

static std::string stm::tools::Ct::getCurrentMasterReplica ( const std::string &  branch  )  [static]

Returns the current ClearCase master replica of branch.


© Copyright Tom Michaelis 2002-2007

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