command_parameter Class Reference

#include <command_line.h>

Inheritance diagram for command_parameter:

Inheritance graph
[legend]
Collaboration diagram for command_parameter:

Collaboration graph
[legend]
List of all members.

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.
 command_parameter (parameter_types type, const istring &text)
 constructs a parameter of "type" where the value is "text".
 command_parameter (const command_parameter &to_copy)
 ~command_parameter ()
 IMPLEMENT_CLASS_NAME ("command_parameter")
command_parameteroperator= (const command_parameter &to_copy)
parameter_types type () const
 observes the type of the parameter.
void type (parameter_types new_type)
 modifies the type of the parameter.
const istringtext () const
 observes the string contents.
void text (const istring &new_text)
 modifies the string contents.

Detailed Description

Definition at line 47 of file command_line.h.


Member Enumeration Documentation

enum command_parameter::parameter_types

Enumerator:
VALUE 
CHAR_FLAG 
STRING_FLAG 
BOGUS_ITEM 

Definition at line 51 of file command_line.h.


Constructor & Destructor Documentation

command_parameter::command_parameter ( parameter_types  type = BOGUS_ITEM  ) 

default constructor initializes to mostly blank state.

Definition at line 36 of file command_line.cpp.

command_parameter::command_parameter ( parameter_types  type,
const istring 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 39 of file command_line.cpp.

command_parameter::command_parameter ( const command_parameter to_copy  ) 

Definition at line 42 of file command_line.cpp.

command_parameter::~command_parameter (  ) 

Definition at line 46 of file command_line.cpp.

References WHACK().


Member Function Documentation

command_parameter::IMPLEMENT_CLASS_NAME ( "command_parameter"   ) 

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

Definition at line 53 of file command_line.cpp.

parameter_types command_parameter::type (  )  const [inline]

observes the type of the parameter.

Definition at line 69 of file command_line.h.

Referenced by command_line::get_value(), and main().

void command_parameter::type ( parameter_types  new_type  )  [inline]

modifies the type of the parameter.

Definition at line 71 of file command_line.h.

const istring & command_parameter::text (  )  const

observes the string contents.

Definition at line 48 of file command_line.cpp.

Referenced by command_line::find(), command_line::gather(), command_line::get_value(), service_root::initialize(), and main().

void command_parameter::text ( const istring new_text  ) 

modifies the string contents.

Definition at line 50 of file command_line.cpp.


The documentation for this class was generated from the following files:
Generated on Sat Oct 11 04:30:05 2008 for HOOPLE Libraries by  doxygen 1.5.1