mtsGenericObject.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: 2009-04-13

  (C) Copyright 2009-2013 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 ---

*/


#ifndef _mtsGenericObject_h
#define _mtsGenericObject_h

#include <cisstCommon/cmnGenericObject.h>
#include <cisstCommon/cmnDataFunctions.h>
#include <cisstCommon/cmnSerializer.h>
#include <cisstCommon/cmnDeSerializer.h>

#include <cisstMultiTask/mtsMacros.h>

#if CISST_HAS_JSON
#include <cisstCommon/cmnDataFunctionsJSON.h>
#endif // CISST_HAS_JSON

// Always include last!
#include <cisstMultiTask/mtsExport.h>

#include <string>
#include <iostream>


class CISST_EXPORT mtsGenericObject: public cmnGenericObject {

    typedef cmnGenericObject BaseType;

    CMN_DECLARE_MEMBER_AND_ACCESSORS(double, Timestamp);

    CMN_DECLARE_MEMBER_AND_ACCESSORS(bool, AutomaticTimestamp);

    CMN_DECLARE_MEMBER_AND_ACCESSORS(bool, Valid);

public:

    inline mtsGenericObject(void):
        cmnGenericObject(),
        TimestampMember(0.0),
        AutomaticTimestampMember(true),
        ValidMember(false)
    {}

    inline mtsGenericObject(double timestamp, bool automaticTimestamp, bool valid):
        TimestampMember(timestamp),
        AutomaticTimestampMember(automaticTimestamp),
        ValidMember(valid)
    {}

    inline mtsGenericObject(const mtsGenericObject & other):
        cmnGenericObject(other),
        TimestampMember(other.TimestampMember),
        AutomaticTimestampMember(other.AutomaticTimestampMember),
        ValidMember(other.ValidMember)
    {}

    inline virtual ~mtsGenericObject(void)
    {}

    bool SetTimestampIfAutomatic(double timestamp);

    virtual void ToStream(std::ostream & outputStream) const;

    virtual void ToStreamRaw(std::ostream & outputStream, const char delimiter = ' ',
                             bool headerOnly = false, const std::string & headerPrefix = "") const;

    virtual bool FromStreamRaw(std::istream & inputStream, const char delimiter = ' ');

    virtual void SerializeRaw(std::ostream & outputStream) const;

    virtual void DeSerializeRaw(std::istream & inputStream);

    /* documented in base class */
    size_t ScalarNumber(void) const;
    bool ScalarNumberIsFixed(void) const;

    /* documented in base class */
    double Scalar(const size_t index) const throw (std::out_of_range);

    /* documented in base class */
    std::string ScalarDescription(const size_t index, const std::string & userDescription = "") const throw (std::out_of_range);
};

template <> void CISST_EXPORT cmnData<mtsGenericObject>::Copy(mtsGenericObject & data, const mtsGenericObject & source);

template <> void CISST_EXPORT cmnData<mtsGenericObject>::SerializeBinary(const mtsGenericObject & data, std::ostream & outputStream) throw (std::runtime_error);

template <> void CISST_EXPORT cmnData<mtsGenericObject>::DeSerializeBinary(mtsGenericObject & data, std::istream & inputStream,
                                                                           const cmnDataFormat & localFormat, const cmnDataFormat & remoteFormat) throw (std::runtime_error);

template <> void CISST_EXPORT cmnData<mtsGenericObject>::SerializeText(const mtsGenericObject & data, std::ostream & outputStream, const char delimiter) throw (std::runtime_error);

template <> std::string CISST_EXPORT cmnData<mtsGenericObject>::SerializeDescription(const mtsGenericObject & data, const char delimiter, const std::string & userDescription);

template <> void CISST_EXPORT cmnData<mtsGenericObject>::DeSerializeText(mtsGenericObject & data, std::istream & inputStream, const char delimiter) throw (std::runtime_error);

template <> std::string CISST_EXPORT cmnData<mtsGenericObject>::HumanReadable(const mtsGenericObject & data);

template <> bool CISST_EXPORT cmnData<mtsGenericObject>::ScalarNumberIsFixed(const mtsGenericObject & data);

template <> size_t CISST_EXPORT cmnData<mtsGenericObject>::ScalarNumber(const mtsGenericObject & data);

template <> double CISST_EXPORT cmnData<mtsGenericObject>::Scalar(const mtsGenericObject & data, const size_t index) throw (std::out_of_range);

template <> std::string CISST_EXPORT cmnData<mtsGenericObject>::ScalarDescription(const mtsGenericObject & data, const size_t index, const std::string & userDescription) throw (std::out_of_range);

#if CISST_HAS_JSON
template <> void CISST_EXPORT cmnDataJSON<mtsGenericObject>::SerializeText(const mtsGenericObject & data, Json::Value & jsonValue);
template <> void CISST_EXPORT cmnDataJSON<mtsGenericObject>::DeSerializeText(mtsGenericObject & data, const Json::Value & jsonValue) throw (std::runtime_error);
#endif // CISST_HAS_JSON

#endif // _mtsGenericObject_h