CernVM-FS  2.12.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
swissknife::Parameter Class Reference

#include <swissknife.h>

Public Member Functions

char key () const
 
const std::string & description () const
 
bool optional () const
 
bool mandatory () const
 
bool switch_only () const
 

Static Public Member Functions

static Parameter Mandatory (const char key, const std::string &desc)
 
static Parameter Optional (const char key, const std::string &desc)
 
static Parameter Switch (const char key, const std::string &desc)
 

Protected Member Functions

 Parameter (const char key, const std::string &desc, const bool opt, const bool switch_only)
 

Private Attributes

char key_
 
std::string description_
 
bool optional_
 
bool switch_only_
 

Detailed Description

Definition at line 36 of file swissknife.h.

Constructor & Destructor Documentation

swissknife::Parameter::Parameter ( const char  key,
const std::string &  desc,
const bool  opt,
const bool  switch_only 
)
inlineprotected

Definition at line 55 of file swissknife.h.

Referenced by Mandatory(), Optional(), and Switch().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

const std::string& swissknife::Parameter::description ( ) const
inline

Definition at line 49 of file swissknife.h.

char swissknife::Parameter::key ( ) const
inline

Definition at line 48 of file swissknife.h.

static Parameter swissknife::Parameter::Mandatory ( const char  key,
const std::string &  desc 
)
inlinestatic

Definition at line 38 of file swissknife.h.

Referenced by swissknife::Ingest::GetParams(), swissknife::CommandLetter::GetParams(), swissknife::CommandGc::GetParams(), swissknife::CommandNotify::GetParams(), swissknife::CommandLease::GetParams(), swissknife::CommandSign::GetParams(), swissknife::CommandReconstructReflog::GetParams(), swissknife::CommandScrub::GetParams(), swissknife::CommandPull::GetParams(), swissknife::CommandGraft::GetParams(), swissknife::CommandListCatalogs::GetParams(), swissknife::CommandCheck::GetParams(), swissknife::CommandCreate::GetParams(), swissknife::CommandUpload::GetParams(), swissknife::CommandPeek::GetParams(), swissknife::CommandRemove::GetParams(), swissknife::CommandApplyDirtab::GetParams(), swissknife::CommandSync::GetParams(), and swissknife::CommandMigrate::GetParams().

Here is the call graph for this function:

Here is the caller graph for this function:

bool swissknife::Parameter::mandatory ( ) const
inline

Definition at line 51 of file swissknife.h.

static Parameter swissknife::Parameter::Optional ( const char  key,
const std::string &  desc 
)
inlinestatic

Definition at line 41 of file swissknife.h.

Referenced by swissknife::Ingest::GetParams(), swissknife::CommandLetter::GetParams(), swissknife::CommandGc::GetParams(), swissknife::CommandNotify::GetParams(), swissknife::CommandSign::GetParams(), swissknife::CommandReconstructReflog::GetParams(), swissknife::CommandPull::GetParams(), swissknife::CommandGraft::GetParams(), swissknife::CommandListCatalogs::GetParams(), swissknife::CommandCheck::GetParams(), swissknife::CommandCreate::GetParams(), swissknife::CommandUpload::GetParams(), swissknife::CommandApplyDirtab::GetParams(), swissknife::CommandSync::GetParams(), swissknife::CommandMigrate::GetParams(), and MakeParameterList().

Here is the call graph for this function:

Here is the caller graph for this function:

bool swissknife::Parameter::optional ( ) const
inline

Definition at line 50 of file swissknife.h.

static Parameter swissknife::Parameter::Switch ( const char  key,
const std::string &  desc 
)
inlinestatic

Definition at line 44 of file swissknife.h.

Referenced by swissknife::Ingest::GetParams(), swissknife::CommandLetter::GetParams(), swissknife::CommandGc::GetParams(), swissknife::CommandZpipe::GetParams(), swissknife::CommandNotify::GetParams(), swissknife::CommandSign::GetParams(), swissknife::CommandScrub::GetParams(), swissknife::CommandPull::GetParams(), swissknife::CommandGraft::GetParams(), swissknife::CommandListCatalogs::GetParams(), swissknife::CommandCheck::GetParams(), swissknife::CommandCreate::GetParams(), swissknife::CommandApplyDirtab::GetParams(), swissknife::CommandSync::GetParams(), and swissknife::CommandMigrate::GetParams().

Here is the call graph for this function:

Here is the caller graph for this function:

bool swissknife::Parameter::switch_only ( ) const
inline

Definition at line 52 of file swissknife.h.

Member Data Documentation

std::string swissknife::Parameter::description_
private

Definition at line 66 of file swissknife.h.

Referenced by description().

char swissknife::Parameter::key_
private

Definition at line 65 of file swissknife.h.

Referenced by key().

bool swissknife::Parameter::optional_
private

Definition at line 67 of file swissknife.h.

Referenced by mandatory(), optional(), and Parameter().

bool swissknife::Parameter::switch_only_
private

Definition at line 68 of file swissknife.h.

Referenced by Parameter(), and switch_only().

The documentation for this class was generated from the following file: