cmnDataFunctions.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */
 
/*
  Author(s):  Anton Deguet
  Created on: 2011-06-27
 
  (C) Copyright 2011-2025 Johns Hopkins University (JHU), All Rights Reserved.
 
--- begin cisst license - do not edit ---
 
This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.
 
--- end cisst license ---
*/
 
#pragma once
#ifndef _cmnDataFunctions_h
#define _cmnDataFunctions_h
 
#include <string.h> // for memcpy
#include <iostream>
#include <sstream>
#include <cisstCommon/cmnThrow.h>
#include <cisstCommon/cmnDataFormat.h>
#include <cisstCommon/cmnDataFunctionsMacros.h>
 
// always include last
#include <cisstCommon/cmnExport.h>

template <typename _elementType>
class cmnData
{
public:
    enum {IS_SPECIALIZED = 0};
 
    typedef _elementType DataType;

    static
    std::string
    HumanReadable(const DataType & data);

    static
    void
    Copy(DataType & data, const DataType & source);

    static
    std::string
    SerializeDescription(const DataType & data, const char delimiter,
                         const std::string & userDescription = "");

    static
    void
    SerializeText(const DataType & data, std::ostream & outputStream,
                  const char delimiter = ',') CISST_THROW(std::runtime_error);

    static
    void
    DeSerializeText(DataType & data, std::istream & inputStream,
                    const char delimiter = ',') CISST_THROW(std::runtime_error);

    static
    void
    SerializeBinary(const DataType & data, std::ostream & outputStream)
        CISST_THROW(std::runtime_error);

    static
    void
    DeSerializeBinary(DataType & data, std::istream & inputStream,
                      const cmnDataFormat & localFormat,
                      const cmnDataFormat & remoteFormat) CISST_THROW(std::runtime_error);

    static
    size_t
    SerializeBinaryByteSize(const DataType & data);

    static
    size_t
    SerializeBinary(const DataType & data, char * buffer, size_t bufferSize);
 
    static
    size_t
    DeSerializeBinary(DataType & data, const char * buffer, size_t bufferSize,
                      const cmnDataFormat & CMN_UNUSED(localFormat),
                      const cmnDataFormat & CMN_UNUSED(remoteFormat));
 
    static
    std::string
    ScalarDescription(const DataType & data, const size_t index, const std::string & userDescription = "")
        CISST_THROW(std::out_of_range);
 
    static
    double
    Scalar(const DataType & data, const size_t index)
        CISST_THROW(std::out_of_range);
 
    static
    size_t ScalarNumber(const DataType & data);
 
    static
    bool ScalarNumberIsFixed(const DataType & data);
};
 
 
template <typename _elementType>
void cmnDataCopy(_elementType & destination, const _elementType & source)
{
    cmnData<_elementType>::Copy(destination, source);
}
 
template <typename _elementType>
std::string cmnDataHumanReadable(const _elementType & data)
{
    return cmnData<_elementType>::HumanReadable(data);
}
 
 
/* Native types to overload:
   bool
   char
   unsigned char
   short
   unsigned short
   int
   unsigned int
   long long int
   unsigned long long int
   float
   double
*/
CMN_DATA_SPECIALIZE_ALL_NO_BYTE_SWAP(bool, b);
CMN_DATA_SPECIALIZE_ALL_NO_BYTE_SWAP(char, c);
CMN_DATA_SPECIALIZE_ALL_NO_BYTE_SWAP(unsigned char, uc);
 
CMN_DATA_SPECIALIZE_ALL_BYTE_SWAP(short, s);
CMN_DATA_SPECIALIZE_ALL_BYTE_SWAP(unsigned short, us);
CMN_DATA_SPECIALIZE_ALL_BYTE_SWAP(int, i);
CMN_DATA_SPECIALIZE_ALL_BYTE_SWAP(unsigned int, ui);
CMN_DATA_SPECIALIZE_ALL_BYTE_SWAP(long int, li);
CMN_DATA_SPECIALIZE_ALL_BYTE_SWAP(unsigned long int, uli);
CMN_DATA_SPECIALIZE_ALL_BYTE_SWAP(long long int, lli);
CMN_DATA_SPECIALIZE_ALL_BYTE_SWAP(unsigned long long int, ulli);
CMN_DATA_SPECIALIZE_ALL_BYTE_SWAP(float, f);
CMN_DATA_SPECIALIZE_ALL_BYTE_SWAP(double, d);

size_t CISST_EXPORT cmnDataDeSerializeBinary_size_t(size_t & data, const char * buffer, size_t bufferSize,
                                                    const cmnDataFormat & localFormat,
                                                    const cmnDataFormat & remoteFormat);
 
void CISST_EXPORT cmnDataDeSerializeBinary_size_t(size_t & data,
                                                  std::istream & inputStream,
                                                  const cmnDataFormat & localFormat,
                                                  const cmnDataFormat & remoteFormat) CISST_THROW(std::runtime_error);

void CISST_EXPORT cmnDataDeSerializeTextDelimiter(std::istream & inputStream, const char delimiter, const char * className)
    CISST_THROW(std::runtime_error);
 
#endif // _cmnDataFunctions_h