cmnGenericObject.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: 2004-08-18
 
  (C) Copyright 2004-2017 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 _cmnGenericObject_h
#define _cmnGenericObject_h
 
#include <cisstCommon/cmnPortability.h>
#include <cisstCommon/cmnForwardDeclarations.h>
#include <cisstCommon/cmnLogger.h>
#include <cisstCommon/cmnThrow.h>
 
#include <string>
#include <iostream>
 
#if CISST_HAS_JSON
#include <json/json.h>
#endif // CISST_HAS_JSON
 
// Always include last
#include <cisstCommon/cmnExport.h>

class CISST_EXPORT cmnGenericObject {
public:

    virtual ~cmnGenericObject(void) {};

    virtual const cmnClassServicesBase * Services(void) const = 0;

    bool ReconstructFrom(const cmnGenericObject & other);

    std::string ToString(void) const;

    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);

    virtual cmnLogger::StreamBufType * GetLogMultiplexer(void) const;


    virtual size_t ScalarNumber(void) const {
        return 0;
    }

    virtual bool ScalarNumberIsFixed(void) const {
        return false;
    }

    virtual double Scalar(const size_t CMN_UNUSED(index)) const CISST_THROW(std::out_of_range) {
        cmnThrow(std::out_of_range("cmnGenericObject::Scalar base method called, no scalar"));
        return 0.0;
    }

    virtual std::string ScalarDescription(const size_t CMN_UNUSED(index), const std::string & CMN_UNUSED(userDescription)) const {
        cmnThrow(std::out_of_range("cmnGenericObject::ScalarDescription base method called, no scalar"));
        return "index out of range";
    }
 
#if CISST_HAS_JSON
    virtual void SerializeTextJSON(Json::Value & CMN_UNUSED(jsonValue)) const {};
    virtual void DeSerializeTextJSON(const Json::Value & CMN_UNUSED(jsonValue))
        CISST_THROW(std::runtime_error) {};
#endif // CISST_HAS_JSON
};
 

inline
std::ostream & operator << (std::ostream & output,
                            const cmnGenericObject & object) {
    object.ToStream(output);
    return output;
}
 
 
// the following header files are usually needed with cmnGenericObject
#include <cisstCommon/cmnClassServices.h>
#include <cisstCommon/cmnClassRegister.h>
#include <cisstCommon/cmnClassRegisterMacros.h>
 
 
#endif // _cmnGenericObject_h