/usr/include/openturns/Object.hxx is in libopenturns-dev 1.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 | // -*- C++ -*-
/**
* @file Object.hxx
* @brief The class Object is the top-most class of Open TURNS
*
* Copyright (C) 2005-2013 EDF-EADS-Phimeca
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* @author schueller
* @date 2012-02-17 19:35:43 +0100 (Fri, 17 Feb 2012)
*/
#ifndef OPENTURNS_OBJECT_HXX
#define OPENTURNS_OBJECT_HXX
#include <iostream> // for std::ostream
#include <sstream> // for std::ostringstream
#include "OTprivate.hxx"
/** Declare GetClassName() and getClassName() for Object-like classes */
#define CLASSNAME \
public: \
/** Class name accessor */ \
static OT::String GetClassName(); \
virtual OT::String getClassName() const; \
/** Define GetClassName() and getClassName() for Object-like classes */
#define CLASSNAMEINIT(T) \
OT::String T::GetClassName() { return OT::String(#T); } \
OT::String T::getClassName() const { return T::GetClassName(); } \
#define TEMPLATE_CLASSNAMEINIT(T) \
template<> OT::String T::GetClassName() { return OT::String(#T); } \
template<> OT::String T::getClassName() const { return T::GetClassName(); } \
BEGIN_NAMESPACE_OPENTURNS
/**
* @class Object
*
* @brief The base classe for almost every object in Open TURNS.
*
* Object defines common methods needed by all classes.
* These are default constructor, copy constructor, virtual
* destructor, affectation operator, comparison operator and
* string converters.
* These methods should be overloaded by every derived class
*/
class Object
{
CLASSNAME;
public:
/** Destructor */
virtual ~Object() = 0;
/**
* String converter
*
* This method shows human readable information on the
* internal state of an object. It is used when streaming
* the object or for user information.
*
* @return A string fully describing the object
*/
virtual String __repr__() const;
/**
* Pretty string converter
*
* This method shows human readable information on the
* internal state of an object. It is used for printing the object
* and should only show relevant information.
*
* @return A human readable string
*/
virtual String __str__(const String & offset = "") const;
protected:
private:
} ; /* class Object */
#ifndef SWIG
/**
* @fn std::ostream & operator <<(std::ostream & os, const Object & obj)
* @brief Output stream converter
* @param os A STL output stream object
* @param obj The object read by \p os
* @return A reference to \p os
*
* This method allows any Object-derived class to be streamed whitout
* redefining this method. Each derived-class should have a public
* method str() that returns a String.
*
* @sa String __repr__() const
*/
std::ostream & operator <<(std::ostream & os, const Object & obj);
#endif
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_OBJECT_HXX */
|