Description Class Reference

The description of one single command-line option. More...

#include <fcommandline.h>

Public Member Functions

 Description (const std::string &name, const std::string &help, const std::string &valueType)
 Construct a Description.

Data Fields

std::string mHelp
 The help string for this option.
std::string mType
 The type of this option (kBool, kString).

Static Public Attributes

static const std::string kBool = "bool"
static const std::string kString = "string"

Detailed Description

The description of one single command-line option.

Normally you rarely use a Description directly.
In most cases you will use the Descriptions::addOptions (const std::string&) method to create and add descriptions.


Constructor & Destructor Documentation

Description ( const std::string &  name,
const std::string &  help,
const std::string &  valueType 
)

Construct a Description.

In most cases you will use the Descriptions::addOptions (const std::string&) method to create and add descriptions.

Parameters:
[in] name of the option.
[in] help a help description for this option.
[out] valueType Description::kBool or Description::kString.

Field Documentation

std::string mHelp

The help string for this option.

std::string mType

The type of this option (kBool, kString).

const std::string kBool = "bool" [static]
const std::string kString = "string" [static]
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.