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

#include <JParser.hh>

Inheritance diagram for JPARSER::JParserElement:

Public Types
typedef JSharedPointer< JParserElementInterface >	JSharedPointer_t

typedef JPointer< JClass_t >	pointer_type

typedef JStorage< JClass_t, JMemory_t >	storage_type

typedef JNew< JClass_t >	memory_type

Public Member Functions
	JParserElement ()
	Default constructor. More...

	JParserElement (const JParserElement &value)
	Copy constructor. More...

JParserElement &	operator= (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 JParserElement &	operator= (const initialised &value)
	Set initialised status to true. More...

const JParserElement &	operator= (const not_initialised &value)
	Set initialised status to false. More...

void	print (std::ostream &out) const
	Print. More...

const JSharedPointer &	getSharedPointer () const
	Get shared pointer. More...

JSharedPointer &	getSharedPointer ()
	Get shared pointer. More...

void	setSharedPointer (const JSharedPointer &object)
	Set shared pointer. More...

virtual void	reset () override
	Reset pointer. More...

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

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

Static Public Member Functions
static void	release (JClass_t *p)
	Release memory. 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 1463 of file JParser.hh.

Member Typedef Documentation

◆ JSharedPointer_t

typedef JSharedPointer<JParserElementInterface> JPARSER::JParserElement::JSharedPointer_t

Definition at line 1468 of file JParser.hh.

◆ 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

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

inherited

Definition at line 33 of file JStorage.hh.

Constructor & Destructor Documentation

◆ JParserElement() [1/2]

JPARSER::JParserElement::JParserElement ( )

inline

Default constructor.

Definition at line 1474 of file JParser.hh.

                      :
       JSharedPointer_t()
     {}

◆ JParserElement() [2/2]

JPARSER::JParserElement::JParserElement ( const JParserElement & value )

inline

Copy constructor.

Parameters

value reference to JParserElement

Definition at line 1484 of file JParser.hh.

                                                 :
       JSharedPointer_t(static_cast<const JSharedPointer_t&>(value))
     {}

Member Function Documentation

◆ operator=() [1/6]

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

inline

Assignment operator.

Parameters

value reference to JParserElement

Returns: this JParserElement

Definition at line 1495 of file JParser.hh.

     {
       JSharedPointer_t::operator=(static_cast<JSharedPointer_t&>(value));
  
       return *this;
     }

◆ operator=() [2/6]

template<class JType_t >

JParserTemplateElement<JType_t>& JPARSER::JParserElement::operator= ( JType_t & value )

inline

Assignment operator.

Parameters

value reference to unnamed data object

Returns: corresponding new JParserTemplateElement object

Definition at line 1510 of file JParser.hh.

     {
       JParserTemplateElement<JType_t>* __p = new JParserTemplateElement<JType_t>(value);
  
       reset(__p);
  
       return *__p;
     }

◆ operator=() [3/6]

template<class JType_t >

JParserTemplateElement<JType_t>& JPARSER::JParserElement::operator= ( const JParserTemplateElement< JType_t > & value )

inline

Assignment operator.

Parameters

value reference to JParserTemplateElement object

Returns: corresponding new JParserTemplateElement object

Definition at line 1527 of file JParser.hh.

     {
       JParserTemplateElement<JType_t>* __p = new JParserTemplateElement<JType_t>(value);
  
       reset(__p);
  
       return *__p;
     }

◆ operator=() [4/6]

template<class JType_t >

JCSV<JType_t> JPARSER::JParserElement::operator= ( const JCSV< JType_t > & value )

inline

Assignment operator.

Parameters

value reference to a corresponding JCSV object

Returns: corresponding new comma separated values parser

Definition at line 1544 of file JParser.hh.

     {
       JParserTemplateElement<JType_t>* __p = new JParserTemplateElement<JType_t>(value);
  
       reset(__p);
  
       return JCSV<JType_t>(*__p);
     }

◆ operator=() [5/6]

const JParserElement& JPARSER::JParserElement::operator= ( const initialised & value )

inline

Set initialised status to true.

Parameters

value initialised object

Returns: this object

Definition at line 1560 of file JParser.hh.

     {
       if (!is_valid())
         THROW(JParserException, "No parser object defined.");
       else
         (*this)->setInitialiationStatus(true);
  
       return *this;
     }

◆ operator=() [6/6]

const JParserElement& JPARSER::JParserElement::operator= ( const not_initialised & value )

inline

Set initialised status to false.

Parameters

value initialised object

Returns: this object

Definition at line 1577 of file JParser.hh.

     {
       (*this)->setInitialiationStatus(false);
  
       return *this;
     }

◆ print()

void JPARSER::JParserElement::print ( std::ostream & out ) const

inline

Print.

Parameters

out	output stream

Definition at line 1622 of file JParser.hh.

     { 
       if (is_valid()) {
         return get()->print(out);
       }
     }

◆ 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/4]

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/4]

void JLANG::JPointer< JClass_t >::reset ( class T )

inlineinherited

Reset pointer.

Parameters

pointer pointer to object

Definition at line 35 of file JPointer.hh.

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

◆ reset() [3/4]

template<class JClass_t >

template<class T >

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

inlineinherited

Reset pointer.

Parameters

pointer pointer to object

Definition at line 108 of file JPointer.hh.

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

◆ reset() [4/4]

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< JTypeList< JHead_t, JTail_t > >, JLANG::JMultiPointer< JClass_t >, JLANG::JMultiPointer< JTail_t >, JLANG::JMultiPointer< JHead_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()

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();
     }

Friends And Related Function Documentation

◆ operator>>

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

friend

Stream input.

Parameters

in	input stream
value	parser element

Returns: input stream

Definition at line 1592 of file JParser.hh.

     {
       if (value.is_valid())
         return value->read(in);
       else
         return in;
     }

◆ operator<<

std::ostream& operator<<	(	std::ostream &	out,
		const JParserElement &	value
	)

friend

Stream output.

Parameters

out	output stream
value	parser element

Returns: output stream

Definition at line 1608 of file JParser.hh.

     { 
       if (value.is_valid())
         return value->write(out);
       else
         return out;
     }

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:

JParser.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ JSharedPointer_t

◆ pointer_type

◆ storage_type

◆ memory_type

Constructor & Destructor Documentation

◆ JParserElement() [1/2]

◆ JParserElement() [2/2]

Member Function Documentation

◆ operator=() [1/6]

◆ operator=() [2/6]

◆ operator=() [3/6]

◆ operator=() [4/6]

◆ operator=() [5/6]

◆ operator=() [6/6]

◆ print()

◆ getSharedPointer() [1/2]

◆ getSharedPointer() [2/2]

◆ setSharedPointer()

◆ reset() [1/4]

◆ reset() [2/4]

◆ reset() [3/4]

◆ reset() [4/4]

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ initialise()

◆ attach()

◆ detach()

◆ getCount()

◆ recreate()

◆ create() [1/2]

◆ create() [2/2]

◆ release() [1/2]

◆ release() [2/2]

◆ get()

◆ getReference() [1/2]

◆ getReference() [2/2]

◆ equals()

◆ is_valid()

◆ operator->()

◆ operator JClass_t *()

Friends And Related Function Documentation

◆ operator>>

◆ operator<<

Member Data Documentation

◆ counter

◆ __p