Jpp test-rotations-old
the software that should make you happy
Loading...
Searching...
No Matches
JIO::JBinaryFileWriter< T > Class Template Referenceabstract

Object(s) writing to binary file (i.e. .jpp). More...

#include <JBinaryFileWriter.hh>

Inheritance diagram for JIO::JBinaryFileWriter< T >:
JLANG::JAccessibleObjectOutput< T > JLANG::JAccessibleBinaryOutputStream JIO::JStreamWriter JIO::JBinaryWriter< T > JLANG::JObjectOutput< T > JLANG::JAccessible JLANG::JAccessibleOutputStream JIO::JWriter JIO::JBinaryWriterObjectOutput< T, bool > JLANG::JThrow< JAccessible > JLANG::JAccessible JLANG::JBinaryOutput JLANG::JAbstractObjectStatus JLANG::JThrow< JAccessible >

Public Member Functions

 JBinaryFileWriter ()
 Default constructor.
 
virtual void open (const char *file_name) override
 Open file.
 
virtual bool is_open () const
 Check is file is open.
 
virtual void close ()
 Close file.
 
virtual bool put (const T &object)=0
 Object output.
 

Static Public Member Functions

static void Throw (const bool option)
 Enable/disable throw option.
 
static int Throw (const JException_t &error, const int value=-1)
 Throw exception or return error.
 

Protected Member Functions

virtual bool getStatus () const override
 Status of writer.
 
virtual int write (const char *buffer, const int length) override
 Write byte array.
 
JWriteroperator<< (const JSerialisable &object)
 Write serialisable data object.
 
JWriteroperator<< (const bool value)
 
JWriteroperator<< (const char value)
 
JWriteroperator<< (const unsigned char value)
 
JWriteroperator<< (const short value)
 
JWriteroperator<< (const unsigned short value)
 
JWriteroperator<< (const int value)
 
JWriteroperator<< (const unsigned int value)
 
JWriteroperator<< (const long int value)
 
JWriteroperator<< (const unsigned long int value)
 
JWriteroperator<< (const long long int value)
 
JWriteroperator<< (const unsigned long long int value)
 
JWriteroperator<< (const float value)
 
JWriteroperator<< (const double value)
 
JWriteroperator<< (const long double value)
 
JWriteroperator<< (const JLANG::JObjectID &value)
 
JWriterstore (const JSerialisable &object)
 Write object.
 
template<class T >
JWriterstore (const T &object)
 Write object.
 
 operator bool () const
 Type conversion operator.
 
bool operator! () const
 Negated status of this object.
 

Protected Attributes

std::ostream & out
 

Static Protected Attributes

static bool do_throw
 throw option
 

Detailed Description

template<class T>
class JIO::JBinaryFileWriter< T >

Object(s) writing to binary file (i.e. .jpp).

This class implements the JLANG::JAccessibleObjectOutput interface.

Definition at line 153 of file JBinaryFileWriter.hh.

Constructor & Destructor Documentation

◆ JBinaryFileWriter()

template<class T >
JIO::JBinaryFileWriter< T >::JBinaryFileWriter ( )
inline

Default constructor.

Definition at line 163 of file JBinaryFileWriter.hh.

163 :
165 JStreamWriter (static_cast<std::ostream&>(*this)),
166 JBinaryWriter<T>(static_cast<JWriter&> (*this))
167 {}
JBinaryWriter(JWriter &writer)
Constructor.
JStreamWriter(std::ostream &__out)
Constructor.
Definition JStreamIO.hh:90

Member Function Documentation

◆ open()

virtual void JLANG::JAccessibleBinaryOutputStream::open ( const char * file_name)
inlineoverridevirtualinherited

Open file.

Parameters
file_namefile name

Reimplemented from JLANG::JAccessibleOutputStream.

Definition at line 92 of file JAccessibleBinaryStream.hh.

93 {
94 std::ofstream::open(file_name, std::ios::binary);
95 }

◆ is_open()

virtual bool JLANG::JAccessibleOutputStream::is_open ( ) const
inlinevirtualinherited

Check is file is open.

Returns
true if open; else false

Implements JLANG::JAccessible.

Definition at line 118 of file JAccessibleStream.hh.

119 {
120 return std::ofstream::is_open();
121 }

◆ close()

virtual void JLANG::JAccessibleOutputStream::close ( )
inlinevirtualinherited

Close file.

Implements JLANG::JAccessible.

Definition at line 142 of file JAccessibleStream.hh.

143 {
144 std::ofstream::close();
145 }

◆ 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_t & error,
const int value = -1 )
inlinestaticinherited

Throw exception or return error.

Parameters
errorexception
valuereturn code
Returns
return code

Definition at line 51 of file JThrow.hh.

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

◆ getStatus()

virtual bool JIO::JStreamWriter::getStatus ( ) const
inlineoverridevirtualinherited

Status of writer.

Returns
status of this writer

Implements JLANG::JAbstractObjectStatus.

Definition at line 100 of file JStreamIO.hh.

101 {
102 return (bool) out;
103 }
std::ostream & out
Definition JStreamIO.hh:121

◆ write()

virtual int JIO::JStreamWriter::write ( const char * buffer,
const int length )
inlineoverridevirtualinherited

Write byte array.

Parameters
bufferpointer to byte array
lengthnumber of bytes
Returns
number of bytes written

Implements JLANG::JBinaryOutput.

Definition at line 113 of file JStreamIO.hh.

114 {
115 out.write(buffer, length);
116
117 return length;
118 }

◆ operator<<() [1/16]

JWriter & JIO::JWriter::operator<< ( const JSerialisable & object)
inlineinherited

Write serialisable data object.

Parameters
objectserialisable data object
Returns
JWriter

Definition at line 144 of file JSerialisable.hh.

145 {
146 return object.write(*this);
147 }

◆ operator<<() [2/16]

JWriter & JIO::JWriter::operator<< ( const bool value)
inlineinherited

Definition at line 150 of file JSerialisable.hh.

150{ write((const char*) &value, sizeof(bool)); return *this; }
virtual int write(const char *buffer, const int length)=0
Write byte array.

◆ operator<<() [3/16]

JWriter & JIO::JWriter::operator<< ( const char value)
inlineinherited

Definition at line 151 of file JSerialisable.hh.

151{ write((const char*) &value, sizeof(char)); return *this; }

◆ operator<<() [4/16]

JWriter & JIO::JWriter::operator<< ( const unsigned char value)
inlineinherited

Definition at line 152 of file JSerialisable.hh.

152{ write((const char*) &value, sizeof(unsigned char)); return *this; }

◆ operator<<() [5/16]

JWriter & JIO::JWriter::operator<< ( const short value)
inlineinherited

Definition at line 153 of file JSerialisable.hh.

153{ write((const char*) &value, sizeof(short)); return *this; }

◆ operator<<() [6/16]

JWriter & JIO::JWriter::operator<< ( const unsigned short value)
inlineinherited

Definition at line 154 of file JSerialisable.hh.

154{ write((const char*) &value, sizeof(unsigned short)); return *this; }

◆ operator<<() [7/16]

JWriter & JIO::JWriter::operator<< ( const int value)
inlineinherited

Definition at line 155 of file JSerialisable.hh.

155{ write((const char*) &value, sizeof(int)); return *this; }

◆ operator<<() [8/16]

JWriter & JIO::JWriter::operator<< ( const unsigned int value)
inlineinherited

Definition at line 156 of file JSerialisable.hh.

156{ write((const char*) &value, sizeof(unsigned int)); return *this; }

◆ operator<<() [9/16]

JWriter & JIO::JWriter::operator<< ( const long int value)
inlineinherited

Definition at line 157 of file JSerialisable.hh.

157{ write((const char*) &value, sizeof(long int)); return *this; }

◆ operator<<() [10/16]

JWriter & JIO::JWriter::operator<< ( const unsigned long int value)
inlineinherited

Definition at line 158 of file JSerialisable.hh.

158{ write((const char*) &value, sizeof(unsigned long int)); return *this; }

◆ operator<<() [11/16]

JWriter & JIO::JWriter::operator<< ( const long long int value)
inlineinherited

Definition at line 159 of file JSerialisable.hh.

159{ write((const char*) &value, sizeof(long long int)); return *this; }

◆ operator<<() [12/16]

JWriter & JIO::JWriter::operator<< ( const unsigned long long int value)
inlineinherited

Definition at line 160 of file JSerialisable.hh.

160{ write((const char*) &value, sizeof(unsigned long long int)); return *this; }

◆ operator<<() [13/16]

JWriter & JIO::JWriter::operator<< ( const float value)
inlineinherited

Definition at line 161 of file JSerialisable.hh.

161{ write((const char*) &value, sizeof(float)); return *this; }

◆ operator<<() [14/16]

JWriter & JIO::JWriter::operator<< ( const double value)
inlineinherited

Definition at line 162 of file JSerialisable.hh.

162{ write((const char*) &value, sizeof(double)); return *this; }

◆ operator<<() [15/16]

JWriter & JIO::JWriter::operator<< ( const long double value)
inlineinherited

Definition at line 163 of file JSerialisable.hh.

163{ write((const char*) &value, sizeof(long double)); return *this; }

◆ operator<<() [16/16]

JWriter & JIO::JWriter::operator<< ( const JLANG::JObjectID & value)
inlineinherited

Definition at line 164 of file JSerialisable.hh.

164{ return (*this) << value.getID(); }
int getID() const
Get identifier.
Definition JObjectID.hh:50

◆ store() [1/2]

JWriter & JIO::JWriter::store ( const JSerialisable & object)
inlineinherited

Write object.

Parameters
objectobject
Returns
this writer

Definition at line 173 of file JSerialisable.hh.

174 {
175 return object.write(*this);
176 }

◆ store() [2/2]

template<class T >
JWriter & JIO::JWriter::store ( const T & object)
inlineinherited

Write object.

Parameters
objectobject
Returns
this writer

Definition at line 186 of file JSerialisable.hh.

187 {
188 return *this << object;
189 }

◆ operator bool()

JLANG::JAbstractObjectStatus::operator bool ( ) const
inlineinherited

Type conversion operator.

Returns
status of this object

Definition at line 33 of file JAbstractObjectStatus.hh.

34 {
35 return this->getStatus();
36 }
virtual bool getStatus() const =0
Get status of object.

◆ operator!()

bool JLANG::JAbstractObjectStatus::operator! ( ) const
inlineinherited

Negated status of this object.

Returns
negated status of this object

Definition at line 44 of file JAbstractObjectStatus.hh.

45 {
46 return !(this->getStatus());
47 }

◆ put()

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.

◆ out

std::ostream& JIO::JStreamWriter::out
protectedinherited

Definition at line 121 of file JStreamIO.hh.


The documentation for this class was generated from the following file: