feisty meow concerns codebase  2.140
application::command_parameter Class Reference

#include <command_line.h>

Inheritance diagram for application::command_parameter:
Collaboration diagram for application::command_parameter:

Public Types

enum  parameter_types { VALUE , CHAR_FLAG , STRING_FLAG , BOGUS_ITEM }
 

Public Member Functions

 command_parameter (parameter_types type=BOGUS_ITEM)
 default constructor initializes to mostly blank state. More...
 
 command_parameter (parameter_types type, const basis::astring &text)
 constructs a parameter of "type" where the value is "text". More...
 
 command_parameter (const command_parameter &to_copy)
 
 ~command_parameter ()
 
 DEFINE_CLASS_NAME ("command_parameter")
 
command_parameteroperator= (const command_parameter &to_copy)
 
parameter_types type () const
 observes the type of the parameter. More...
 
void type (parameter_types new_type)
 modifies the type of the parameter. More...
 
const basis::astringtext () const
 observes the string contents. More...
 
void text (const basis::astring &new_text)
 modifies the string contents. More...
 

Detailed Description

Definition at line 48 of file command_line.h.

Member Enumeration Documentation

◆ parameter_types

Enumerator
VALUE 
CHAR_FLAG 
STRING_FLAG 
BOGUS_ITEM 

Definition at line 51 of file command_line.h.

Constructor & Destructor Documentation

◆ command_parameter() [1/3]

application::command_parameter::command_parameter ( parameter_types  type = BOGUS_ITEM)

default constructor initializes to mostly blank state.

Definition at line 42 of file command_line.cpp.

◆ command_parameter() [2/3]

application::command_parameter::command_parameter ( parameter_types  type,
const basis::astring text 
)

constructs a parameter of "type" where the value is "text".

if the "type" is CHAR_FLAG, then this should be a string of one character. for STRING_FLAG, the length is arbitrary.

Definition at line 45 of file command_line.cpp.

◆ command_parameter() [3/3]

application::command_parameter::command_parameter ( const command_parameter to_copy)

Definition at line 48 of file command_line.cpp.

◆ ~command_parameter()

application::command_parameter::~command_parameter ( )

Definition at line 52 of file command_line.cpp.

References basis::WHACK().

Member Function Documentation

◆ DEFINE_CLASS_NAME()

application::command_parameter::DEFINE_CLASS_NAME ( "command_parameter"  )

◆ operator=()

command_parameter & application::command_parameter::operator= ( const command_parameter to_copy)

Definition at line 58 of file command_line.cpp.

◆ text() [1/2]

const astring & application::command_parameter::text ( ) const

◆ text() [2/2]

void application::command_parameter::text ( const basis::astring new_text)

modifies the string contents.

Definition at line 56 of file command_line.cpp.

◆ type() [1/2]

parameter_types application::command_parameter::type ( ) const
inline

◆ type() [2/2]

void application::command_parameter::type ( parameter_types  new_type)
inline

modifies the type of the parameter.

Definition at line 71 of file command_line.h.


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