JEEP::JPropertiesElement Class Reference

The property value class. More...

#include <JProperties.hh>

Inheritance diagram for JEEP::JPropertiesElement:

Public Types
typedef JPointer< JClass_t >	pointer_type
typedef JStorage< JClass_t, JMemory_t >	storage_type
typedef JNew< JClass_t >	memory_type

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.
const JSharedPointer &	getSharedPointer () const
	Get shared pointer.
JSharedPointer &	getSharedPointer ()
	Get shared pointer.
void	setSharedPointer (const JSharedPointer &object)
	Set shared pointer.
virtual void	reset () override
	Reset pointer.
void	reset (const JPointer< T > &pointer)
	Reset pointer.
void	reset (JClass_t *p)
	Reset pointer.
template<class T >
void	set (const JPointer< T > &pointer)
	Set pointer.
void	initialise ()
	Initialise counter.
void	attach (const JSharedCounter &object)
	Attach this counter to given shared counter object.
bool	detach ()
	Detach.
const int	getCount ()
	Get count.
void	recreate ()
	Recreate object in memory.
void	create ()
	Create object in memory.
void	create (const unsigned int size)
	Create array of objects in memory.
virtual JClass_t *	get () const override
	Get pointer.
JClass_t *const &	getReference () const
	Get rereference to internal pointer.
JClass_t *&	getReference ()
	Get rereference to internal pointer.
virtual bool	equals (const JAbstractPointer &object) const
	Equals.
bool	is_valid () const
	Check validity of pointer.
JClass_t *	operator-> () const
	Smart pointer operator.
	operator JClass_t * () const
	Type conversion operator.

Static Public Member Functions
static void	release (JClass_t *p)
	Release memory.

Protected Member Functions
void	set (const JSharedPointer &object)
	Set pointer.
virtual void	set (JClass_t *p) override
	Set pointer.
void	release ()
	Release memory.

Protected Attributes
int *	counter
JClass_t *	__p
	pointer to object

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 295 of file JProperties.hh.

Member Typedef Documentation

pointer_type

template<class JClass_t , template< class > class JMemory_t = JNew>

JPointer<JClass_t> JLANG::JSharedPointer< JClass_t, JMemory_t >::pointer_type

inherited

Definition at line 34 of file JSharedPointer.hh.

storage_type

template<class JClass_t , template< class > class JMemory_t = JNew>

JStorage<JClass_t, JMemory_t> JLANG::JSharedPointer< JClass_t, JMemory_t >::storage_type

inherited

Definition at line 35 of file JSharedPointer.hh.

memory_type

JNew<JClass_t> JLANG::JStorage< JClass_t, JNew >::memory_type

inherited

Definition at line 33 of file JStorage.hh.

Constructor & Destructor Documentation

JPropertiesElement() [1/2]

JEEP::JPropertiesElement::JPropertiesElement ( )

inline

Default constructor.

Definition at line 302 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 313 of file JProperties.hh.

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

Member Function Documentation

equals() [1/2]

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 326 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 339 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 353 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 370 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 388 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 404 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 420 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 438 of file JProperties.hh.

    {
      return getValue<T>();
    }

getEndMarker()

bool JEEP::JPropertiesElement::getEndMarker ( ) const

inline

Get end marker.

Returns

end marker

Definition at line 449 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 460 of file JProperties.hh.

    {
      end_marker = marker;
    }

getSharedPointer() [1/2]

template<class JClass_t , template< class > class JMemory_t = JNew>

const JSharedPointer & JLANG::JSharedPointer< JClass_t, JMemory_t >::getSharedPointer ( ) const

inlineinherited

Get shared pointer.

Returns

this shared pointer

Definition at line 95 of file JSharedPointer.hh.

    {
      return static_cast<const JSharedPointer&>(*this);
    }

getSharedPointer() [2/2]

template<class JClass_t , template< class > class JMemory_t = JNew>

JSharedPointer & JLANG::JSharedPointer< JClass_t, JMemory_t >::getSharedPointer ( )

inlineinherited

Get shared pointer.

Returns

this shared pointer

Definition at line 106 of file JSharedPointer.hh.

    {
      return static_cast<JSharedPointer&>(*this);
    }

setSharedPointer()

template<class JClass_t , template< class > class JMemory_t = JNew>

void JLANG::JSharedPointer< JClass_t, JMemory_t >::setSharedPointer ( const JSharedPointer< JClass_t, JMemory_t > & object )

inlineinherited

Set shared pointer.

Parameters

object

shared pointer

Definition at line 117 of file JSharedPointer.hh.

    {
      if (this->get() != object.get()) {
 
        this->reset();
 
        if (object.is_valid()) {
          this->set(object);
        }
      }
    }

reset() [1/3]

template<class JClass_t , template< class > class JMemory_t = JNew>

virtual void JLANG::JSharedPointer< JClass_t, JMemory_t >::reset ( )

inlineoverridevirtualinherited

Reset pointer.

The reference counter is decremented by one and the object pointed to previously is deleted when its reference counter is zero.

Reimplemented from JLANG::JStorage< JClass_t, JNew >.

Definition at line 171 of file JSharedPointer.hh.

    {
      if (this->detach()) {
        storage_type::reset();
      }
 
      pointer_type::reset();
    }

reset() [2/3]

void JLANG::JPointer< JClass_t >::reset ( const JPointer< T > & pointer )

inlineinherited

Reset pointer.

Parameters

pointer

pointer to object

Definition at line 35 of file JPointer.hh.

    {
      this->reset(pointer.get());
    }

reset() [3/3]

template<class JClass_t >

void JLANG::JAbstractPointer< JClass_t >::reset ( JClass_t * p )

inlineinherited

Reset pointer.

Parameters

p	pointer to object

Definition at line 94 of file JAbstractPointer.hh.

    {
      if (this->get() != p) {
 
        this->reset();
 
        if (p != NULL) {
          this->set(p);
        }
      }
    }

set() [1/3]

template<class JClass_t , template< class > class JMemory_t = JNew>

void JLANG::JSharedPointer< JClass_t, JMemory_t >::set ( const JSharedPointer< JClass_t, JMemory_t > & object )

inlineprotectedinherited

Set pointer.

The reference counter of the shared object pointed to is incremented by one.

Parameters

object

shared pointer

Definition at line 188 of file JSharedPointer.hh.

    {
      pointer_type::set(object.get());
 
      this->attach(object);
    }

set() [2/3]

template<class JClass_t , template< class > class JMemory_t = JNew>

virtual void JLANG::JSharedPointer< JClass_t, JMemory_t >::set ( JClass_t * p )

inlineoverrideprotectedvirtualinherited

Set pointer.

The reference counter of the shared object pointed to is initialised to one.

Parameters

p	pointer to derived class object

Reimplemented from JLANG::JPointer< JClass_t >.

Definition at line 202 of file JSharedPointer.hh.

    {
      pointer_type::set(p);
 
      this->initialise();
    }

set() [3/3]

template<class JClass_t >

template<class T >

void JLANG::JPointer< JClass_t >::set ( const JPointer< T > & pointer )

inlineinherited

Set pointer.

Parameters

pointer

pointer to object

Definition at line 96 of file JPointer.hh.

    {
      this->set(pointer.get());
    }

initialise()

void JLANG::JSharedCounter::initialise ( )

inlineinherited

Initialise counter.

Definition at line 33 of file JSharedCounter.hh.

    {
      detach();
 
      counter = new int(1);
    }

attach()

void JLANG::JSharedCounter::attach ( const JSharedCounter & object )

inlineinherited

Attach this counter to given shared counter object.

Parameters

object

shared counter

Definition at line 46 of file JSharedCounter.hh.

    {
      detach();
 
      counter = object.counter;
 
      if (counter != NULL) {
        ++(*counter);
      }
    }

detach()

bool JLANG::JSharedCounter::detach ( )

inlineinherited

Detach.

Returns

true if counter at zero; else false

Definition at line 63 of file JSharedCounter.hh.

    {
      if (counter != NULL) {
 
        if (--(*counter) == 0) {
 
          delete counter;
 
          counter = NULL;
 
          return true;
        }
 
        counter = NULL;
      }
 
      return false;
    }

getCount()

const int JLANG::JSharedCounter::getCount ( )

inlineinherited

Get count.

Returns

count

Definition at line 88 of file JSharedCounter.hh.

    {
      return (counter != NULL ? *counter : 0);
    }

recreate()

void JLANG::JStorage< JClass_t, JNew >::recreate ( )

inlineinherited

Recreate object in memory.

A new object is created if no memory is allocated yet, else the previously created object is maintained.

Definition at line 57 of file JStorage.hh.

    {
      if (!this->is_valid()) {
        this->set(memory_type::create());
      }
    }

create() [1/2]

void JLANG::JStorage< JClass_t, JNew >::create ( )

inlineinherited

Create object in memory.

The memory allocated by a previously created object will be released.

Definition at line 69 of file JStorage.hh.

    {
      this->reset(memory_type::create());
    }

create() [2/2]

void JLANG::JStorage< JClass_t, JNew >::create ( const unsigned int size )

inlineinherited

Create array of objects in memory.

The memory allocated by previously created objects will be released.

Parameters

size	number of elements

Definition at line 81 of file JStorage.hh.

    {
      this->reset(memory_type::create(size));
    }

release() [1/2]

void JLANG::JStorage< JClass_t, JNew >::release ( )

inlineprotectedinherited

Release memory.

Definition at line 91 of file JStorage.hh.

    { 
      memory_type::release(this->get());
    }

release() [2/2]

template<class JClass_t >

static void JLANG::JNew< JClass_t >::release ( JClass_t * p )

inlinestaticinherited

Release memory.

Parameters

p	pointer to data

Definition at line 41 of file JMemory.hh.

    {
      delete p;
    }

get()

template<class JClass_t >

virtual JClass_t * JLANG::JPointer< JClass_t >::get ( ) const

inlineoverridevirtualinherited

Get pointer.

Returns

pointer to object

Implements JLANG::JAbstractPointer< JClass_t >.

Reimplemented in JLANG::JMultiPointer< JClass_t >, JLANG::JMultiPointer< JHead_t >, JLANG::JMultiPointer< JTail_t >, JLANG::JMultiPointer< JTypeList< JDAQEvent, JNullType > >, JLANG::JMultiPointer< JTypeList< JHead_t, JTail_t > >, and JLANG::JMultiPointer< T >.

Definition at line 64 of file JPointer.hh.

    {
      return this->__p;
    }

getReference() [1/2]

template<class JClass_t >

JClass_t *const & JLANG::JPointer< JClass_t >::getReference ( ) const

inlineinherited

Get rereference to internal pointer.

Returns

reference to internal pointer

Definition at line 119 of file JPointer.hh.

    {
      return __p;
    }

getReference() [2/2]

template<class JClass_t >

JClass_t *& JLANG::JPointer< JClass_t >::getReference ( )

inlineinherited

Get rereference to internal pointer.

Returns

reference to internal pointer

Definition at line 130 of file JPointer.hh.

    {
      return __p;
    }

equals() [2/2]

template<class JClass_t >

virtual bool JLANG::JAbstractPointer< JClass_t >::equals ( const JAbstractPointer< JClass_t > & object ) const

inlinevirtualinherited

Equals.

The equality is evaluated by comparison of the internal pointers.

Parameters

object

abstract pointer

Returns

true if equals; else false

Definition at line 50 of file JAbstractPointer.hh.

    {
      return this->get() == object.get();
    }

is_valid()

template<class JClass_t >

bool JLANG::JAbstractPointer< JClass_t >::is_valid ( ) const

inlineinherited

Check validity of pointer.

Returns

true if pointer not null; else false

Definition at line 83 of file JAbstractPointer.hh.

    { 
      return this->get() != NULL; 
    }

operator->()

template<class JClass_t >

JClass_t * JLANG::JAbstractPointer< JClass_t >::operator-> ( ) const

inlineinherited

Smart pointer operator.

Returns

pointer to object

Definition at line 112 of file JAbstractPointer.hh.

    { 
      if (!is_valid())
        THROW(JNullPointerException, "JAbstractPointer::operator->()");
      else
        return this->get();
    }

operator JClass_t *()

template<class JClass_t >

JLANG::JAbstractPointer< JClass_t >::operator JClass_t * ( ) const

inlineinherited

Type conversion operator.

Returns

pointer to object

Definition at line 126 of file JAbstractPointer.hh.

    {
      return this->get();
    }

Member Data Documentation

end_marker

bool JEEP::JPropertiesElement::end_marker

private

Definition at line 467 of file JProperties.hh.

counter

int* JLANG::JSharedCounter::counter

protectedinherited

Definition at line 94 of file JSharedCounter.hh.

__p

template<class JClass_t >

JClass_t* JLANG::JPointer< JClass_t >::__p

protectedinherited

pointer to object

Definition at line 136 of file JPointer.hh.

---

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

• JProperties.hh