SDK/MLReference/mlStringConversion_8h_source.html

/*************************************************************************************

**

** Copyright 2007, MeVis Medical Solutions AG

**

** The user may use this file in accordance with the license agreement provided with

** the Software or, alternatively, in accordance with the terms contained in a

** written agreement between the user and MeVis Medical Solutions AG.

**

** For further information use the contact form at https://www.mevislab.de/contact

**

**************************************************************************************/


#ifndef ML_STRING_CONVERSION_H

#define ML_STRING_CONVERSION_H


#include "mlLinearAlgebra.h"

#include "mlSubImageBox.h"


ML_START_NAMESPACE


class SubImageBoxd;

class Base;


class MLEXPORT StringConversion

{

public:

  [[nodiscard]]

  static char* newString    (const std::string &str);


  static void  deleteString (char* str);


  static std::string writeToStdString(unsigned char val);


  static std::string writeToStdString(char val);


  static std::string writeToStdString(unsigned short val);


  static std::string writeToStdString(short val);


  static std::string writeToStdString(MLuint32 val);


  static std::string writeToStdString(MLint32 val);


  static std::string writeToStdString(unsigned long val);


  static std::string writeToStdString(long val);


  static std::string writeToStdString(MLuint64 val);


  static std::string writeToStdString(MLint64 val);


  static std::string writeToStdString(MLfloat val);


  static std::string writeToStdString(MLdouble val);


  static std::string writeToStdString(MLldouble val);


  static std::string writeToStdString(const Vector2& val);


  static std::string writeToStdString(const Vector3& val);


  static std::string writeToStdString(const Vector4& val);


  static std::string writeToStdString(const Vector5& val);


  static std::string writeToStdString(const Vector6& val);


  static std::string writeToStdString(const Vector7& val);


  static std::string writeToStdString(const Vector8& val);


  static std::string writeToStdString(const Vector9& val);


  static std::string writeToStdString(const Vector10& val);


  static std::string writeToStdString(const Vector16& val);


  static std::string writeToStdString(const Vector32& val);


  static std::string writeToStdString(const Vector64& val);


  static std::string writeToStdString(const ImageVector& val);


  static std::string writeToStdString(SubImageBox const & box);


  static std::string writeToStdString(SubImageBoxd const & box);


  static std::string writeToStdString(Matrix2 const & mat);


  static std::string writeToStdString(Matrix3 const & mat);


  static std::string writeToStdString(Matrix4 const & mat);


  static std::string writeToStdString(Matrix5 const & mat);


  static std::string writeToStdString(Matrix6 const & mat);


  static std::string writeToStdString(const Base* const obj);


  static std::string writeToStdString(const Base& obj);


  template <typename T>


  static std::string writeToStdString(const std::vector<T>& vec, const std::string &separatorString)

  {

    std::string retVal;

    for (size_t k = 0; k < vec.size(); k++){

      if (k){ retVal += separatorString; }

      retVal += writeToStdString(vec[k]);

    }

    return retVal;

  }


  static std::string writeToStdString(const std::string& str);


  static bool readFromString(const std::string& arg, unsigned char& val);


  static bool readFromString(const std::string& arg, char& val);


  static bool readFromString(const std::string& arg, unsigned short& val);


  static bool readFromString(const std::string& arg, short& val);


  static bool readFromString(const std::string& arg, MLuint32& val);


  static bool readFromString(const std::string& arg, MLint32& val);


  static bool readFromString(const std::string& arg, MLuint64& val);


  static bool readFromString(const std::string& arg, MLint64& val);


  static bool readFromString(std::string const& arg, unsigned long& val);


  static bool readFromString(std::string const& arg, long& val);


  static bool readFromString(std::string const& arg, float& val);


  static bool readFromString(std::string const& arg, double& val);


  static bool readFromString(std::string const& arg, long double& val);


  static bool readFromString(const std::string& vecstr, Vector2& v);


  static bool readFromString(const std::string& vecstr, Vector3& v);


  static bool readFromString(const std::string& vecstr, Vector4& v);


  static bool readFromString(const std::string& vecstr, Vector5& v);


  static bool readFromString(const std::string& vecstr, Vector6& v);


  static bool readFromString(const std::string& vecstr, Vector7& v);


  static bool readFromString(const std::string& vecstr, Vector8& v);


  static bool readFromString(const std::string& vecstr, Vector9& v);


  static bool readFromString(const std::string& vecstr, Vector10& v);


  static bool readFromString(const std::string& vecstr, Vector16& v);


  static bool readFromString(const std::string& vecstr, Vector32& v);


  static bool readFromString(const std::string& vecstr, Vector64& v);


  static bool readFromString(const std::string& vecstr, ImageVector& v);


  static bool readFromString(const std::string& str, Matrix2& val);


  static bool readFromString(const std::string& str, Matrix3& val);


  static bool readFromString(const std::string& str, Matrix4& val);


  static bool readFromString(const std::string& str, Matrix5& val);


  static bool readFromString(const std::string& str, Matrix6& val);


  static bool readFromString (const std::string& arg, SubImageBox& val);


  static bool readFromString (const std::string& arg, SubImageBoxd& val);


  static bool readFromString(const std::string& source, Base& obj);


  template <typename T>


  static bool readFromString(const std::string& vecstr,

                             std::vector<T>&    vec,

                             const std::string& separatorString)

  {

    bool retVal = false;


    size_t startPos = 0, endPos = 0;

    size_t sepLen = separatorString.size();

    bool eos = false;

    // Initialize the object with default value of the type to avoid uninitialized object warnings.

    T item = T();


    while (!eos) {

      endPos = vecstr.find(separatorString, startPos);

      if (endPos == std::string::npos) {

        endPos = vecstr.size();

        eos = true;

      }


      // Use type specific read function to parse the string.

      retVal = readFromString(vecstr.substr(startPos, endPos - startPos), item);


      // Append the read item to the end of the vector.

      vec.push_back(item);


      // Set position of the next item to read.

      startPos = endPos + sepLen;

    }

    return retVal;

  }


  static bool readFromString(const std::string& source, std::string& target);


  static MLint getFirstNonSpacePos(const std::string& str, MLint pos = 0);


private:

  static void instantiateTemplateFctDummy(void);

};


ML_END_NAMESPACE


#endif // __mlStringConversion_H


ml::Base
Class representing general ML objects that support import/export via strings (setPersistentState() an...
Definition mlBase.h:59

ml::StringConversion
The class StringConversion provides static methods to convert ML objects to and from strings.
Definition mlStringConversion.h:30

ml::StringConversion::readFromString
static bool readFromString(const std::string &vecstr, Vector9 &v)
Reads a 9D double vector value v from string vecstr whose values are space separated; it returns true...

ml::StringConversion::writeToStdString
static std::string writeToStdString(const ImageVector &val)
Converts a ImageVector to a std::string which can be parsed by readFromString().

ml::StringConversion::writeToStdString
static std::string writeToStdString(MLint32 val)
Converts an int32 to a std::string.

ml::StringConversion::writeToStdString
static std::string writeToStdString(const std::vector< T > &vec, const std::string &separatorString)
Converts a std::vector value vec to a string where vector components will be separated by the string ...
Definition mlStringConversion.h:157

ml::StringConversion::writeToStdString
static std::string writeToStdString(const Vector9 &val)
Converts a Vector9 to a std::string which can be parsed by readFromString().

ml::StringConversion::readFromString
static bool readFromString(const std::string &vecstr, Vector16 &v)
Reads a 16D double vector value v from string vecstr whose values are space separated; it returns tru...

ml::StringConversion::writeToStdString
static std::string writeToStdString(char val)
Converts char to a std::string.

ml::StringConversion::writeToStdString
static std::string writeToStdString(const Vector2 &val)
Converts a Vector2 to a std::string which can be parsed by readFromString().

ml::StringConversion::readFromString
static bool readFromString(const std::string &vecstr, Vector5 &v)
Reads a 5D double vector value v from string vecstr whose values are space separated; it returns true...

ml::StringConversion::readFromString
static bool readFromString(const std::string &str, Matrix5 &val)
Reads a Matrix5 value val from string str whose values are space separated; and returns true if all c...

ml::StringConversion::writeToStdString
static std::string writeToStdString(MLuint64 val)
Converts uint64 to a std::string.

ml::StringConversion::readFromString
static bool readFromString(const std::string &vecstr, std::vector< T > &vec, const std::string &separatorString)
Reads a std::vector<T> from a string of the form that is generated by stdVectorToString(vec,...
Definition mlStringConversion.h:323

ml::StringConversion::writeToStdString
static std::string writeToStdString(MLdouble val)
Converts double to a std::string.

ml::StringConversion::getFirstNonSpacePos
static MLint getFirstNonSpacePos(const std::string &str, MLint pos=0)
Helper method returning the first non-space position starting from pos.

ml::StringConversion::writeToStdString
static std::string writeToStdString(const Vector10 &val)
Converts a Vector10 to a std::string which can be parsed by readFromString().

ml::StringConversion::readFromString
static bool readFromString(const std::string &str, Matrix4 &val)
Reads a Matrix4 value val from string str whose values are space separated; and returns true if all c...

ml::StringConversion::writeToStdString
static std::string writeToStdString(Matrix3 const &mat)
Converts a Matrix3 to a std::string which can be parsed by readFromString().

ml::StringConversion::writeToStdString
static std::string writeToStdString(MLldouble val)
Converts long double to a std::string.

ml::StringConversion::readFromString
static bool readFromString(const std::string &arg, MLuint64 &val)
Reads a value from string arg into val; it returns true if one value has been converted successfully,...

ml::StringConversion::writeToStdString
static std::string writeToStdString(const Vector7 &val)
Converts a Vector7 to a std::string which can be parsed by readFromString().

ml::StringConversion::readFromString
static bool readFromString(std::string const &arg, double &val)
Reads a value from string arg into val; it returns true if one value has been converted successfully,...

ml::StringConversion::writeToStdString
static std::string writeToStdString(const Vector32 &val)
Converts a Vector32 to a std::string which can be parsed by readFromString().

ml::StringConversion::writeToStdString
static std::string writeToStdString(const std::string &str)
Writes std::string object to std::string.

ml::StringConversion::newString
static char * newString(const std::string &str)

ml::StringConversion::readFromString
static bool readFromString(const std::string &arg, MLuint32 &val)
Reads a value from string arg into val; it returns true if one value has been converted successfully,...

ml::StringConversion::readFromString
static bool readFromString(const std::string &arg, short &val)
Reads a value from string arg into val; it returns true if one value has been converted successfully,...

ml::StringConversion::readFromString
static bool readFromString(const std::string &source, std::string &target)
Reads a std::string object to std::string.

ml::StringConversion::writeToStdString
static std::string writeToStdString(unsigned short val)
Converts an unsigned short to a std::string.

ml::StringConversion::readFromString
static bool readFromString(const std::string &vecstr, Vector3 &v)
Reads a 3D double vector value v from string vecstr whose values are space separated; it returns true...

ml::StringConversion::readFromString
static bool readFromString(std::string const &arg, float &val)
Reads a value from string arg into val; it returns true if one value has been converted successfully,...

ml::StringConversion::readFromString
static bool readFromString(const std::string &arg, MLint32 &val)
Reads a value from string arg into val; it returns true if one value has been converted successfully,...

ml::StringConversion::writeToStdString
static std::string writeToStdString(MLuint32 val)
Converts uint32 to a std::string.

ml::StringConversion::readFromString
static bool readFromString(const std::string &vecstr, Vector6 &v)
Reads a 6D double vector value v from string vecstr whose values are space separated; it returns true...

ml::StringConversion::readFromString
static bool readFromString(const std::string &str, Matrix6 &val)
Reads a Matrix6 value val from string str whose values are space separated; and returns true if all c...

ml::StringConversion::writeToStdString
static std::string writeToStdString(MLint64 val)
Converts an int64 to a std::string.

ml::StringConversion::writeToStdString
static std::string writeToStdString(const Vector16 &val)
Converts a Vector16 to a std::string which can be parsed by readFromString().

ml::StringConversion::readFromString
static bool readFromString(const std::string &arg, SubImageBox &val)
Reads a SubImageBox value val from string arg whose values are space separated; and returns true if a...

ml::StringConversion::readFromString
static bool readFromString(const std::string &vecstr, ImageVector &v)
Reads a ImageVector value v from string vecstr whose values are space separated; it returns true if a...

ml::StringConversion::readFromString
static bool readFromString(const std::string &vecstr, Vector10 &v)
Reads a 10D double vector value v from string vecstr whose values are space separated; it returns tru...

ml::StringConversion::writeToStdString
static std::string writeToStdString(const Vector6 &val)
Converts a Vector6 to a std::string which can be parsed by readFromString().

ml::StringConversion::readFromString
static bool readFromString(const std::string &source, Base &obj)
Reads a Base object from string source to obj by calling obj.setPersistentState(source....

ml::StringConversion::readFromString
static bool readFromString(const std::string &str, Matrix2 &val)
Reads a Matrix2 value val from string str whose values are space separated; and returns true if all c...

ml::StringConversion::writeToStdString
static std::string writeToStdString(const Base &obj)
Writes Base object to std::string.

ml::StringConversion::readFromString
static bool readFromString(const std::string &arg, MLint64 &val)
Reads a value from string arg into val; it returns true if one value has been converted successfully,...

ml::StringConversion::writeToStdString
static std::string writeToStdString(Matrix4 const &mat)
Converts a Matrix4 to a std::string which can be parsed by readFromString().

ml::StringConversion::writeToStdString
static std::string writeToStdString(unsigned char val)
Converts an unsigned char to a std::string.

ml::StringConversion::readFromString
static bool readFromString(const std::string &vecstr, Vector8 &v)
Reads a 8D double vector value v from string vecstr whose values are space separated; it returns true...

ml::StringConversion::writeToStdString
static std::string writeToStdString(const Base *const obj)
Writes Base object to std::string.

ml::StringConversion::writeToStdString
static std::string writeToStdString(MLfloat val)
Converts float to a std::string.

ml::StringConversion::writeToStdString
static std::string writeToStdString(Matrix5 const &mat)
Converts a Matrix5 to a std::string which can be parsed by readFromString().

ml::StringConversion::writeToStdString
static std::string writeToStdString(Matrix6 const &mat)
Converts a Matrix6 to a std::string which can be parsed by readFromString().

ml::StringConversion::readFromString
static bool readFromString(std::string const &arg, long &val)
Reads a value from string arg into val; it returns true if one value has been converted successfully,...

ml::StringConversion::readFromString
static bool readFromString(const std::string &str, Matrix3 &val)
Reads a Matrix3 value val from string str whose values are space separated; and returns true if all c...

ml::StringConversion::writeToStdString
static std::string writeToStdString(SubImageBoxd const &box)
Converts a SubImageBoxd to a std::string which can be parsed by readFromString(SubImageBoxd&).

ml::StringConversion::writeToStdString
static std::string writeToStdString(const Vector64 &val)
Converts a Vector64 to a std::string which can be parsed by readFromString().

ml::StringConversion::readFromString
static bool readFromString(const std::string &vecstr, Vector32 &v)
Reads a 32D double vector value v from string vecstr whose values are space separated; it returns tru...

ml::StringConversion::readFromString
static bool readFromString(const std::string &arg, unsigned char &val)
Reads a value from string arg into val; it returns true if one value has been converted successfully,...

ml::StringConversion::readFromString
static bool readFromString(const std::string &arg, char &val)
Reads a value from string arg into val; it returns true if one value has been converted successfully,...

ml::StringConversion::writeToStdString
static std::string writeToStdString(const Vector5 &val)
Converts a Vector5 to a std::string which can be parsed by readFromString().

ml::StringConversion::writeToStdString
static std::string writeToStdString(const Vector8 &val)
Converts a Vector8 to a std::string which can be parsed by readFromString().

ml::StringConversion::readFromString
static bool readFromString(const std::string &arg, unsigned short &val)
Reads a value from string arg into val; it returns true if one value has been converted successfully,...

ml::StringConversion::readFromString
static bool readFromString(const std::string &vecstr, Vector2 &v)
Reads a 2D double vector value v from string vecstr whose values are space separated; it returns true...

ml::StringConversion::readFromString
static bool readFromString(const std::string &arg, SubImageBoxd &val)
Reads a SubImageBox value val from string arg whose values are space separated; and returns true if a...

ml::StringConversion::readFromString
static bool readFromString(const std::string &vecstr, Vector4 &v)
Reads a 4D double vector value v from string vecstr whose values are space separated; it returns true...

ml::StringConversion::deleteString
static void deleteString(char *str)
Dispose a string created by newString(); NULL values as str are legal and will be ignored.

ml::StringConversion::readFromString
static bool readFromString(const std::string &vecstr, Vector64 &v)
Reads a 64D double vector value v from string vecstr whose values are space separated; it returns tru...

ml::StringConversion::readFromString
static bool readFromString(const std::string &vecstr, Vector7 &v)
Reads a 7D double vector value v from string vecstr whose values are space separated; it returns true...

ml::StringConversion::writeToStdString
static std::string writeToStdString(Matrix2 const &mat)
Converts a Matrix2 to a std::string which can be parsed by readFromString().

ml::StringConversion::writeToStdString
static std::string writeToStdString(unsigned long val)
Converts unsigned long to std::string.

ml::StringConversion::writeToStdString
static std::string writeToStdString(long val)
Converts long to a std::string.

ml::StringConversion::writeToStdString
static std::string writeToStdString(const Vector4 &val)
Converts a Vector4 to a std::string which can be parsed by readFromString().

ml::StringConversion::writeToStdString
static std::string writeToStdString(SubImageBox const &box)
Converts a SubImageBox to a std::string which can be parsed by readFromString(SubImageBox&).

ml::StringConversion::writeToStdString
static std::string writeToStdString(const Vector3 &val)
Converts a Vector3 to a std::string which can be parsed by readFromString().

ml::StringConversion::readFromString
static bool readFromString(std::string const &arg, unsigned long &val)
Reads a value from string arg into val; it returns true if one value has been converted successfully,...

ml::StringConversion::readFromString
static bool readFromString(std::string const &arg, long double &val)
Reads a value from string arg into val; it returns true if one value has been converted successfully,...

ml::StringConversion::writeToStdString
static std::string writeToStdString(short val)
Converts short to a std::string.

ml::SubImageBoxd
SubImageBoxd - SubImageBox with coordinates of float data type.
Definition mlSubImageBoxd.h:33

ml::TImageVector< MLint >

ml::TSubImageBox< MLint >

ml::Tmat2< MLdouble >

ml::Tmat3< MLdouble >

ml::Tmat4< MLdouble >

ml::Tmat5< MLdouble >

ml::Tmat6< MLdouble >

ml::Tvec10< MLdouble >

ml::Tvec16
A 16 dimensional vector class for floating point types.
Definition mlVector16.h:32

ml::Tvec2< MLdouble >

ml::Tvec32
A 32 dimensional vector class for floating point types.
Definition mlVector32.h:32

ml::Tvec3< MLdouble >

ml::Tvec4< MLdouble >

ml::Tvec5< MLdouble >

ml::Tvec64
A 64 dimensional vector class for floating point types.
Definition mlVector64.h:32

ml::Tvec6< MLdouble >

ml::Tvec7
An seven dimensional vector class for floating point types.
Definition mlVector7.h:32

ml::Tvec8
An eight dimensional vector class for floating point types.
Definition mlVector8.h:32

ml::Tvec9
An nine dimensional vector class for floating point types.
Definition mlVector9.h:32

MLEXPORT
#define MLEXPORT
To export symbols from a dll/shared object, we need to mark them with the MLEXPORT symbol.
Definition mlInitSystemML.h:38

mlLinearAlgebra.h

mlSubImageBox.h

MLuint64
UINT64 MLuint64
Introduce platform independent 64 bit unsigned integer type.
Definition mlTypeDefs.h:425

MLldouble
long double MLldouble
Definition mlTypeDefs.h:232

MLuint32
unsigned int MLuint32
Definition mlTypeDefs.h:185

MLdouble
double MLdouble
Definition mlTypeDefs.h:217

MLint64
INT64 MLint64
Include 64 bit integer support for Windows or Unix.
Definition mlTypeDefs.h:412

MLint
MLint64 MLint
A signed ML integer type with at least 64 bits used for index calculations on very large images even ...
Definition mlTypeDefs.h:490

MLint32
signed int MLint32
Definition mlTypeDefs.h:161

MLfloat
float MLfloat
Definition mlTypeDefs.h:201