Jpp  15.0.5
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
JPARSER::JParserElement Class Reference

Auxiliary class to handle pointer to JPARSER::JParserElementInterface. More...

#include <JParser.hh>

Inheritance diagram for JPARSER::JParserElement:
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 JSharedPointer
< JParserElementInterface
JSharedPointer_t
 
typedef JPointer< JClass_t > pointer_type
 
typedef JStorage< JClass_t,
JMemory_t > 
storage_type
 
typedef JMemory_t< JClass_t > memory_type
 

Public Member Functions

 JParserElement ()
 Default constructor. More...
 
 JParserElement (const JParserElement &value)
 Copy constructor. More...
 
JParserElementoperator= (JParserElement &value)
 Assignment operator. More...
 
template<class JType_t >
JParserTemplateElement< JType_t > & operator= (JType_t &value)
 Assignment operator. More...
 
template<class JType_t >
JParserTemplateElement< JType_t > & operator= (const JParserTemplateElement< JType_t > &value)
 Assignment operator. More...
 
template<class JType_t >
JCSV< JType_t > operator= (const JCSV< JType_t > &value)
 Assignment operator. More...
 
const JParserElementoperator= (const initialised &value)
 Set initialised status to true. More...
 
const JParserElementoperator= (const not_initialised &value)
 Set initialised status to false. More...
 
void print (std::ostream &out) const
 Print. 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 () override
 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...
 
const int getCount ()
 Get count. 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 override
 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) override
 Set pointer. More...
 
void release ()
 Release memory. More...
 

Protected Attributes

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

Friends

std::istream & operator>> (std::istream &in, JParserElement &value)
 Stream input. More...
 
std::ostream & operator<< (std::ostream &out, const JParserElement &value)
 Stream output. More...
 

Detailed Description

Auxiliary class to handle pointer to JPARSER::JParserElementInterface.

Definition at line 1267 of file JParser.hh.

Member Typedef Documentation

Definition at line 1272 of file JParser.hh.

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.

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.

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

JPARSER::JParserElement::JParserElement ( )
inline

Default constructor.

Definition at line 1278 of file JParser.hh.

1278  :
1280  {}
JSharedPointer< JParserElementInterface > JSharedPointer_t
Definition: JParser.hh:1272
JPARSER::JParserElement::JParserElement ( const JParserElement value)
inline

Copy constructor.

Parameters
valuereference to JParserElement

Definition at line 1288 of file JParser.hh.

1288  :
1289  JSharedPointer_t(static_cast<const JSharedPointer_t&>(value))
1290  {}
JSharedPointer< JParserElementInterface > JSharedPointer_t
Definition: JParser.hh:1272

Member Function Documentation

JParserElement& JPARSER::JParserElement::operator= ( JParserElement value)
inline

Assignment operator.

Parameters
valuereference to JParserElement
Returns
this JParserElement

Definition at line 1299 of file JParser.hh.

1300  {
1301  JSharedPointer_t::operator=(static_cast<JSharedPointer_t&>(value));
1302 
1303  return *this;
1304  }
JSharedPointer & operator=(const JSharedPointer &object)
Assignment operator.
template<class JType_t >
JParserTemplateElement<JType_t>& JPARSER::JParserElement::operator= ( JType_t &  value)
inline

Assignment operator.

Parameters
valuereference to unnamed data object
Returns
corresponding new JParserTemplateElement object

Definition at line 1314 of file JParser.hh.

1315  {
1316  JParserTemplateElement<JType_t>* __p = new JParserTemplateElement<JType_t>(value);
1317 
1318  reset(__p);
1319 
1320  return *__p;
1321  }
JClass_t * __p
pointer to object
Definition: JPointer.hh:136
virtual void reset() override
Reset pointer.
template<class JType_t >
JParserTemplateElement<JType_t>& JPARSER::JParserElement::operator= ( const JParserTemplateElement< JType_t > &  value)
inline

Assignment operator.

Parameters
valuereference to JParserTemplateElement object
Returns
corresponding new JParserTemplateElement object

Definition at line 1331 of file JParser.hh.

1332  {
1333  JParserTemplateElement<JType_t>* __p = new JParserTemplateElement<JType_t>(value);
1334 
1335  reset(__p);
1336 
1337  return *__p;
1338  }
JClass_t * __p
pointer to object
Definition: JPointer.hh:136
virtual void reset() override
Reset pointer.
template<class JType_t >
JCSV<JType_t> JPARSER::JParserElement::operator= ( const JCSV< JType_t > &  value)
inline

Assignment operator.

Parameters
valuereference to a corresponding JCSV object
Returns
corresponding new comma separated values parser

Definition at line 1348 of file JParser.hh.

1349  {
1350  JParserTemplateElement<JType_t>* __p = new JParserTemplateElement<JType_t>(value);
1351 
1352  reset(__p);
1353 
1354  return JCSV<JType_t>(*__p);
1355  }
JClass_t * __p
pointer to object
Definition: JPointer.hh:136
virtual void reset() override
Reset pointer.
const JParserElement& JPARSER::JParserElement::operator= ( const initialised value)
inline

Set initialised status to true.

Parameters
valueinitialised object
Returns
this object

Definition at line 1364 of file JParser.hh.

1365  {
1366  if (!is_valid())
1367  THROW(JParserException, "No parser object defined.");
1368  else
1369  (*this)->setInitialiationStatus(true);
1370 
1371  return *this;
1372  }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:670
bool is_valid() const
Check validity of pointer.
Exception when parsing a value.
Definition: JException.hh:522
const JParserElement& JPARSER::JParserElement::operator= ( const not_initialised value)
inline

Set initialised status to false.

Parameters
valueinitialised object
Returns
this object

Definition at line 1381 of file JParser.hh.

1382  {
1383  (*this)->setInitialiationStatus(false);
1384 
1385  return *this;
1386  }
void JPARSER::JParserElement::print ( std::ostream &  out) const
inline

Print.

Parameters
outoutput stream
Returns
output stream

Definition at line 1427 of file JParser.hh.

1428  {
1429  if (is_valid()) {
1430  return get()->print(out);
1431  }
1432  }
bool is_valid() const
Check validity of pointer.
void print(std::ostream &out) const
Print.
Definition: JParser.hh:1427
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  }
The template JSharedPointer class can be used to share a pointer to an object.
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  }
The template JSharedPointer class can be used to share a pointer to an object.
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  }
void set(const JSharedPointer &object)
Set pointer.
bool is_valid() const
Check validity of pointer.
virtual void reset() override
Reset pointer.
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, JMemory_t >.

Definition at line 171 of file JSharedPointer.hh.

172  {
173  if (this->detach()) {
175  }
176 
178  }
virtual void reset() override
Reset pointer.
Definition: JStorage.hh:42
bool detach()
Detach.
virtual void reset() override
Reset pointer.
Definition: JPointer.hh:84
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  }
virtual JClass_t * get() const override
Get pointer.
Definition: JPointer.hh:64
virtual void reset() override
Reset pointer.
Definition: JPointer.hh:84
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 reset()=0
Reset pointer.
virtual void set(JClass_t *p)=0
Set pointer.
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  }
void attach(const JSharedCounter &object)
Attach this counter to given shared counter object.
virtual void set(JClass_t *p) override
Set pointer.
Definition: JPointer.hh:75
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
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.
virtual void set(JClass_t *p) override
Set pointer.
Definition: JPointer.hh:75
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  }
virtual void set(JClass_t *p) override
Set pointer.
Definition: JPointer.hh:75
virtual JClass_t * get() const override
Get pointer.
Definition: JPointer.hh:64
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  }
bool detach()
Detach.
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  }
bool detach()
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  }
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  }
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  }
bool is_valid() const
Check validity of pointer.
virtual void set(JClass_t *p) override
Set pointer.
Definition: JPointer.hh:75
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  }
virtual void reset() override
Reset pointer.
Definition: JStorage.hh:42
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  }
virtual void reset() override
Reset pointer.
Definition: JStorage.hh:42
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  }
template<class JClass_t>
virtual JClass_t* JLANG::JPointer< JClass_t >::get ( ) const
inlineoverridevirtualinherited
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  }
JClass_t * __p
pointer to object
Definition: JPointer.hh:136
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  }
JClass_t * __p
pointer to object
Definition: JPointer.hh:136
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  }
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  }
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  }
bool is_valid() const
Check validity of pointer.
Exception for null pointer operation.
Definition: JException.hh:216
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  }

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  in,
JParserElement value 
)
friend

Stream input.

Parameters
ininput stream
valueparser element
Returns
input stream

Definition at line 1396 of file JParser.hh.

1397  {
1398  if (value.is_valid())
1399  return value->read(in);
1400  else
1401  return in;
1402  }
then fatal Wrong number of arguments fi set_variable DETECTOR $argv[1] set_variable INPUT_FILE $argv[2] eval JPrintDetector a $DETECTOR O IDENTIFIER eval JPrintDetector a $DETECTOR O SUMMARY source JAcoustics sh $DETECTOR_ID CHECK_EXIT_CODE typeset A TRIPODS get_tripods $WORKDIR tripod txt TRIPODS for EMITTER in
Definition: JCanberra.sh:41
std::ostream& operator<< ( std::ostream &  out,
const JParserElement value 
)
friend

Stream output.

Parameters
outoutput stream
valueparser element
Returns
output stream

Definition at line 1412 of file JParser.hh.

1413  {
1414  if (value.is_valid())
1415  return value->write(out);
1416  else
1417  return out;
1418  }

Member Data Documentation

int* JLANG::JSharedCounter::counter
protectedinherited

Definition at line 94 of file JSharedCounter.hh.

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: