Object::Operation::Argument Class Reference

#include <object.h>

List of all members.


Detailed Description

Argument class represents one argument that can be passed to an operation.

An argument has a name, type, and boolean indicating whether this argument is always required to be present in an operation.

Definition at line 296 of file object.h.


Public Member Functions

 Argument (const std::string &name, bool required, DataType type)
 This constructor should be used by modules to add an argument to an operation being described.
 Argument (const std::string &name, const std::string &value)
 This constructor should be used by UI parser to construct an argument to be added to an operation which is then passed to an object.
 ~Argument ()
 Dummy destructor.
Accessors
std::string getValue () const
std::string getName () const
DataType getType () const
bool isRequired () const

Private Attributes

std::string m_name
 Name of the argument.
bool m_required
 If this is required.
DataType m_type
 Argument value type.
std::string m_value
 Argument value.

Constructor & Destructor Documentation

Object::Operation::Argument::Argument const std::string &  name,
bool  required,
DataType  type
[inline]
 

This constructor should be used by modules to add an argument to an operation being described.

Parameters:
name Name of the argument
required If argument is required
type Type of argument's data

Definition at line 306 of file object.h.

Object::Operation::Argument::Argument const std::string &  name,
const std::string &  value
[inline]
 

This constructor should be used by UI parser to construct an argument to be added to an operation which is then passed to an object.

Parameters:
name Name of the argument
value Value of the argument
Note:
The type of argument is intentionally left undefined here, since it would add nothing for the creator, and the object receiving the argument checks the type internally anyway.

Definition at line 324 of file object.h.

Object::Operation::Argument::~Argument  )  [inline]
 

Dummy destructor.

Definition at line 330 of file object.h.


Member Function Documentation

std::string Object::Operation::Argument::getName  )  const [inline]
 

Definition at line 335 of file object.h.

DataType Object::Operation::Argument::getType  )  const [inline]
 

Definition at line 336 of file object.h.

std::string Object::Operation::Argument::getValue  )  const [inline]
 

Definition at line 334 of file object.h.

bool Object::Operation::Argument::isRequired  )  const [inline]
 

Definition at line 337 of file object.h.


Member Data Documentation

std::string Object::Operation::Argument::m_name [private]
 

Name of the argument.

Definition at line 340 of file object.h.

bool Object::Operation::Argument::m_required [private]
 

If this is required.

Definition at line 341 of file object.h.

DataType Object::Operation::Argument::m_type [private]
 

Argument value type.

Definition at line 342 of file object.h.

std::string Object::Operation::Argument::m_value [private]
 

Argument value.

Definition at line 343 of file object.h.


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