Public Member Functions | List of all members
mirtk::Cofstream Class Reference

#include <Cofstream.h>

Inheritance diagram for mirtk::Cofstream:
Inheritance graph
Collaboration diagram for mirtk::Cofstream:
Collaboration graph

Public Member Functions

void Close ()
 Close file.
 
 Cofstream (const char *=NULL)
 Constructor.
 
MIRTK_Common_DEPRECATED int IsCompressed () const
 
MIRTK_Common_DEPRECATED void IsCompressed (int)
 
MIRTK_Common_DEPRECATED int IsSwapped () const
 
MIRTK_Common_DEPRECATED void IsSwapped (int)
 
void Open (const char *)
 Open file.
 
bool Write (const char *, long, long)
 Write n data as array from offset.
 
bool WriteAsChar (char, long=-1)
 Write data as char (possibly compressed) from offset.
 
bool WriteAsChar (const char *, long, long=-1)
 Write data as char (possibly compressed) from offset.
 
bool WriteAsDouble (double, long=-1)
 Write data as double (possibly compressed) from offset.
 
bool WriteAsDouble (const double *, long, long=-1)
 Write data as double (possibly compressed) from offset.
 
bool WriteAsFloat (float, long=-1)
 Write data as float (possibly compressed) from offset.
 
bool WriteAsFloat (const float *, long, long=-1)
 Write data as float (possibly compressed) from offset.
 
bool WriteAsInt (int, long=-1)
 Write data as int (possibly compressed) from offset.
 
bool WriteAsInt (const int *, long, long=-1)
 Write data as int (possibly compressed) from offset.
 
bool WriteAsShort (short, long=-1)
 Write data as short (possibly compressed) from offset.
 
bool WriteAsShort (const short *, long, long=-1)
 Write data as short (possibly compressed) from offset.
 
bool WriteAsString (const char *, long=-1)
 Write data as string (possibly compressed)
 
bool WriteAsUChar (unsigned char, long=-1)
 Write data as unsigned char (possibly compressed) from offset.
 
bool WriteAsUChar (const unsigned char *, long, long=-1)
 Write data as unsigned char (possibly compressed) from offset.
 
bool WriteAsUInt (unsigned int, long=-1)
 Write data as unsigned int (possibly compressed) from offset.
 
bool WriteAsUInt (const unsigned int *, long, long=-1)
 Write data as unsigned int (possibly compressed) from offset.
 
bool WriteAsUShort (unsigned short, long=-1)
 Write data as unsigned short (possibly compressed) from offset.
 
bool WriteAsUShort (const unsigned short *, long, long=-1)
 Write data as unsigned short (possibly compressed) from offset.
 
 ~Cofstream ()
 Destructor.
 
- Public Member Functions inherited from mirtk::Object
virtual const char * NameOfClass () const =0
 Get name of class, which this object is an instance of.
 
virtual ParameterList Parameter () const
 Get parameter name/value pairs.
 
bool Parameter (const ParameterList &)
 Set parameters from name/value pairs.
 
virtual bool Set (const char *name, const char *value)
 
virtual ~Object ()
 Destructor.
 

Additional Inherited Members

- Static Public Member Functions inherited from mirtk::Object
static const char * NameOfType ()
 Get name of this class type.
 
- Protected Member Functions inherited from mirtk::Object
template<typename... Args>
void Throw (ErrorType err, const char *func, Args... args) const
 
- Static Protected Member Functions inherited from mirtk::Object
template<typename... Args>
static void ThrowStatic (ErrorType err, const char *cls, const char *func, Args... args)
 

Detailed Description

Class for writing (compressed) file streams.

This class defines and implements functions for writing compressed file streams. At the moment only the writing of uncompressed file streams is supported.

Definition at line 40 of file Cofstream.h.

Member Function Documentation

§ IsCompressed() [1/2]

MIRTK_Common_DEPRECATED int mirtk::Cofstream::IsCompressed ( ) const

Returns whether file is compressed

Deprecated:
Used Compressed() instead.

§ IsCompressed() [2/2]

MIRTK_Common_DEPRECATED void mirtk::Cofstream::IsCompressed ( int  )

Sets whether file is compressed

Deprecated:
Used Compressed(bool) instead.

§ IsSwapped() [1/2]

MIRTK_Common_DEPRECATED int mirtk::Cofstream::IsSwapped ( ) const

Returns whether file is swapped

Deprecated:
Used Swapped() instead.

§ IsSwapped() [2/2]

MIRTK_Common_DEPRECATED void mirtk::Cofstream::IsSwapped ( int  )

Sets whether file is swapped

Deprecated:
Used Swapped(bool) instead.

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