JEEP::JPropertiesElement Class Reference

The property value class. More...

#include <JProperties.hh>

Inheritance diagram for JEEP::JPropertiesElement:

Public Member Functions
	JPropertiesElement ()
	Default constructor.
template<class T >
	JPropertiesElement (T &value)
	Constructor.
bool	equals (const JPropertiesElement &element) const
	Equality between property elements.
template<class T >
JPropertiesElement &	operator= (T &value)
	Assignment operator.
template<class T >
const T &	getValue () const
	Get value.
template<class T >
T &	getValue ()
	Get value.
template<class T >
void	setValue (const T &value)
	Set value of this JPropertiesElement.
std::string	toString () const
	Convert to string.
template<class T >
T	toValue () const
	Convert to template type.
template<class T >
	operator const T & () const
	Type conversion operator.
bool	getEndMarker () const
	Get end marker.
void	setEndMarker (const bool marker)
	Set end marker.

Private Attributes
bool	end_marker

Detailed Description

The property value class.

This class consists of a pointer to the JPropertiesElementInterface. This class implements the assignment and type conversion operators.

Definition at line 294 of file JProperties.hh.

Constructor & Destructor Documentation

JPropertiesElement() [1/2]

JEEP::JPropertiesElement::JPropertiesElement ( )

inline

Default constructor.

Definition at line 301 of file JProperties.hh.

                         :
      end_marker(false)
    {}

JPropertiesElement() [2/2]

template<class T >

JEEP::JPropertiesElement::JPropertiesElement ( T & value )

inline

Constructor.

Parameters

value

reference to template object

Definition at line 312 of file JProperties.hh.

                                 :
      end_marker(false)
    {
      reset(new JPropertiesTemplateElement<T>(value));
    }

Member Function Documentation

equals()

bool JEEP::JPropertiesElement::equals ( const JPropertiesElement & element ) const

inline

Equality between property elements.

Parameters

element

properties element

Returns

true if equal; else false

Definition at line 325 of file JProperties.hh.

    { 
      return get()->equals(*element.get());
    }

operator=()

template<class T >

JPropertiesElement & JEEP::JPropertiesElement::operator= ( T & value )

inline

Assignment operator.

Parameters

value

reference to template object

Returns

this JPropertiesElement

Definition at line 338 of file JProperties.hh.

    {
      reset(new JPropertiesTemplateElement<T>(value));
 
      return *this;
    }

getValue() [1/2]

template<class T >

const T & JEEP::JPropertiesElement::getValue ( ) const

inline

Get value.

Returns

value of this JPropertiesElement

Definition at line 352 of file JProperties.hh.

    {
      const JPropertiesTemplateElement<T>* p = dynamic_cast<const JPropertiesTemplateElement<T>*>(this->get());
 
      if (p != NULL)
        return p->object;
      else
        THROW(JPropertiesException, "Inconsistent data type.");
    }

getValue() [2/2]

template<class T >

T & JEEP::JPropertiesElement::getValue ( )

inline

Get value.

Returns

value of this JPropertiesElement

Definition at line 369 of file JProperties.hh.

    {
      JPropertiesTemplateElement<T>* p = dynamic_cast<JPropertiesTemplateElement<T>*>(this->get());
 
      if (p != NULL)
        return p->object;
      else
        THROW(JPropertiesException, "Inconsistent data type.");
    }

setValue()

template<class T >

void JEEP::JPropertiesElement::setValue ( const T & value )

inline

Set value of this JPropertiesElement.

Parameters

value

value

Definition at line 387 of file JProperties.hh.

    {
      JPropertiesTemplateElement<T>* p = dynamic_cast<JPropertiesTemplateElement<T>*>(this->get());
 
      if (p != NULL)
        p->object = value;
      else
        THROW(JPropertiesException, "Inconsistent data type.");
    }

toString()

std::string JEEP::JPropertiesElement::toString ( ) const

inline

Convert to string.

Returns

value of this JPropertiesElement

Definition at line 403 of file JProperties.hh.

    {
      std::ostringstream os;
      
      get()->write(os, "", '\0');
 
      return os.str();
    }

toValue()

template<class T >

T JEEP::JPropertiesElement::toValue ( ) const

inline

Convert to template type.

Returns

value of this JPropertiesElement

Definition at line 419 of file JProperties.hh.

    {
      T value;
 
      std::istringstream in(this->toString());
 
      in >> value;
 
      return value;
    }

operator const T &()

template<class T >

JEEP::JPropertiesElement::operator const T & ( ) const

inline

Type conversion operator.

Returns

value of this JPropertiesElement

Definition at line 437 of file JProperties.hh.

    {
      return getValue<T>();
    }

getEndMarker()

bool JEEP::JPropertiesElement::getEndMarker ( ) const

inline

Get end marker.

Returns

end marker

Definition at line 448 of file JProperties.hh.

    {
      return end_marker;
    }

setEndMarker()

void JEEP::JPropertiesElement::setEndMarker ( const bool marker )

inline

Set end marker.

Parameters

marker

if true stop reading after this properties element, else continue

Definition at line 459 of file JProperties.hh.

    {
      end_marker = marker;
    }

Member Data Documentation

end_marker

bool JEEP::JPropertiesElement::end_marker

private

Definition at line 466 of file JProperties.hh.

---

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

• JProperties.hh