/usr/include/openturns/DrawableImplementation.hxx is in libopenturns-dev 0.15-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 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 | // -*- C++ -*-
/**
* @file DrawableImplementation.hxx
* @brief Abstract top-level class for all drawables
*
* (C) Copyright 2005-2011 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 2.1 of the License.
*
* 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
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author: $LastChangedBy: schueller $
* @date: $LastChangedDate: 2011-07-28 18:31:43 +0200 (Thu, 28 Jul 2011) $
* Id: $Id: DrawableImplementation.hxx 2046 2011-07-28 16:31:43Z schueller $
*/
#ifndef OPENTURNS_DRAWABLEIMPLEMENTATION_HXX
#define OPENTURNS_DRAWABLEIMPLEMENTATION_HXX
#include <map>
#include "Description.hxx"
#include "Collection.hxx"
#include "PersistentObject.hxx"
#include "NumericalSample.hxx"
#include "Exception.hxx"
namespace OpenTURNS {
namespace Base {
namespace Graph {
/**
* @class DrawableImplementation
*
* The class describes the a drawable graphic
* Instances of this class can actually be plotted
*/
class DrawableImplementation :
public Common::PersistentObject
{
CLASSNAME;
public:
typedef Type::NumericalPoint NumericalPoint;
typedef Type::Description Description;
typedef NumericalPoint BoundingBox;
typedef Common::InvalidArgumentException InvalidArgumentException;
typedef Common::StorageManager StorageManager;
typedef Common::PersistentObject PersistentObject;
typedef Stat::NumericalSample NumericalSample;
/** default graphic paramaters */
static String NoSpecifiedLabel;
static String DefaultColor;
static String DefaultSurfaceColor;
static String DefaultFillStyle;
static String DefaultPointStyle;
static String DefaultLineStyle;
static String DefaultPattern;
static String AlternativePattern;
static const UnsignedLong DefaultLineWidth;
static const UnsignedLong DataThreshold;
/** Default Constructor with legend label */
DrawableImplementation(const NumericalSample & data,
const String & legend = NoSpecifiedLabel)
/* throw(InvalidArgumentException) */;
/** String converter */
virtual String __repr__() const;
/** Comparison operator */
Bool operator == (const DrawableImplementation & other) const;
/** Code for point style accessor */
virtual UnsignedLong getPointCode(const String & key) const;
/** Check validity of data */
virtual Bool isValidData(const NumericalSample & data) const;
/** Check validity of color */
virtual Bool isValidColor(const String & key) const;
/** Check validity of line style */
virtual Bool isValidLineStyle(const String & key) const;
/** Check validity of point style */
virtual Bool isValidPointStyle(const String & key) const;
/** Check validity of fill style */
virtual Bool isValidFillStyle(const String & key) const;
/** Check validity of pattern parameter */
virtual Bool isValidPattern(const String & pattern) const;
/** Legend name accessor */
virtual String getLegendName() const;
virtual void setLegendName(const String & legendName);
/** Data accessor */
virtual NumericalSample getData() const;
/** Line style accessor */
virtual String getLineStyle() const;
virtual void setLineStyle(const String & lineStyle)
/* throw(InvalidArgumentException) */;
/** Color accessor */
virtual String getColor() const;
virtual void setColor(const String & color)
/* throw(InvalidArgumentException) */;
/** Point style accessor */
virtual String getPointStyle() const;
virtual void setPointStyle(const String & pointStyle)
/* throw(InvalidArgumentException) */;
/** Filling style (for surfaces) accessor */
virtual String getFillStyle() const;
virtual void setFillStyle(const String & fillStyle)
/* throw(InvalidArgumentException) */;
/** Line width accessor */
virtual UnsignedLong getLineWidth() const;
virtual void setLineWidth(const UnsignedLong lineWidth)
/* throw(InvalidArgumentException) */;
/** Accessor for pattern */
virtual String getPattern() const;
virtual void setPattern(const String style) /* throw(InvalidArgumentException) */;
/** Show points accessors */
virtual void setShowPoints(const Bool showPoints);
virtual Bool getShowPoints() const;
/** Accessor for center */
virtual NumericalPoint getCenter() const;
virtual void setCenter(const NumericalPoint & center);
/** Accessor for radius */
virtual NumericalScalar getRadius() const;
virtual void setRadius(const NumericalScalar radius);
/** Accessor for labels */
virtual Description getLabels() const;
virtual void setLabels(const Description & labels);
/** Accessor for color palette */
virtual Description getPalette() const;
virtual void setPalette(const Description & palette)
/* throw(InvalidArgumentException) */;
/** Accessor for origin */
virtual NumericalScalar getOrigin() const;
virtual void setOrigin(const NumericalScalar origin);
/** Accessor for first coordinate */
virtual NumericalSample getX() const;
virtual void setX(const NumericalSample & x);
/** Accessor for second coordinate */
virtual NumericalSample getY() const;
virtual void setY(const NumericalSample & y);
/** Accessor for levels */
virtual NumericalPoint getLevels() const;
virtual void setLevels(const NumericalPoint & levels);
/** Accessor for drawLabels */
virtual Bool getDrawLabels() const;
virtual void setDrawLabels(const Bool & drawLabels);
/** Bounding box accessor */
virtual BoundingBox getBoundingBox() const;
/** R command generating method, for plotting through R */
virtual String draw() const;
/** Clean all the temporary data created by draw() method */
virtual void clean() const;
/** Clone method */
virtual DrawableImplementation * clone() const;
/** Give the colors name */
static Description GetValidColors();
/** Give the line style names */
static Description GetValidLineStyles();
/** Give the fill style names */
static Description GetValidFillStyles();
/** Give the point style names */
static Description GetValidPointStyles();
/** Convert an RGB triplet to a valid hexadecimal code */
static String ConvertFromRGB(const UnsignedLong red,
const UnsignedLong green,
const UnsignedLong blue);
/** Convert an RGBA quadruplet to a valid hexadecimal code */
static String ConvertFromRGBA(const UnsignedLong red,
const UnsignedLong green,
const UnsignedLong blue,
const UnsignedLong alpha);
/** Convert an RGB triplet to a valid hexadecimal code */
static String ConvertFromRGB(const NumericalScalar red,
const NumericalScalar green,
const NumericalScalar blue);
/** Convert an RGBA quadruplet to a valid hexadecimal code */
static String ConvertFromRGBA(const NumericalScalar red,
const NumericalScalar green,
const NumericalScalar blue,
const NumericalScalar alpha);
/** Method save() stores the object through the StorageManager */
void save(StorageManager::Advocate & adv) const;
/** Method load() stores the object through the StorageManager */
void load(StorageManager::Advocate & adv);
protected:
DrawableImplementation() {};
friend class Base::Common::Factory<DrawableImplementation>;
static Bool IsFirstInitialization;
/** A map matching keys with R codes for point symbols */
static std::map<String, UnsignedLong> SymbolCodes;
/** Valid colors */
static Description ValidColors;
/** Valid line styles */
static Description ValidLineStyles;
/** Valid fill styles */
static Description ValidFillStyles;
/** Bounding box size */
static const UnsignedLong BoundingBoxSize;
/** Data accessor */
virtual void setData(const NumericalSample & data)
/* throw(InvalidArgumentException) */;
/** The name of the drawable, to be displayed in the legend */
String legendName_;
/** The data to be plotted */
NumericalSample data_;
/** Color of the curve */
String color_;
/** Fill style */
String fillStyle_;
/** Line style of the curve */
String lineStyle_;
/** Line style of the curve */
String pointStyle_;
/** Line width of the curve */
UnsignedLong lineWidth_;
/** Initialize Valid parameter list */
static void InitializeValidParameterList();
private:
/** Temporary file name for the exchange with R */
mutable String dataFileName_;
}; /* class DrawableImplementation */
} /* namespace Graph */
}/* namespace Base */
}/* namespace OpenTURNS */
#endif /* OPENTURNS_DRAWABLEIMPLEMENTATION_HXX */
|