Parameter Struct Reference

#include <fs/tool/parameter.h>

Public Types
enum	Type {   TEXT ,   FILE ,   DIRECTORY ,   SYMLINK ,   PATH }
enum	Exist {   MAY_EXIST ,   MUST_EXIST ,   MUST_NOT_EXIST }

Public Member Functions
	Parameter ()
	Parameter (const bool &&local, const enum Type &&type, const enum Exist &&status=MUST_EXIST, const bool &&optional=false, const std::string name=std::string())
bool	check (const std::string &arg) const
void	complete (const std::string &in, const std::string &part, std::vector< std::string > &completions) const
std::string	getName (void) const

Public Attributes
const bool	local
enum Parameter::Type	type
enum Parameter::Exist	status
const bool	optional
const std::string	name

Private Member Functions
bool	checkType (enum FileSystemInterface::FileType ft) const

Member Enumeration Documentation

Type

enum Parameter::Type

Enumerator
TEXT
FILE
DIRECTORY
SYMLINK
PATH

Exist

enum Parameter::Exist

Enumerator
MAY_EXIST
MUST_EXIST
MUST_NOT_EXIST

Constructor & Destructor Documentation

Parameter() [1/2]

Parameter::Parameter ( )

inline

Parameter() [2/2]

Parameter::Parameter ( const bool &&  local, const enum Type &&  type, const enum Exist &&  status = MUST_EXIST, const bool &&  optional = false, const std::string  name = std::string()  )

inline

Member Function Documentation

check()

bool Parameter::check

(

const std::string &

arg

)

const

complete()

void Parameter::complete	(	const std::string &	in,
		const std::string &	part,
		std::vector< std::string > &	completions
	)		const

getName()

std::string Parameter::getName

(

void

)

const

checkType()

bool Parameter::checkType ( enum FileSystemInterface::FileType  ft ) const

private

Member Data Documentation

local

const bool Parameter::local

type

enum Parameter::Type Parameter::type

status

enum Parameter::Exist Parameter::status

optional

const bool Parameter::optional

name

const std::string Parameter::name

---

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

• fs/tool/parameter.h
• fs/tool/parameter.cc