torc::generic::Value Class Reference

#include <Value.hpp>

Data Structures
class	MiNoMax
class	Number
class	Point

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 ()
	Value (Type type)
template<typename _ValueType >
	Value (Type type, const _ValueType &inSource)
	~Value () throw ()
	Value (const Value &inSource)
Value &	operator= (const Value &inSource)
template<typename _ValueType >
_ValueType	get () const throw (Error)
template<typename _ValueType >
void	set (const _ValueType &inSource) throw (Error)
const Type	getType () const
void	setType (const Type &inSource)
const bool	getIsSet () const
void	setIsSet (const bool &inSource)

Private Attributes
Type	mType
boost::variant< Value::Boolean, Value::Integer, Value::Number, Value::MiNoMax, Value::Point, Value::String >	mValue
bool	mIsSet

Detailed Description

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

Definition at line 34 of file Value.hpp.

Member Typedef Documentation

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

Boolean Type

Definition at line 51 of file Value.hpp.

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

32 bit Signed Integer type.

Definition at line 56 of file Value.hpp.

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

Defines a non-unicode standard string.

Definition at line 61 of file Value.hpp.

Member Enumeration Documentation

enum torc::generic::Value::Type

Defines the type of inSource stored in this Value object.

Enumerator
eValueTypeUndefined
eValueTypeBoolean
eValueTypeInteger
eValueTypeMiNoMax
eValueTypeNumber
eValueTypePoint
eValueTypeString

Definition at line 44 of file Value.hpp.

              {
        eValueTypeUndefined, eValueTypeBoolean, eValueTypeInteger, eValueTypeMiNoMax,
        eValueTypeNumber, eValueTypePoint, eValueTypeString
    };

Constructor & Destructor Documentation

torc::generic::Value::Value

(

)

Definition at line 194 of file Value.cpp.

: mType(eValueTypeUndefined), mValue(), mIsSet(false) {}

torc::generic::Value::Value

(

Value::Type

type

)

Definition at line 196 of file Value.cpp.

: mType(type), mValue(), mIsSet(false) {}

template<typename _ValueType >

torc::generic::Value::Value	(	Value::Type	type,
		const _ValueType &	inSource
	)

Definition at line 361 of file Value.hpp.

                                                                                      :
    mType(type), mValue(inSource), mIsSet(true) {}

torc::generic::Value::~Value	(		)
throw	(
	)

Definition at line 198 of file Value.cpp.

{}

torc::generic::Value::Value

(

const Value &

inSource

)

Definition at line 200 of file Value.cpp.

                                  : mType(inSource.mType), mValue(inSource.mValue),
    mIsSet(inSource.mIsSet) {}

Member Function Documentation

template<typename _ValueType >

_ValueType torc::generic::Value::get	(		)	const
throw	(	Error
	)

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 386 of file Value.hpp.

                                                                         {
    if(!mIsSet) {
        Error e(eMessageIdErrorValueNotSet, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Value set", mIsSet);
        throw e;
    }
    _ValueType v;
    try {
        v = boost::get < _ValueType > (mValue);
    } catch(const boost::bad_get& bg) {
        Error e(eMessageIdErrorTypeCast, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Value", mValue);
        e.saveContextData("Casted Type", std::string("_ValueType"));
        throw e;
    }
    return v;
}

Here is the call graph for this function:

Here is the caller graph for this function:

const bool torc::generic::Value::getIsSet ( ) const

inline

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

Returns

True if initialized.

Definition at line 357 of file Value.hpp.

                                        {
    return mIsSet;
}

Here is the caller graph for this function:

const Value::Type torc::generic::Value::getType ( void  ) const

inline

Get the type of inSource stored in this object.

Returns

The type of object

Definition at line 348 of file Value.hpp.

                                            {
    return mType;
}

Here is the caller graph for this function:

Value & torc::generic::Value::operator=

(

const Value &

inSource

)

Definition at line 203 of file Value.cpp.

                                             {
    if(this != &inSource) {
        mType = inSource.mType;
        mValue = inSource.mValue;
        mIsSet = inSource.mIsSet;
    }
    return *this;
}

template<typename _ValueType >

void torc::generic::Value::set	(	const _ValueType &	inSource	)
throw	(	Error
	)

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 373 of file Value.hpp.

                                                                                       {
    mValue = inSource;
}

void torc::generic::Value::setIsSet

(

const bool &

inSource

)

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 226 of file Value.cpp.

                                         {
    mIsSet = inSource;
}

void torc::generic::Value::setType

(

const Type &

inSource

)

Get the type of inSource stored in this object.

Returns

The type of object

Definition at line 217 of file Value.cpp.

                                             {
    mType = inSource;
}

Field Documentation

bool torc::generic::Value::mIsSet

private

Definition at line 304 of file Value.hpp.

Type torc::generic::Value::mType

private

Definition at line 301 of file Value.hpp.

boost::variant<Value::Boolean, Value::Integer, Value::Number, Value::MiNoMax, Value::Point, Value::String> torc::generic::Value::mValue

private

Definition at line 303 of file Value.hpp.

---

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

• Value.hpp
• Value.cpp