Jpp
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
JEEP::JPropertiesElement Class Reference

The property value class. More...

#include <JProperties.hh>

Inheritance diagram for JEEP::JPropertiesElement:
JLANG::JSharedPointer< JClass_t, JMemory_t > JLANG::JSharedCounter JLANG::JStorage< JClass_t, JMemory_t > JLANG::JPointer< JClass_t > JLANG::JAbstractPointer< JClass_t > JLANG::JEquals< JAbstractPointer< JClass_t > >

Public Types

typedef JPointer< JClass_t > pointer_type
 
typedef JStorage< JClass_t, JMemory_t > storage_type
 
typedef JMemory_t< JClass_t > memory_type
 

Public Member Functions

 JPropertiesElement ()
 Default constructor. More...
 
template<class T >
 JPropertiesElement (T &value)
 Constructor. More...
 
bool equals (const JPropertiesElement &element) const
 Equality between property elements. More...
 
template<class T >
JPropertiesElementoperator= (T &value)
 Assignment operator. More...
 
template<class T >
const T & getValue () const
 Get value. More...
 
template<class T >
T & getValue ()
 Get value. More...
 
template<class T >
void setValue (const T &value)
 Set value of this JPropertiesElement. More...
 
std::string toString () const
 Convert to string. More...
 
template<class T >
toValue () const
 Convert to template type. More...
 
template<class T >
 operator const T & () const
 Type conversion operator. More...
 
bool getEndMarker () const
 Get end marker. More...
 
void setEndMarker (const bool marker)
 Set end marker. More...
 
const JSharedPointergetSharedPointer () const
 Get shared pointer. More...
 
JSharedPointergetSharedPointer ()
 Get shared pointer. More...
 
void setSharedPointer (const JSharedPointer &object)
 Set shared pointer. More...
 
virtual void reset ()
 Reset pointer. More...
 
virtual void reset ()
 Reset pointer. More...
 
template<class T >
void reset (const JPointer< T > &pointer)
 Reset pointer. More...
 
template<class T >
void reset (const JPointer< T > &pointer)
 Reset pointer. More...
 
void reset (JClass_t *p)
 Reset pointer. More...
 
template<class T >
void set (const JPointer< T > &pointer)
 Set pointer. More...
 
void initialise ()
 Initialise counter. More...
 
void attach (const JSharedCounter &object)
 Attach this counter to given shared counter object. More...
 
bool detach ()
 Detach. More...
 
void recreate ()
 Recreate object in memory. More...
 
void create ()
 Create object in memory. More...
 
void create (const unsigned int size)
 Create array of objects in memory. More...
 
virtual JClass_t * get () const
 Get pointer. More...
 
JClass_t *const & getReference () const
 Get rereference to internal pointer. More...
 
JClass_t *& getReference ()
 Get rereference to internal pointer. More...
 
virtual bool equals (const JAbstractPointer &object) const
 Equals. More...
 
bool is_valid () const
 Check validity of pointer. More...
 
JClass_t * operator-> () const
 Smart pointer operator. More...
 
 operator JClass_t * () const
 Type conversion operator. More...
 

Protected Member Functions

void set (const JSharedPointer &object)
 Set pointer. More...
 
virtual void set (JClass_t *p)
 Set pointer. More...
 
void release ()
 Release memory. More...
 

Protected Attributes

int * counter
 
JClass_t * __p
 pointer to object More...
 

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

Member Typedef Documentation

◆ pointer_type

template<class JClass_t, template< class > class JMemory_t = JNew>
typedef 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>
typedef JStorage<JClass_t, JMemory_t> JLANG::JSharedPointer< JClass_t, JMemory_t >::storage_type
inherited

Definition at line 35 of file JSharedPointer.hh.

◆ memory_type

template<class JClass_t, template< class > class JMemory_t = JNew>
typedef JMemory_t<JClass_t> JLANG::JStorage< JClass_t, JMemory_t >::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 300 of file JProperties.hh.

300  :
301  end_marker(false)
302  {}

◆ JPropertiesElement() [2/2]

template<class T >
JEEP::JPropertiesElement::JPropertiesElement ( T &  value)
inline

Constructor.

Parameters
valuereference to template object

Definition at line 311 of file JProperties.hh.

311  :
312  end_marker(false)
313  {
315  }

Member Function Documentation

◆ equals() [1/2]

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

Equality between property elements.

Parameters
elementproperties element
Returns
true if equal; else false

Definition at line 324 of file JProperties.hh.

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

◆ operator=()

template<class T >
JPropertiesElement& JEEP::JPropertiesElement::operator= ( T &  value)
inline

Assignment operator.

Parameters
valuereference to template object
Returns
this JPropertiesElement

Definition at line 337 of file JProperties.hh.

338  {
340 
341  return *this;
342  }

◆ getValue() [1/2]

template<class T >
const T& JEEP::JPropertiesElement::getValue ( ) const
inline

Get value.

Returns
value of this JPropertiesElement

Definition at line 351 of file JProperties.hh.

352  {
353  const JPropertiesTemplateElement<T>* p = dynamic_cast<const JPropertiesTemplateElement<T>*>(this->get());
354 
355  if (p != NULL)
356  return p->object;
357  else
358  THROW(JPropertiesException, "Inconsistent data type.");
359  }

◆ getValue() [2/2]

template<class T >
T& JEEP::JPropertiesElement::getValue ( )
inline

Get value.

Returns
value of this JPropertiesElement

Definition at line 368 of file JProperties.hh.

369  {
371 
372  if (p != NULL)
373  return p->object;
374  else
375  THROW(JPropertiesException, "Inconsistent data type.");
376  }

◆ setValue()

template<class T >
void JEEP::JPropertiesElement::setValue ( const T &  value)
inline

Set value of this JPropertiesElement.

Parameters
valuevalue

Definition at line 386 of file JProperties.hh.

387  {
389 
390  if (p != NULL)
391  p->object = value;
392  else
393  THROW(JPropertiesException, "Inconsistent data type.");
394  }

◆ toString()

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

Convert to string.

Returns
value of this JPropertiesElement

Definition at line 402 of file JProperties.hh.

403  {
404  std::ostringstream os;
405 
406  get()->write(os, "", '\0');
407 
408  return os.str();
409  }

◆ toValue()

template<class T >
T JEEP::JPropertiesElement::toValue ( ) const
inline

Convert to template type.

Returns
value of this JPropertiesElement

Definition at line 418 of file JProperties.hh.

419  {
420  T value;
421 
422  std::istringstream in(this->toString());
423 
424  in >> value;
425 
426  return value;
427  }

◆ operator const T &()

template<class T >
JEEP::JPropertiesElement::operator const T & ( ) const
inline

Type conversion operator.

Returns
value of this JPropertiesElement

Definition at line 436 of file JProperties.hh.

437  {
438  return getValue<T>();
439  }

◆ getEndMarker()

bool JEEP::JPropertiesElement::getEndMarker ( ) const
inline

Get end marker.

Returns
end marker

Definition at line 447 of file JProperties.hh.

448  {
449  return end_marker;
450  }

◆ setEndMarker()

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

Set end marker.

Parameters
markerif true stop reading after this properties element, else continue

Definition at line 458 of file JProperties.hh.

459  {
460  end_marker = marker;
461  }

◆ 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.

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

◆ 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.

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

◆ 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
objectshared pointer

Definition at line 117 of file JSharedPointer.hh.

118  {
119  if (this->get() != object.get()) {
120 
121  this->reset();
122 
123  if (object.is_valid()) {
124  this->set(object);
125  }
126  }
127  }

◆ reset() [1/5]

template<class JClass_t, template< class > class JMemory_t = JNew>
virtual void JLANG::JSharedPointer< JClass_t, JMemory_t >::reset ( )
inlinevirtualinherited

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, JMemory_t >.

Definition at line 171 of file JSharedPointer.hh.

172  {
173  if (this->detach()) {
175  }
176 
178  }

◆ reset() [2/5]

template<class JClass_t, template< class > class JMemory_t = JNew>
virtual void JLANG::JPointer< JClass_t >::reset
inlineinherited

Reset pointer.

Definition at line 84 of file JPointer.hh.

85  {
86  this->__p = NULL;
87  }

◆ reset() [3/5]

template<class JClass_t, template< class > class JMemory_t = JNew>
template<class T >
void JLANG::JPointer< JClass_t >::reset ( class T  )
inlineinherited

Reset pointer.

Parameters
pointerpointer to object

Definition at line 108 of file JPointer.hh.

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

◆ reset() [4/5]

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

Reset pointer.

Parameters
pointerpointer to object

Definition at line 108 of file JPointer.hh.

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

◆ reset() [5/5]

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

Reset pointer.

Parameters
ppointer to object

Definition at line 94 of file JAbstractPointer.hh.

95  {
96  if (this->get() != p) {
97 
98  this->reset();
99 
100  if (p != NULL) {
101  this->set(p);
102  }
103  }
104  }

◆ 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
objectshared pointer

Definition at line 188 of file JSharedPointer.hh.

189  {
190  pointer_type::set(object.get());
191 
192  this->attach(object);
193  }

◆ 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)
inlineprotectedvirtualinherited

Set pointer.

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

Parameters
ppointer to derived class object

Reimplemented from JLANG::JPointer< JClass_t >.

Definition at line 202 of file JSharedPointer.hh.

203  {
205 
206  this->initialise();
207  }

◆ set() [3/3]

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

Set pointer.

Parameters
pointerpointer to object

Definition at line 96 of file JPointer.hh.

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

◆ initialise()

void JLANG::JSharedCounter::initialise ( )
inlineinherited

Initialise counter.

Definition at line 33 of file JSharedCounter.hh.

34  {
35  detach();
36 
37  counter = new int(1);
38  }

◆ attach()

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

Attach this counter to given shared counter object.

Parameters
objectshared counter

Definition at line 46 of file JSharedCounter.hh.

47  {
48  detach();
49 
50  counter = object.counter;
51 
52  if (counter != NULL) {
53  ++(*counter);
54  }
55  }

◆ detach()

bool JLANG::JSharedCounter::detach ( )
inlineinherited

Detach.

Returns
true if counter at zero; else false

Definition at line 63 of file JSharedCounter.hh.

64  {
65  if (counter != NULL) {
66 
67  if (--(*counter) == 0) {
68 
69  delete counter;
70 
71  counter = NULL;
72 
73  return true;
74  }
75 
76  counter = NULL;
77  }
78 
79  return false;
80  }

◆ recreate()

template<class JClass_t, template< class > class JMemory_t = JNew>
void JLANG::JStorage< JClass_t, JMemory_t >::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.

58  {
59  if (!this->is_valid()) {
60  this->set(memory_type::create());
61  }
62  }

◆ create() [1/2]

template<class JClass_t, template< class > class JMemory_t = JNew>
void JLANG::JStorage< JClass_t, JMemory_t >::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.

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

◆ create() [2/2]

template<class JClass_t, template< class > class JMemory_t = JNew>
void JLANG::JStorage< JClass_t, JMemory_t >::create ( const unsigned int  size)
inlineinherited

Create array of objects in memory.

The memory allocated by previously created objects will be released.

Parameters
sizenumber of elements

Definition at line 81 of file JStorage.hh.

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

◆ release()

template<class JClass_t, template< class > class JMemory_t = JNew>
void JLANG::JStorage< JClass_t, JMemory_t >::release ( )
inlineprotectedinherited

Release memory.

Definition at line 91 of file JStorage.hh.

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

◆ get()

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

◆ 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.

120  {
121  return __p;
122  }

◆ 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.

131  {
132  return __p;
133  }

◆ 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
objectabstract pointer
Returns
true if equals; else false

Definition at line 50 of file JAbstractPointer.hh.

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

◆ 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.

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

◆ 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.

113  {
114  if (!is_valid())
115  throw JNullPointerException("JAbstractPointer::operator->()");
116  else
117  return this->get();
118  }

◆ 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.

127  {
128  return this->get();
129  }

Member Data Documentation

◆ end_marker

bool JEEP::JPropertiesElement::end_marker
private

Definition at line 465 of file JProperties.hh.

◆ counter

int* JLANG::JSharedCounter::counter
protectedinherited

Definition at line 83 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:
JLANG::JSharedCounter::detach
bool detach()
Detach.
Definition: JSharedCounter.hh:63
JLANG::JPointer::set
virtual void set(JClass_t *p)
Set pointer.
Definition: JPointer.hh:75
JLANG::JPointer::get
virtual JClass_t * get() const
Get pointer.
Definition: JPointer.hh:64
JLANG::JPointer::__p
JClass_t * __p
pointer to object
Definition: JPointer.hh:136
JLANG::JSharedPointer::set
void set(const JSharedPointer &object)
Set pointer.
Definition: JSharedPointer.hh:188
JLANG::JSharedCounter::counter
int * counter
Definition: JSharedCounter.hh:83
JLANG::JNullPointerException
Exception for null pointer operation.
Definition: JException.hh:216
JLANG::JAbstractPointer::reset
virtual void reset()=0
Reset pointer.
JLANG::JSharedCounter::attach
void attach(const JSharedCounter &object)
Attach this counter to given shared counter object.
Definition: JSharedCounter.hh:46
JEEP::JPropertiesTemplateElement
Template class for I/O of properties element.
Definition: JProperties.hh:110
JLANG::JPointer::reset
virtual void reset()
Reset pointer.
Definition: JPointer.hh:84
THROW
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:669
JEEP::JPropertiesTemplateElement::object
T & object
Definition: JProperties.hh:198
JLANG::JSharedCounter::initialise
void initialise()
Initialise counter.
Definition: JSharedCounter.hh:33
JLANG::JAbstractPointer::get
virtual JClass_t * get() const =0
Get pointer.
JLANG::JSharedPointer::reset
virtual void reset()
Reset pointer.
Definition: JSharedPointer.hh:171
JEEP::JPropertiesElement::end_marker
bool end_marker
Definition: JProperties.hh:465
JEEP::JPropertiesElement::toString
std::string toString() const
Convert to string.
Definition: JProperties.hh:402
JLANG::JStorage::reset
virtual void reset()
Reset pointer.
Definition: JStorage.hh:42
JLANG::JAbstractPointer::is_valid
bool is_valid() const
Check validity of pointer.
Definition: JAbstractPointer.hh:83
JLANG::JAbstractPointer::set
virtual void set(JClass_t *p)=0
Set pointer.