Macros
#define	_cmnDataFunctionsMacros_h
#define	CMN_DATA_COPY_USING_ASSIGN(_type)
#define	CMN_DATA_SERIALIZE_DESCRIPTION(_type, _description)
#define	CMN_DATA_SERIALIZE_BINARY_BYTE_SIZE_USING_SIZEOF(_type)
#define	CMN_DATA_SERIALIZE_BINARY_BUFFER_USING_CAST_TO_CHAR(_type)
#define	CMN_DATA_DE_SERIALIZE_BINARY_BUFFER_USING_CAST_TO_CHAR_NO_BYTE_SWAP(_type)
#define	CMN_DATA_DE_SERIALIZE_BINARY_BUFFER_USING_CAST_TO_CHAR_AND_BYTE_SWAP(_type)
#define	CMN_DATA_SERIALIZE_BINARY_STREAM_USING_CAST_TO_CHAR(_type)
#define	CMN_DATA_DE_SERIALIZE_BINARY_STREAM_USING_CAST_TO_CHAR_NO_BYTE_SWAP(_type)
#define	CMN_DATA_DE_SERIALIZE_BINARY_STREAM_USING_CAST_TO_CHAR_AND_BYTE_SWAP(_type)
#define	CMN_DATA_SERIALIZE_TEXT_USING_STREAM_OUT(_type)
#define	CMN_DATA_DE_SERIALIZE_TEXT_USING_STREAM_IN(_type)
#define	CMN_DATA_HUMAN_READABLE_USING_STREAM_OUT(_type)
#define	CMN_DATA_SCALAR_DESCRIPTION(_type, _description)
#define	CMN_DATA_SCALAR_USING_STATIC_CAST(_type)
#define	CMN_DATA_SCALAR_NUMBER_IS_ONE(_type)
#define	CMN_DATA_SCALAR_NUMBER_IS_FIXED_TRUE(_type)
#define	CMN_DATA_IS_SPECIALIZED_TRUE(_type)
#define	CMN_DATA_SPECIALIZE_ALL_NO_BYTE_SWAP(type, description)
#define	CMN_DATA_SPECIALIZE_ALL_BYTE_SWAP(type, description)

Macro Definition Documentation

◆ _cmnDataFunctionsMacros_h

#define _cmnDataFunctionsMacros_h

◆ CMN_DATA_COPY_USING_ASSIGN

#define CMN_DATA_COPY_USING_ASSIGN ( _type )

Value:

static void Copy(_type & data,                                      \
                 const _type & source) {                            \
    data = source;                                                  \
}

Macro to overload the function cmnDataCopy using the assignement operator to copy from source to data. This is a appropriate for data types without any dynamic memory allocations. For types using dynamic memory allocations or large blocks of memory, users should overload the cmnDataCopy function using a more efficient approach (memcpy, ...).

◆ CMN_DATA_DE_SERIALIZE_BINARY_BUFFER_USING_CAST_TO_CHAR_AND_BYTE_SWAP

#define CMN_DATA_DE_SERIALIZE_BINARY_BUFFER_USING_CAST_TO_CHAR_AND_BYTE_SWAP ( _type )

Value:

static size_t DeSerializeBinary(_type & data, const char * buffer, size_t bufferSize, \
                                const cmnDataFormat & localFormat,  \
                                const cmnDataFormat & remoteFormat) \
{                                                                   \
    const size_t sizeOfData = cmnData<_type>::SerializeBinaryByteSize(data); \
    if (bufferSize < sizeOfData) {                                  \
        return 0;                                                   \
    }                                                               \
    data = *(reinterpret_cast<const _type *>(buffer));              \
    if (remoteFormat.GetEndianness() != localFormat.GetEndianness()) { \
        cmnDataByteSwap(data);                                      \
    }                                                               \
    bufferSize -= sizeOfData;                                       \
    return sizeOfData;                                              \
}

◆ CMN_DATA_DE_SERIALIZE_BINARY_BUFFER_USING_CAST_TO_CHAR_NO_BYTE_SWAP

#define CMN_DATA_DE_SERIALIZE_BINARY_BUFFER_USING_CAST_TO_CHAR_NO_BYTE_SWAP ( _type )

Value:

static size_t DeSerializeBinary(_type & data, const char * buffer, size_t bufferSize, \
                                const cmnDataFormat & CMN_UNUSED(localFormat), \
                                const cmnDataFormat & CMN_UNUSED(remoteFormat)) \
{                                                                   \
    const size_t sizeOfData = cmnData<_type>::SerializeBinaryByteSize(data); \
    if (bufferSize < sizeOfData) {                                  \
        return 0;                                                   \
    }                                                               \
    data = *(reinterpret_cast<const _type *>(buffer));              \
    bufferSize -= sizeOfData;                                       \
    return sizeOfData;                                              \
}

◆ CMN_DATA_DE_SERIALIZE_BINARY_STREAM_USING_CAST_TO_CHAR_AND_BYTE_SWAP

#define CMN_DATA_DE_SERIALIZE_BINARY_STREAM_USING_CAST_TO_CHAR_AND_BYTE_SWAP ( _type )

Value:

static void DeSerializeBinary(_type & data,                         \
                              std::istream & inputStream,           \
                              const cmnDataFormat & localFormat,    \
                              const cmnDataFormat & remoteFormat)   \
    CISST_THROW(std::runtime_error)                                 \
{                                                                   \
    inputStream.read(reinterpret_cast<char *>(&data),               \
                     sizeof(_type));                                \
    if (inputStream.fail()) {                                       \
        cmnThrow("cmnData::DeSerializeBinary(" #_type "): error occured with std::istream::read"); \
    }                                                               \
    if (remoteFormat.GetEndianness() != localFormat.GetEndianness()) { \
        cmnDataByteSwap(data);                                      \
    }                                                               \
}

◆ CMN_DATA_DE_SERIALIZE_BINARY_STREAM_USING_CAST_TO_CHAR_NO_BYTE_SWAP

#define CMN_DATA_DE_SERIALIZE_BINARY_STREAM_USING_CAST_TO_CHAR_NO_BYTE_SWAP ( _type )

Value:

static void DeSerializeBinary(_type & data,                         \
                              std::istream & inputStream,           \
                              const cmnDataFormat & CMN_UNUSED(localFormat), \
                              const cmnDataFormat & CMN_UNUSED(remoteFormat)) \
    CISST_THROW(std::runtime_error)                                 \
{                                                                   \
    inputStream.read(reinterpret_cast<char *>(&data),               \
                     sizeof(_type));                                \
    if (inputStream.fail()) {                                       \
        cmnThrow("cmnData::DeSerializeBinary(" #_type "): error occured with std::istream::read"); \
    }                                                               \
}

◆ CMN_DATA_DE_SERIALIZE_TEXT_USING_STREAM_IN

#define CMN_DATA_DE_SERIALIZE_TEXT_USING_STREAM_IN ( _type )

Value:

static void DeSerializeText(_type & data,                           \
                            std::istream & inputStream,             \
                            const char CMN_UNUSED(delimiter) = ',') \
    CISST_THROW(std::runtime_error)                                 \
{                                                                   \
    inputStream >> data;                                            \
    if (inputStream.fail()) {                                       \
        cmnThrow("cmnData::DeSerializeText(" #_type "): error occured with std::istream::read"); \
    }                                                               \
}

Macro to overload the function cmnDataDeSerializeText using the C++ stream in operator.

◆ CMN_DATA_HUMAN_READABLE_USING_STREAM_OUT

#define CMN_DATA_HUMAN_READABLE_USING_STREAM_OUT ( _type )

Value:

static std::string HumanReadable(const _type & data)                \
{                                                                   \
    std::stringstream stringStream;                                 \
    stringStream << data;                                           \
    return stringStream.str();                                      \
}

Macro to overload the function cmnDataHumanReadble using the C++ stream out operator.

◆ CMN_DATA_IS_SPECIALIZED_TRUE

#define CMN_DATA_IS_SPECIALIZED_TRUE ( _type )

Value:

enum {IS_SPECIALIZED = 1};

◆ CMN_DATA_SCALAR_DESCRIPTION

#define CMN_DATA_SCALAR_DESCRIPTION	(		_type,
			_description )

Value:

static std::string ScalarDescription(const _type & CMN_UNUSED(data), \
                                     const size_t CMN_UNUSED(index), \
                                     const std::string & userDescription = "") \
    CISST_THROW(std::out_of_range) {                                \
    return (userDescription == "" ? "{"#_description"}" : (userDescription + ":{"#_description"}")); \
}

Macro to overload the function cmnDataScalarDescription using the type name itself. For example, for a double it will return the string "double".

◆ CMN_DATA_SCALAR_NUMBER_IS_FIXED_TRUE

#define CMN_DATA_SCALAR_NUMBER_IS_FIXED_TRUE ( _type )

Value:

static bool ScalarNumberIsFixed(const _type & CMN_UNUSED(data)) {   \
    return true;                                                    \
}

◆ CMN_DATA_SCALAR_NUMBER_IS_ONE

#define CMN_DATA_SCALAR_NUMBER_IS_ONE ( _type )

Value:

static size_t ScalarNumber(const _type & CMN_UNUSED(data)) {        \
    return 1;                                                       \
}

Macro to overload the function cmnDataScalarNumber, returns 1.

◆ CMN_DATA_SCALAR_USING_STATIC_CAST

#define CMN_DATA_SCALAR_USING_STATIC_CAST ( _type )

Value:

static double Scalar(const _type & data, const size_t CMN_UNUSED(index)) \
    CISST_THROW(std::out_of_range) {                                \
    return static_cast<double>(data);                               \
}

Macro to overload the function cmnDataScalar using a static_cast.

◆ CMN_DATA_SERIALIZE_BINARY_BUFFER_USING_CAST_TO_CHAR

#define CMN_DATA_SERIALIZE_BINARY_BUFFER_USING_CAST_TO_CHAR ( _type )

Value:

static size_t SerializeBinary(const _type & data,                   \
                              char * buffer, size_t bufferSize)     \
{                                                                   \
    const size_t sizeOfData = cmnData<_type>::SerializeBinaryByteSize(data); \
    if (bufferSize < sizeOfData) {                                  \
        return 0;                                                   \
    }                                                               \
    *(reinterpret_cast<_type *>(buffer)) = data;                    \
    bufferSize -= sizeOfData;                                       \
    return sizeOfData;                                              \
}

Macro to overload the function cmnDataSerializeBinary using a cast to char pointer and assuming that sizeof reports the real size of the object to be serialized. Please note that this method will not work with data object relying on dynamic memory allocation (pointers) and might also fail if you are using a struct/class your compiler can pad.

◆ CMN_DATA_SERIALIZE_BINARY_BYTE_SIZE_USING_SIZEOF

#define CMN_DATA_SERIALIZE_BINARY_BYTE_SIZE_USING_SIZEOF ( _type )

Value:

static size_t SerializeBinaryByteSize(const _type & CMN_UNUSED(data)) \
{                                                                   \
    return sizeof(_type);                                           \
}

◆ CMN_DATA_SERIALIZE_BINARY_STREAM_USING_CAST_TO_CHAR

#define CMN_DATA_SERIALIZE_BINARY_STREAM_USING_CAST_TO_CHAR ( _type )

Value:

static void SerializeBinary(const _type & data,                     \
                            std::ostream & outputStream)            \
    CISST_THROW(std::runtime_error)                                 \
{                                                                   \
    outputStream.write(reinterpret_cast<const char *>(&data),       \
                       sizeof(_type));                              \
    if (outputStream.fail()) {                                      \
        cmnThrow("cmnData::SerializeBinary(" #_type "): error occured with std::ostream::write"); \
    }                                                               \
}

Macro to overload the function cmnDataSerializeBinary using a cast to char pointer and assuming that sizeof reports the real size of the object to be serialized. Please note that this method will not work with data object relying on dynamic memory allocation (pointers) and might also fail if you are using a struct/class your compiler can pad.

◆ CMN_DATA_SERIALIZE_DESCRIPTION

#define CMN_DATA_SERIALIZE_DESCRIPTION	(		_type,
			_description )

Value:

static std::string SerializeDescription(const _type & CMN_UNUSED(data), \
                                        const char CMN_UNUSED(delimiter) = ',', \
                                        const std::string & userDescription = "") \
{                                                                   \
    return (userDescription == "" ? "{"#_description"}" : (userDescription + ":{"#_description"}")); \
}

Macro to overload the function cmnDataSerializeDescription.

◆ CMN_DATA_SERIALIZE_TEXT_USING_STREAM_OUT

#define CMN_DATA_SERIALIZE_TEXT_USING_STREAM_OUT ( _type )

Value:

static void SerializeText(const _type & data,                       \
                          std::ostream & outputStream,              \
                          const char CMN_UNUSED(delimiter) = ',')   \
    CISST_THROW(std::runtime_error)                                 \
{                                                                   \
    outputStream << data;                                           \
    if (outputStream.fail()) {                                      \
        cmnThrow("cmnData::SerializeText(" #_type "): error occured with std::ostream::write"); \
    }                                                               \
}

Macro to overload the function cmnDataSerializeText using the C++ stream out operator.

◆ CMN_DATA_SPECIALIZE_ALL_BYTE_SWAP

#define CMN_DATA_SPECIALIZE_ALL_BYTE_SWAP	(		type,
			description )

Value:

template <>                                                             \
class cmnData<type> {                                                   \
public:                                                                 \
    CMN_DATA_IS_SPECIALIZED_TRUE(type)                                  \
    CMN_DATA_COPY_USING_ASSIGN(type)                                    \
    CMN_DATA_SERIALIZE_DESCRIPTION(type, description)                   \
    CMN_DATA_SERIALIZE_BINARY_BYTE_SIZE_USING_SIZEOF(type)              \
    CMN_DATA_SERIALIZE_BINARY_BUFFER_USING_CAST_TO_CHAR(type)           \
    CMN_DATA_DE_SERIALIZE_BINARY_BUFFER_USING_CAST_TO_CHAR_AND_BYTE_SWAP(type) \
    CMN_DATA_SERIALIZE_BINARY_STREAM_USING_CAST_TO_CHAR(type)           \
    CMN_DATA_DE_SERIALIZE_BINARY_STREAM_USING_CAST_TO_CHAR_AND_BYTE_SWAP(type) \
    CMN_DATA_SERIALIZE_TEXT_USING_STREAM_OUT(type)                      \
    CMN_DATA_DE_SERIALIZE_TEXT_USING_STREAM_IN(type)                    \
    CMN_DATA_HUMAN_READABLE_USING_STREAM_OUT(type)                      \
    CMN_DATA_SCALAR_DESCRIPTION(type, description)                      \
    CMN_DATA_SCALAR_USING_STATIC_CAST(type)                             \
    CMN_DATA_SCALAR_NUMBER_IS_ONE(type)                                 \
    CMN_DATA_SCALAR_NUMBER_IS_FIXED_TRUE(type)                          \
    };

◆ CMN_DATA_SPECIALIZE_ALL_NO_BYTE_SWAP

#define CMN_DATA_SPECIALIZE_ALL_NO_BYTE_SWAP	(		type,
			description )

Value:

template <>                                                             \
class cmnData<type> {                                                   \
public:                                                                 \
    CMN_DATA_IS_SPECIALIZED_TRUE(type)                                  \
    CMN_DATA_COPY_USING_ASSIGN(type)                                    \
    CMN_DATA_SERIALIZE_DESCRIPTION(type, description)                   \
    CMN_DATA_SERIALIZE_BINARY_BYTE_SIZE_USING_SIZEOF(type)              \
    CMN_DATA_SERIALIZE_BINARY_BUFFER_USING_CAST_TO_CHAR(type)           \
    CMN_DATA_DE_SERIALIZE_BINARY_BUFFER_USING_CAST_TO_CHAR_NO_BYTE_SWAP(type) \
    CMN_DATA_SERIALIZE_BINARY_STREAM_USING_CAST_TO_CHAR(type)           \
    CMN_DATA_DE_SERIALIZE_BINARY_STREAM_USING_CAST_TO_CHAR_NO_BYTE_SWAP(type) \
    CMN_DATA_SERIALIZE_TEXT_USING_STREAM_OUT(type)                      \
    CMN_DATA_DE_SERIALIZE_TEXT_USING_STREAM_IN(type)                    \
    CMN_DATA_HUMAN_READABLE_USING_STREAM_OUT(type)                      \
    CMN_DATA_SCALAR_DESCRIPTION(type, description)                      \
    CMN_DATA_SCALAR_USING_STATIC_CAST(type)                             \
    CMN_DATA_SCALAR_NUMBER_IS_ONE(type)                                 \
    CMN_DATA_SCALAR_NUMBER_IS_FIXED_TRUE(type)                          \
    };