cmnGenericObjectProxy.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):    Ankur Kapoor, Anton Deguet
  Created on:   2006-05-05

  (C) Copyright 2006-2007 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 _cmnGenericObjectProxy_h
#define _cmnGenericObjectProxy_h

#include <cisstCommon/cmnGenericObject.h>
#include <cisstCommon/cmnClassRegister.h>
#include <cisstCommon/cmnSerializer.h>
#include <cisstCommon/cmnDeSerializer.h>
#include <cisstCommon/cmnExport.h>

template <class _elementType>
class cmnGenericObjectProxy: public cmnGenericObject
{
    CMN_DECLARE_SERVICES_EXPORT(CMN_DYNAMIC_CREATION, CMN_LOG_ALLOW_DEFAULT);

public:
    typedef cmnGenericObjectProxy<_elementType> ThisType;
    typedef _elementType value_type;
    value_type Data;

    inline cmnGenericObjectProxy(void)
    {}

    inline cmnGenericObjectProxy(const value_type & data):
        Data(data)
    {}

    inline ~cmnGenericObjectProxy(void) {}

    inline ThisType & operator=(value_type data) {
        Data = data;
        return *this;
    }

    inline operator value_type & (void) {
        return Data;
    }
    inline operator const value_type & (void) const {
        return this->Data;
    }

    inline void SerializeRaw(std::ostream & outputStream) const {
        cmnSerializeRaw(outputStream, this->Data);
    }

    inline void DeSerializeRaw(std::istream & inputStream) {
        cmnDeSerializeRaw(inputStream, this->Data);
    }

    inline virtual void ToStream(std::ostream & outputStream) const {
        outputStream << Data;
    }

    inline virtual void ToStreamRaw(std::ostream & outputStream, const char CMN_UNUSED(delimiter) = ' ',
                                    bool headerOnly = false, const std::string & headerPrefix = "") const {
        if (headerOnly) {
            outputStream << headerPrefix << "-data";
        } else {
            outputStream << this->Data;
        }
    }

    inline virtual bool FromStreamRaw(std::istream & inputStream, const char CMN_UNUSED(delimiter) = ' ') {
        inputStream >> this->Data;  // assumes that operator >> is defined for _elementType
        bool valid = inputStream.good();
        if (!valid) inputStream.clear();
        return valid;
    }

};

/* Some basic types defined here for now, could move somewhere
   else. */
typedef cmnGenericObjectProxy<double> cmnDouble;
CMN_DECLARE_SERVICES_INSTANTIATION(cmnDouble);

typedef cmnGenericObjectProxy<long> cmnLong;
CMN_DECLARE_SERVICES_INSTANTIATION(cmnLong);

typedef cmnGenericObjectProxy<unsigned long> cmnULong;
CMN_DECLARE_SERVICES_INSTANTIATION(cmnULong);

typedef cmnGenericObjectProxy<long long> cmnLongLong;
CMN_DECLARE_SERVICES_INSTANTIATION(cmnLongLong);

typedef cmnGenericObjectProxy<unsigned long long> cmnULongLong;
CMN_DECLARE_SERVICES_INSTANTIATION(cmnULongLong);

typedef cmnGenericObjectProxy<int> cmnInt;
CMN_DECLARE_SERVICES_INSTANTIATION(cmnInt);

typedef cmnGenericObjectProxy<unsigned int> cmnUInt;
CMN_DECLARE_SERVICES_INSTANTIATION(cmnUInt);

typedef cmnGenericObjectProxy<short> cmnShort;
CMN_DECLARE_SERVICES_INSTANTIATION(cmnShort);

typedef cmnGenericObjectProxy<unsigned short> cmnUShort;
CMN_DECLARE_SERVICES_INSTANTIATION(cmnUShort);

typedef cmnGenericObjectProxy<char> cmnChar;
CMN_DECLARE_SERVICES_INSTANTIATION(cmnChar);

typedef cmnGenericObjectProxy<unsigned char> cmnUChar;
CMN_DECLARE_SERVICES_INSTANTIATION(cmnUChar);

typedef cmnGenericObjectProxy<bool> cmnBool;
CMN_DECLARE_SERVICES_INSTANTIATION(cmnBool);


#endif