ProteoWizard
Classes | Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
pwiz::msdata::BinaryDataEncoder Class Reference

binary-to-text encoding More...

#include <BinaryDataEncoder.hpp>

Classes

struct  Config
 encoding/decoding configuration More...
 

Public Types

enum  Precision { Precision_32, Precision_64 }
 
enum  ByteOrder { ByteOrder_LittleEndian, ByteOrder_BigEndian }
 
enum  Compression { Compression_None, Compression_Zlib }
 
enum  Numpress { Numpress_None, Numpress_Linear, Numpress_Pic, Numpress_Slof }
 

Public Member Functions

 BinaryDataEncoder (const Config &config=Config())
 
const ConfiggetConfig () const
 
void encode (const std::vector< double > &data, std::string &result, size_t *binaryByteCount=NULL) const
 encode binary data as a text string More...
 
void encode (const double *data, size_t dataSize, std::string &result, size_t *binaryByteCount=NULL) const
 encode binary data as a text string More...
 
void decode (const char *encodedData, size_t len, pwiz::util::BinaryData< double > &result) const
 decode text-encoded data as binary More...
 
void decode (const std::string &encodedData, pwiz::util::BinaryData< double > &result) const
 

Private Member Functions

 BinaryDataEncoder (const BinaryDataEncoder &)
 
BinaryDataEncoderoperator= (const BinaryDataEncoder &)
 

Private Attributes

boost::shared_ptr< Impl > impl_
 

Detailed Description

binary-to-text encoding

Definition at line 45 of file BinaryDataEncoder.hpp.

Member Enumeration Documentation

◆ Precision

Enumerator
Precision_32 
Precision_64 

Definition at line 49 of file BinaryDataEncoder.hpp.

◆ ByteOrder

Enumerator
ByteOrder_LittleEndian 
ByteOrder_BigEndian 

Definition at line 50 of file BinaryDataEncoder.hpp.

◆ Compression

Enumerator
Compression_None 
Compression_Zlib 

Definition at line 51 of file BinaryDataEncoder.hpp.

◆ Numpress

Enumerator
Numpress_None 
Numpress_Linear 
Numpress_Pic 
Numpress_Slof 

Definition at line 52 of file BinaryDataEncoder.hpp.

52 {Numpress_None, Numpress_Linear, Numpress_Pic, Numpress_Slof}; // lossy numerical representations

Constructor & Destructor Documentation

◆ BinaryDataEncoder() [1/2]

pwiz::msdata::BinaryDataEncoder::BinaryDataEncoder ( const Config config = Config())

◆ BinaryDataEncoder() [2/2]

pwiz::msdata::BinaryDataEncoder::BinaryDataEncoder ( const BinaryDataEncoder )
private

Member Function Documentation

◆ getConfig()

const Config& pwiz::msdata::BinaryDataEncoder::getConfig ( ) const

◆ encode() [1/2]

void pwiz::msdata::BinaryDataEncoder::encode ( const std::vector< double > &  data,
std::string &  result,
size_t *  binaryByteCount = NULL 
) const

encode binary data as a text string

Referenced by testBadFile(), and testConfiguration().

◆ encode() [2/2]

void pwiz::msdata::BinaryDataEncoder::encode ( const double *  data,
size_t  dataSize,
std::string &  result,
size_t *  binaryByteCount = NULL 
) const

encode binary data as a text string

◆ decode() [1/2]

void pwiz::msdata::BinaryDataEncoder::decode ( const char *  encodedData,
size_t  len,
pwiz::util::BinaryData< double > &  result 
) const

decode text-encoded data as binary

Referenced by readData(), testBadFile(), and testConfiguration().

◆ decode() [2/2]

void pwiz::msdata::BinaryDataEncoder::decode ( const std::string &  encodedData,
pwiz::util::BinaryData< double > &  result 
) const
inline

Definition at line 93 of file BinaryDataEncoder.hpp.

94  {
95  decode(encodedData.c_str(),encodedData.length(),result);
96  }

◆ operator=()

BinaryDataEncoder& pwiz::msdata::BinaryDataEncoder::operator= ( const BinaryDataEncoder )
private

Member Data Documentation

◆ impl_

boost::shared_ptr<Impl> pwiz::msdata::BinaryDataEncoder::impl_
private

Definition at line 99 of file BinaryDataEncoder.hpp.


The documentation for this class was generated from the following file:
pwiz::msdata::BinaryDataEncoder::decode
void decode(const char *encodedData, size_t len, pwiz::util::BinaryData< double > &result) const
decode text-encoded data as binary
pwiz::msdata::BinaryDataEncoder::Numpress_None
@ Numpress_None
Definition: BinaryDataEncoder.hpp:52
pwiz::msdata::BinaryDataEncoder::Precision_64
@ Precision_64
Definition: BinaryDataEncoder.hpp:49
pwiz::msdata::BinaryDataEncoder::Numpress_Linear
@ Numpress_Linear
Definition: BinaryDataEncoder.hpp:52
pwiz::msdata::BinaryDataEncoder::Compression_None
@ Compression_None
Definition: BinaryDataEncoder.hpp:51
pwiz::msdata::BinaryDataEncoder::Compression_Zlib
@ Compression_Zlib
Definition: BinaryDataEncoder.hpp:51
pwiz::msdata::BinaryDataEncoder::Precision_32
@ Precision_32
Definition: BinaryDataEncoder.hpp:49
pwiz::msdata::BinaryDataEncoder::ByteOrder_BigEndian
@ ByteOrder_BigEndian
Definition: BinaryDataEncoder.hpp:50
pwiz::msdata::BinaryDataEncoder::ByteOrder_LittleEndian
@ ByteOrder_LittleEndian
Definition: BinaryDataEncoder.hpp:50
pwiz::msdata::BinaryDataEncoder::Numpress_Slof
@ Numpress_Slof
Definition: BinaryDataEncoder.hpp:52
pwiz::msdata::BinaryDataEncoder::Numpress_Pic
@ Numpress_Pic
Definition: BinaryDataEncoder.hpp:52