Jpp
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
JLANG::JAccessibleObjectWriter< T > Struct Template Referenceabstract

Auxiliary class for object writing with named access. More...

#include <JObjectWriter.hh>

Inheritance diagram for JLANG::JAccessibleObjectWriter< T >:
JLANG::JAccessibleObjectOutput< T > JLANG::JAbstractAccessibleObjectWriter< T > JLANG::JSharedPointer< JAccessibleObjectOutput< T > > JLANG::JObjectOutput< T > JLANG::JAccessible JLANG::JAccessibleObjectOutput< T > JLANG::JAbstractObjectWriter< T > JLANG::JSharedCounter JLANG::JStorage< JAccessibleObjectOutput< T >, JNew > JLANG::JThrow< JAccessible > JLANG::JObjectOutput< T > JLANG::JAccessible JLANG::JObjectOutput< T > JLANG::JPointer< JAccessibleObjectOutput< T > > JLANG::JNew< JAccessibleObjectOutput< T > > JLANG::JThrow< JAccessible > JLANG::JAbstractPointer< JAccessibleObjectOutput< T > > JLANG::JEquals< JAbstractPointer< JAccessibleObjectOutput< T > > > JSUPPORT::JFileRecorder< T >

Public Types

typedef JSharedPointer< JAccessibleObjectOutput< T > > helper_type
 
typedef JPointer< JAccessibleObjectOutput< T > > pointer_type
 
typedef JStorage< JAccessibleObjectOutput< T >, JNewstorage_type
 
typedef JNew< JAccessibleObjectOutput< T > > memory_type
 

Public Member Functions

 JAccessibleObjectWriter ()
 Default constructor. More...
 
virtual JAccessibleObjectOutput< T > * getHelper () const
 Get helper. More...
 
virtual bool put (const T &object)=0
 Object output. More...
 
virtual bool is_open () const =0
 Check is device is open. More...
 
virtual void open (const char *file_name)=0
 Open device. More...
 
virtual void close ()=0
 Close device. More...
 
virtual bool is_open () const
 Check is device is open. More...
 
virtual void open (const char *file_name)
 Open device. More...
 
virtual void close ()
 Close device. More...
 
virtual bool put (const T &object)
 Object output. 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...
 
void reset (const JPointer< T > &pointer)
 Reset pointer. More...
 
void reset (const JPointer< T > &pointer)
 Reset pointer. More...
 
void reset (JAccessibleObjectOutput< T > *p)
 Reset pointer. More...
 
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 JAccessibleObjectOutput< T > * get () const
 Get pointer. More...
 
JAccessibleObjectOutput< T > *const & getReference () const
 Get rereference to internal pointer. More...
 
JAccessibleObjectOutput< 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...
 
JAccessibleObjectOutput< T > * operator-> () const
 Smart pointer operator. More...
 
 operator JAccessibleObjectOutput< T > * () const
 Type conversion operator. More...
 

Static Public Member Functions

static void Throw (const bool option)
 Enable/disable throw option. More...
 
static int Throw (const JException &error, const int value=-1)
 Throw exception or return error. More...
 
static void release (JAccessibleObjectOutput< T > *p)
 Release memory. More...
 

Protected Member Functions

void set (const JSharedPointer &object)
 Set pointer. More...
 
virtual void set (JAccessibleObjectOutput< T > *p)
 Set pointer. More...
 
void release ()
 Release memory. More...
 

Protected Attributes

int * counter
 
JAccessibleObjectOutput< T > * __p
 pointer to object More...
 

Static Protected Attributes

static bool do_throw
 throw option More...
 

Detailed Description

template<class T>
struct JLANG::JAccessibleObjectWriter< T >

Auxiliary class for object writing with named access.

This class implements the JAbstractAccessibleObjectWriter interface.

Definition at line 58 of file JObjectWriter.hh.

Member Typedef Documentation

◆ helper_type

Definition at line 64 of file JObjectWriter.hh.

◆ pointer_type

Definition at line 34 of file JSharedPointer.hh.

◆ storage_type

Definition at line 35 of file JSharedPointer.hh.

◆ memory_type

Definition at line 33 of file JStorage.hh.

Constructor & Destructor Documentation

◆ JAccessibleObjectWriter()

template<class T >
JLANG::JAccessibleObjectWriter< T >::JAccessibleObjectWriter ( )
inline

Default constructor.

Definition at line 69 of file JObjectWriter.hh.

70  {}

Member Function Documentation

◆ getHelper()

template<class T >
virtual JAccessibleObjectOutput<T>* JLANG::JAccessibleObjectWriter< T >::getHelper ( ) const
inlinevirtual

Get helper.

Returns
helper

Implements JLANG::JAbstractAccessibleObjectWriter< T >.

Definition at line 78 of file JObjectWriter.hh.

79  {
80  return this->get();
81  }

◆ put() [1/2]

template<class T>
virtual bool JLANG::JObjectOutput< T >::put ( const T &  object)
pure virtualinherited

◆ is_open() [1/2]

virtual bool JLANG::JAccessible::is_open ( ) const
pure virtualinherited

◆ open() [1/2]

virtual void JLANG::JAccessible::open ( const char *  file_name)
pure virtualinherited

◆ close() [1/2]

virtual void JLANG::JAccessible::close ( )
pure virtualinherited

◆ Throw() [1/2]

static void JLANG::JThrow< JAccessible >::Throw ( const bool  option)
inlinestaticinherited

Enable/disable throw option.

Parameters
optiontrue enable; false disable

Definition at line 37 of file JThrow.hh.

38  {
39  do_throw = option;
40  }

◆ Throw() [2/2]

static int JLANG::JThrow< JAccessible >::Throw ( const JException error,
const int  value = -1 
)
inlinestaticinherited

Throw exception or return error.

Parameters
errorexception
valuereturn code
Returns
return code

Definition at line 50 of file JThrow.hh.

51  {
52  using namespace std;
53 
54  if (do_throw) {
55  throw error;
56  }
57 
58  cerr << error.what() << endl;
59 
60  return value;
61  }

◆ is_open() [2/2]

template<class T >
virtual bool JLANG::JAbstractAccessibleObjectWriter< T >::is_open ( ) const
inlinevirtualinherited

Check is device is open.

Returns
true if open; else false

Implements JLANG::JAccessible.

Definition at line 102 of file JAbstractObjectWriter.hh.

103  {
104  if (this->getHelper() != NULL)
105  return this->getHelper()->is_open();
106  else
107  return false;
108  }

◆ open() [2/2]

template<class T >
virtual void JLANG::JAbstractAccessibleObjectWriter< T >::open ( const char *  file_name)
inlinevirtualinherited

Open device.

Parameters
file_namefile name

Implements JLANG::JAccessible.

Reimplemented in JSUPPORT::JFileRecorder< T >.

Definition at line 116 of file JAbstractObjectWriter.hh.

117  {
118  if (this->getHelper() != NULL) {
119  this->getHelper()->open(file_name);
120  }
121  }

◆ close() [2/2]

template<class T >
virtual void JLANG::JAbstractAccessibleObjectWriter< T >::close ( )
inlinevirtualinherited

Close device.

Implements JLANG::JAccessible.

Definition at line 127 of file JAbstractObjectWriter.hh.

128  {
129  if (this->getHelper() != NULL) {
130  this->getHelper()->close();
131  }
132  }

◆ put() [2/2]

template<class T>
virtual bool JLANG::JAbstractObjectWriter< T >::put ( const T &  object)
inlinevirtualinherited

Object output.

Parameters
objectobject
Returns
true if OK; else false

Implements JLANG::JObjectOutput< T >.

Definition at line 43 of file JAbstractObjectWriter.hh.

44  {
45  return (this->getHelper() != NULL && this->getHelper()->put(object));
46  }

◆ getSharedPointer() [1/2]

const JSharedPointer& JLANG::JSharedPointer< JAccessibleObjectOutput< T > , JNew >::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]

JSharedPointer& JLANG::JSharedPointer< JAccessibleObjectOutput< T > , JNew >::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()

void JLANG::JSharedPointer< JAccessibleObjectOutput< T > , JNew >::setSharedPointer ( const JSharedPointer< JAccessibleObjectOutput< 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]

virtual void JLANG::JSharedPointer< JAccessibleObjectOutput< T > , JNew >::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< JAccessibleObjectOutput< T >, JNew >.

Definition at line 171 of file JSharedPointer.hh.

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

◆ reset() [2/5]

virtual void JLANG::JPointer< JAccessibleObjectOutput< T > >::reset
inlineinherited

Reset pointer.

Definition at line 84 of file JPointer.hh.

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

◆ reset() [3/5]

void JLANG::JPointer< JAccessibleObjectOutput< 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]

void JLANG::JPointer< JAccessibleObjectOutput< 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]

void JLANG::JAbstractPointer< JAccessibleObjectOutput< T > >::reset ( JAccessibleObjectOutput< 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]

void JLANG::JSharedPointer< JAccessibleObjectOutput< T > , JNew >::set ( const JSharedPointer< JAccessibleObjectOutput< 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]

virtual void JLANG::JSharedPointer< JAccessibleObjectOutput< T > , JNew >::set ( JAccessibleObjectOutput< 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< JAccessibleObjectOutput< T > >.

Definition at line 202 of file JSharedPointer.hh.

203  {
204  pointer_type::set(p);
205 
206  this->initialise();
207  }

◆ set() [3/3]

void JLANG::JPointer< JAccessibleObjectOutput< 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()

void JLANG::JStorage< JAccessibleObjectOutput< 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  }

◆ create() [1/2]

void JLANG::JStorage< JAccessibleObjectOutput< 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  {
71  this->reset(memory_type::create());
72  }

◆ create() [2/2]

void JLANG::JStorage< JAccessibleObjectOutput< 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< JAccessibleObjectOutput< T > , JNew >::release ( )
inlineprotectedinherited

Release memory.

Definition at line 91 of file JStorage.hh.

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

◆ release() [2/2]

static void JLANG::JNew< JAccessibleObjectOutput< T > >::release ( JAccessibleObjectOutput< T > *  p)
inlinestaticinherited

Release memory.

Parameters
ppointer to data

Definition at line 41 of file JMemory.hh.

42  {
43  delete p;
44  }

◆ get()

virtual JAccessibleObjectOutput< T > * JLANG::JPointer< JAccessibleObjectOutput< T > >::get ( ) const
inlinevirtualinherited

Get pointer.

Returns
pointer to object

Implements JLANG::JAbstractPointer< JAccessibleObjectOutput< T > >.

Definition at line 64 of file JPointer.hh.

65  {
66  return this->__p;
67  }

◆ getReference() [1/2]

JAccessibleObjectOutput< T > * const& JLANG::JPointer< JAccessibleObjectOutput< 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]

JAccessibleObjectOutput< T > * & JLANG::JPointer< JAccessibleObjectOutput< 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()

virtual bool JLANG::JAbstractPointer< JAccessibleObjectOutput< T > >::equals ( const JAbstractPointer< JAccessibleObjectOutput< 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()

bool JLANG::JAbstractPointer< JAccessibleObjectOutput< 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->()

JAccessibleObjectOutput< T > * JLANG::JAbstractPointer< JAccessibleObjectOutput< 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 JAccessibleObjectOutput< T > *()

JLANG::JAbstractPointer< JAccessibleObjectOutput< T > >::operator JAccessibleObjectOutput< 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

◆ do_throw

bool JLANG::JThrow< JAccessible >::do_throw
staticprotectedinherited

throw option

Set default throw option to true.

Definition at line 28 of file JThrow.hh.

◆ counter

int* JLANG::JSharedCounter::counter
protectedinherited

Definition at line 83 of file JSharedCounter.hh.

◆ __p

JAccessibleObjectOutput< T > * JLANG::JPointer< JAccessibleObjectOutput< T > >::__p
protectedinherited

pointer to object

Definition at line 136 of file JPointer.hh.


The documentation for this struct was generated from the following file:
JLANG::JSharedCounter::detach
bool detach()
Detach.
Definition: JSharedCounter.hh:63
JLANG::JPointer< JAccessibleObjectOutput< T > >::get
virtual JAccessibleObjectOutput< T > * get() const
Get pointer.
Definition: JPointer.hh:64
JLANG::JPointer< JAccessibleObjectOutput< T > >::__p
JAccessibleObjectOutput< T > * __p
pointer to object
Definition: JPointer.hh:136
JLANG::JAbstractObjectWriter::getHelper
virtual JObjectOutput< T > * getHelper() const =0
Get helper.
JLANG::JSharedCounter::counter
int * counter
Definition: JSharedCounter.hh:83
JLANG::JNullPointerException
Exception for null pointer operation.
Definition: JException.hh:216
JLANG::JAbstractPointer< JAccessibleObjectOutput< T > >::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
JLANG::JAbstractObjectWriter::put
virtual bool put(const T &object)
Object output.
Definition: JAbstractObjectWriter.hh:43
JLANG::JPointer< JAccessibleObjectOutput< T > >::reset
virtual void reset()
Reset pointer.
Definition: JPointer.hh:84
JLANG::JSharedCounter::initialise
void initialise()
Initialise counter.
Definition: JSharedCounter.hh:33
JDETECTOR::reset
void reset(JCLBInput &data, size_t size)
Reset CLB buffers.
Definition: JCLBSimulator.hh:41
JLANG::JAbstractAccessibleObjectWriter::getHelper
virtual JAccessibleObjectOutput< T > * getHelper() const =0
Get helper.
std
Definition: jaanetDictionary.h:36
JLANG::JSharedPointer< JAccessibleObjectOutput< T > >::reset
virtual void reset()
Reset pointer.
Definition: JSharedPointer.hh:171
JLANG::JThrow< JAccessible >::do_throw
static bool do_throw
throw option
Definition: JThrow.hh:28
JLANG::JException::what
virtual const char * what() const
Get error message.
Definition: JException.hh:48
JLANG::JStorage< JAccessibleObjectOutput< T >, JNew >::reset
virtual void reset()
Reset pointer.
Definition: JStorage.hh:42
JLANG::JAbstractPointer< JAccessibleObjectOutput< T > >::is_valid
bool is_valid() const
Check validity of pointer.
Definition: JAbstractPointer.hh:83