indri::api::Parameters::parameter_value Struct Reference

Container for parameter values. More...

#include <Parameters.hpp>

List of all members.

Public Types
typedef std::map< std::string, parameter_value * >	MValue
typedef std::vector< parameter_value * >	VValue
Public Member Functions
void	clear ()
	remove any current value, and any subvalues of this parameter
void	convertToArray ()
	convert single value to an entry in the vector array.
const std::string &	getValue ()
	parameter_value (const parameter_value &other)
	parameter_value ()
	create
	~parameter_value ()
	clean up
Public Attributes
std::vector< parameter_value * >	array
	vector of parameter_value pointers
MValue	table
	map of string to parameter_value pointers.
std::string	value
	string representation of parameter value.

---

Detailed Description

Container for parameter values.

---

Member Typedef Documentation

typedef std::map<std::string, parameter_value*> indri::api::Parameters::parameter_value::MValue

typedef std::vector<parameter_value*> indri::api::Parameters::parameter_value::VValue

---

Constructor & Destructor Documentation

indri::api::Parameters::parameter_value::parameter_value (   )  [inline]

create

indri::api::Parameters::parameter_value::parameter_value (  const parameter_value &  other  )  [inline]

Make a deep copy. Parameters: other  the parameter_value to copy.

indri::api::Parameters::parameter_value::~parameter_value (   )  [inline]

clean up

---

Member Function Documentation

void indri::api::Parameters::parameter_value::clear (  void   )  [inline]

remove any current value, and any subvalues of this parameter

void indri::api::Parameters::parameter_value::convertToArray (   )  [inline]

convert single value to an entry in the vector array.

const std::string& indri::api::Parameters::parameter_value::getValue (   )  [inline]

Get the value. Returns: the value of the contents of the first element of array if present, otherwise the contents of value.

---

Member Data Documentation

std::vector<parameter_value*> indri::api::Parameters::parameter_value::array

vector of parameter_value pointers

MValue indri::api::Parameters::parameter_value::table

map of string to parameter_value pointers.

std::string indri::api::Parameters::parameter_value::value

string representation of parameter value.

---

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

• Parameters.hpp

---