Jpp 19.3.0-rc.1
the software that should make you happy
Loading...
Searching...
No Matches
JLANG::JSharedPointer< JClass_t, JMemory_t > Class Template Reference

The template JSharedPointer class can be used to share a pointer to an object. More...

#include <JSharedPointer.hh>

Inheritance diagram for JLANG::JSharedPointer< JClass_t, JMemory_t >:
JLANG::JSharedCounter JLANG::JStorage< JClass_t, JNew > JLANG::JPointer< JClass_t > JLANG::JNew< JClass_t > JLANG::JAbstractPointer< JClass_t > JLANG::JEquals< JAbstractPointer< JClass_t > > JEEP::JPropertiesElement JPARSER::JParserElement JPHYSICS::JACoeffSource JPHYSICS::JRadiationSource JTOOLS::JAbstractAutoPointer< JBase_t > JTOOLS::JAutoElement< JBase_t > JTOOLS::JAutoPointer< JDerived_t, JBase_t >

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

 JSharedPointer ()
 Default constructor.
 
 JSharedPointer (const JSharedPointer &object)
 Copy constructor.
 
template<class JDerived_t >
 JSharedPointer (JDerived_t *p)
 Assignment constructor.
 
 ~JSharedPointer ()
 Destructor.
 
const JSharedPointergetSharedPointer () const
 Get shared pointer.
 
JSharedPointergetSharedPointer ()
 Get shared pointer.
 
void setSharedPointer (const JSharedPointer &object)
 Set shared pointer.
 
JSharedPointeroperator= (const JSharedPointer &object)
 Assignment operator.
 
template<class JDerived_t >
JSharedPointeroperator= (JDerived_t *p)
 Assignment operator.
 
virtual void reset () override
 Reset 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 reset (const JPointer< T > &pointer)
 Reset pointer.
 
void reset (JClass_t *p)
 Reset pointer.
 
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.
 
template<class T >
void set (const JPointer< T > &pointer)
 Set 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
 

Detailed Description

template<class JClass_t, template< class > class JMemory_t = JNew>
class JLANG::JSharedPointer< JClass_t, JMemory_t >

The template JSharedPointer class can be used to share a pointer to an object.

The object pointed to is deleted when the shared counter is zero, i.e. when no-one shares the object. It is possible to create a container with shared pointers. The first template argument refers to the data type pointed to and the second to the memory management policy.

Definition at line 28 of file JSharedPointer.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

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

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

◆ JSharedPointer() [1/3]

template<class JClass_t , template< class > class JMemory_t = JNew>
JLANG::JSharedPointer< JClass_t, JMemory_t >::JSharedPointer ( )
inline

Default constructor.

Definition at line 43 of file JSharedPointer.hh.

44 {}

◆ JSharedPointer() [2/3]

template<class JClass_t , template< class > class JMemory_t = JNew>
JLANG::JSharedPointer< JClass_t, JMemory_t >::JSharedPointer ( const JSharedPointer< JClass_t, JMemory_t > & object)
inline

Copy constructor.

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

Parameters
objectshared pointer

Definition at line 53 of file JSharedPointer.hh.

54 {
55 if (object.is_valid()) {
56 this->set(object);
57 }
58 }
bool is_valid() const
Check validity of pointer.
void set(const JSharedPointer &object)
Set pointer.

◆ JSharedPointer() [3/3]

template<class JClass_t , template< class > class JMemory_t = JNew>
template<class JDerived_t >
JLANG::JSharedPointer< JClass_t, JMemory_t >::JSharedPointer ( JDerived_t * p)
inline

Assignment constructor.

If the pointer is valid, the reference counter of the shared object pointed to is initialised to one.

Parameters
ppointer to derived class object

Definition at line 69 of file JSharedPointer.hh.

70 {
71 if (p != NULL) {
72 this->set(p);
73 }
74 }

◆ ~JSharedPointer()

template<class JClass_t , template< class > class JMemory_t = JNew>
JLANG::JSharedPointer< JClass_t, JMemory_t >::~JSharedPointer ( )
inline

Destructor.

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

Definition at line 82 of file JSharedPointer.hh.

83 {
84 if (this->detach()) {
86 }
87 }
virtual void reset() override
Reset pointer.
Definition JStorage.hh:42

Member Function Documentation

◆ getSharedPointer() [1/2]

template<class JClass_t , template< class > class JMemory_t = JNew>
const JSharedPointer & JLANG::JSharedPointer< JClass_t, JMemory_t >::getSharedPointer ( ) const
inline

Get shared pointer.

Returns
this shared pointer

Definition at line 95 of file JSharedPointer.hh.

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

◆ getSharedPointer() [2/2]

template<class JClass_t , template< class > class JMemory_t = JNew>
JSharedPointer & JLANG::JSharedPointer< JClass_t, JMemory_t >::getSharedPointer ( )
inline

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)
inline

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 }
virtual JClass_t * get() const override
Get pointer.
Definition JPointer.hh:64
virtual void reset() override
Reset pointer.

◆ operator=() [1/2]

template<class JClass_t , template< class > class JMemory_t = JNew>
JSharedPointer & JLANG::JSharedPointer< JClass_t, JMemory_t >::operator= ( const JSharedPointer< JClass_t, JMemory_t > & object)
inline

Assignment operator.

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

Parameters
objectshared pointer
Returns
this shared pointer

Definition at line 139 of file JSharedPointer.hh.

140 {
141 this->setSharedPointer(object);
142
143 return *this;
144 }
void setSharedPointer(const JSharedPointer &object)
Set shared pointer.

◆ operator=() [2/2]

template<class JClass_t , template< class > class JMemory_t = JNew>
template<class JDerived_t >
JSharedPointer & JLANG::JSharedPointer< JClass_t, JMemory_t >::operator= ( JDerived_t * p)
inline

Assignment operator.

The reference counter is decremented by one and the object pointed to previously is deleted when its reference counter is zero. If the pointer is valid, the reference counter of the shared object pointed to is initialised to one.

Parameters
ppointer to derived class object
Returns
this shared pointer

Definition at line 158 of file JSharedPointer.hh.

159 {
160 this->reset(p);
161
162 return *this;
163 }

◆ reset() [1/3]

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

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.

172 {
173 if (this->detach()) {
175 }
176
178 }
virtual void reset() override
Reset pointer.
Definition JPointer.hh:84

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

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 }
virtual void set(JClass_t *p) override
Set pointer.
Definition JPointer.hh:75
void attach(const JSharedCounter &object)
Attach this counter to given shared counter 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)
inlineoverrideprotectedvirtual

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 }
void initialise()
Initialise counter.

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

◆ getCount()

const int JLANG::JSharedCounter::getCount ( )
inlineinherited

Get count.

Returns
count

Definition at line 88 of file JSharedCounter.hh.

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

◆ reset() [2/3]

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

Reset pointer.

Parameters
pointerpointer to object

Definition at line 35 of file JPointer.hh.

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

◆ reset() [3/3]

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 }
virtual void set(JClass_t *p)=0
Set pointer.
virtual JClass_t * get() const =0
Get pointer.
virtual void reset()=0
Reset pointer.

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

58 {
59 if (!this->is_valid()) {
60 this->set(memory_type::create());
61 }
62 }
static JClass_t * create()
Create object in memory.
Definition JMemory.hh:30

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

70 {
72 }

◆ 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
sizenumber of elements

Definition at line 81 of file JStorage.hh.

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

◆ release() [1/2]

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

Release memory.

Definition at line 91 of file JStorage.hh.

92 {
93 memory_type::release(this->get());
94 }
static void release(JClass_t *p)
Release memory.
Definition JMemory.hh:41

◆ release() [2/2]

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

Release memory.

Parameters
ppointer to data

Definition at line 41 of file JMemory.hh.

42 {
43 delete p;
44 }

◆ get()

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

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

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

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 }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.

◆ 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

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