torc::generic::Value Class Reference

#include <Value.hpp>

List of all members.

Public Types
enum	Type {   eValueTypeUndefined, eValueTypeBoolean, eValueTypeInteger, eValueTypeMiNoMax,   eValueTypeNumber, eValueTypePoint, eValueTypeString }
typedef bool	Boolean
typedef int32_t	Integer
typedef std::string	String
Public Member Functions
	Value (Type type)
template<typename _ValueType>
	Value (Type type, const _ValueType &inSource)
	Value (const Value &inSource)
Value &	operator= (const Value &inSource) throw ()
template<typename _ValueType>
_ValueType	get () const throw (Error)
template<typename _ValueType>
void	set (const _ValueType &inSource) throw (Error)
const Type	getType () const throw ()
void	setType (const Type &inSource) throw ()
const bool	getIsSet () const throw ()
void	setIsSet (const bool &inSource) throw ()
Private Attributes
Type	mType
boost::variant< Value::Boolean, Value::Integer, Value::Number, Value::MiNoMax, Value::Point, Value::String >	mValue
bool	mIsSet
Classes
class	MiNoMax
class	Number
class	Point

---

Detailed Description

Represents a Value in EDIF. Values are used in different regions in EDIF such as in properties, parametrs etc.

Definition at line 37 of file Value.hpp.

---

Member Typedef Documentation

typedef bool torc::generic::Value::Boolean

Boolean Type

Definition at line 62 of file Value.hpp.

typedef int32_t torc::generic::Value::Integer

32 bit Signed Integer type.

Definition at line 67 of file Value.hpp.

typedef std::string torc::generic::Value::String

Defines a non-unicode standard string.

Definition at line 72 of file Value.hpp.

---

Member Enumeration Documentation

enum torc::generic::Value::Type

Defines the type of inSource stored in this Value object.

Definition at line 48 of file Value.hpp.

---

Member Function Documentation

template<typename _ValueType>

_ValueType torc::generic::Value::get

(

)

const throw (Error) [inline]

Get the inSource stored in this object.

Note:

This needs to be called as: v.get<Value::Integer>();

Returns:

The inSource according to the specified type.

Exceptions:

Error

The stored an requested types are incompatible.

Definition at line 480 of file Value.hpp.

template<typename _ValueType>

void torc::generic::Value::set

(

const _ValueType &

inSource

)

throw (Error) [inline]

Set a inSource object.

Note:

This needs to be called as: v.set<Value::Integer>(10);

Parameters:

[in]

inSource

The inSource according to the specified type.

Exceptions:

Error

The requested type is wrong.

Definition at line 465 of file Value.hpp.

const Value::Type torc::generic::Value::getType

(

void

)

const throw () [inline]

Get the type of inSource stored in this object.

Returns:

The type of object

Definition at line 433 of file Value.hpp.

void torc::generic::Value::setType

(

const Type &

inSource

)

throw ()

Get the type of inSource stored in this object.

Returns:

The type of object

Definition at line 324 of file Value.cpp.

const bool torc::generic::Value::getIsSet

(

)

const throw () [inline]

Get whether this object is defined with a inSource, or is undefined.

Returns:

True if initialized.

Definition at line 443 of file Value.hpp.

void torc::generic::Value::setIsSet

(

const bool &

inSource

)

throw ()

Set whether this object is defined with a inSource, or is undefined.

Parameters:

[in]

inSource

True if initialized.

false* Set whether this object is defined with a inSource, or is undefined.

Parameters:

[in]

inSource

True if initialized.

Definition at line 334 of file Value.cpp.

---

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

• torc/generic/om/Value.hpp
• torc/generic/om/Value.cpp