/usr/include/openturns/GraphImplementation.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 | // -*- C++ -*-
/**
* @file GraphImplementation.hxx
* @brief GraphImplementation implements graphic devices for plotting through R
*
* (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: GraphImplementation.hxx 2046 2011-07-28 16:31:43Z schueller $
*/
#ifndef OPENTURNS_GRAPHIMPLEMENTATION_HXX
#define OPENTURNS_GRAPHIMPLEMENTATION_HXX
#include "PersistentObject.hxx"
#include "PersistentCollection.hxx"
#include "Drawable.hxx"
#include "Exception.hxx"
#include "Interval.hxx"
namespace OpenTURNS
{
namespace Base
{
namespace Graph
{
/**
* @class GraphImplementation
*
* GraphImplementation implements graphic devices for plotting through R,
* and manages drawables to be plotted on the same window
*/
class GraphImplementation :
public Common::PersistentObject
{
CLASSNAME;
public:
typedef Drawable::Description Description;
typedef Common::InvalidArgumentException InvalidArgumentException;
typedef Common::InternalException InternalException;
typedef Common::StorageManager StorageManager;
typedef Type::NumericalPoint BoundingBox;
typedef Type::Interval Interval;
typedef Type::Collection<Drawable> DrawableCollection;
typedef Type::PersistentCollection<Drawable> DrawablePersistentCollection;
// Default string value
static const String NoSpecifiedLabel;
// Default dimensions for the bitmap
static const UnsignedLong DefaultWidth;
static const UnsignedLong DefaultHeight;
// Default font size for the legend
static const NumericalScalar DefaultLegendFontSize;
static const UnsignedLong BoundingBoxSize;
static Description ValidLegendPositions;
static Bool IsFirstInitialization;
enum Format { ALL = 0, PNG, EPS, FIG, PDF };
enum LogScale { NONE = 0, LOGX, LOGY, LOGXY };
/** Default constructor */
explicit GraphImplementation();
/** Constructor with parameters */
GraphImplementation(const String & title,
const String & xTitle,
const String & yTitle,
const Bool showAxes,
const String & legendPosition = NoSpecifiedLabel,
const NumericalScalar legendFontSize = DefaultLegendFontSize,
const LogScale logScale = NONE) /* throw(InvalidArgumentException) */;
/** Virtual constructor */
virtual GraphImplementation * clone() const;
/** String converter */
String __repr__() const;
/** Adds a drawable instance to the collection of drawables contained in GraphImplementation */
void add(const Drawable & aDrawable);
/** Adds a collection of drawable instances to the collection of drawables contained in GraphImplementation */
void add(const DrawableCollection & drawableCollection);
/** Adds a drawable instance to the collection of drawables contained in GraphImplementation
* @deprecated */
void addDrawable(const Drawable & aDrawable) DEPRECATED;
/** Adds a collection of drawable instances to the collection of drawables contained in GraphImplementation
* @deprecated */
void addDrawables(const DrawableCollection & drawableCollection) DEPRECATED;
/** Drawables accessor */
DrawableCollection getDrawables() const;
void setDrawables(const DrawableCollection & drawableCollection);
/** Individual drawable accessor */
Drawable getDrawable(const UnsignedLong index) const;
void setDrawable(const Drawable & drawable,
const UnsignedLong index);
/** Hide or show x and y axes */
void setAxes(const Bool showAxes);
/** Accessor for showAxes_ */
Bool getAxes() const;
/** Set log scale for x, y both or none axes */
void setLogScale(const LogScale logScale);
/** Accessor for logScale_ */
LogScale getLogScale() const;
/** Hide or show grid */
void setGrid(const Bool showGrid);
/** Accessor for showGrid_ */
Bool getGrid() const;
/** Accesor for xTitle */
String getXTitle() const;
/** Accessor for xTitle */
void setXTitle(const String & title);
/** Accessor for yTitle */
String getYTitle() const;
/** Accessor for yTitle */
void setYTitle(const String & title);
/** Accesor for title */
String getTitle() const;
/** Accesor for title */
void setTitle(const String & title);
/** Accessor for path */
String getPath() const;
/** Accessor for file name */
String getFileName() const;
/** The method that generates the graphic files */
void draw(const String & path,
const String & file,
const NumericalScalar width,
const NumericalScalar height,
const Format format = ALL) /* throw(InternalException) */;
/** The method that generates the graphic files */
void draw(const String & file,
const NumericalScalar width = DefaultWidth,
const NumericalScalar height = DefaultHeight,
const Format format = ALL) /* throw(InternalException) */;
/** Get the R command corresponding to the graph */
String getRCommand() const;
/** Clean temporary files */
void clean();
/** The method returning absolute path of the bitmap graphic file */
String getBitmap() const;
/** The method returning absolute path of the postscript graphic file */
String getPostscript() const;
/** The method returning absolute path of the PDF graphic file */
String getPDF() const;
/** The method returning absolute path of the vectorial graphic file */
String getVectorial() const;
/** Get the bounding box of the whole plot */
BoundingBox getBoundingBox() const;
/** Set the bounding box of the whole plot */
void setBoundingBox(const BoundingBox & boundingBox);
/** Set the bounding box of the whole plot */
void setBoundingBox(const Interval & boundingBox);
/** Automatic bounding box accessor */
Bool getAutomaticBoundingBox() const;
void setAutomaticBoundingBox(const Bool automaticBoundingBox);
/** Get the legend position */
String getLegendPosition() const;
/** Set the legend position */
void setLegendPosition(const String & position) /* throw(InvalidArgumentException) */;
/** Get the legend font size */
NumericalScalar getLegendFontSize() const;
/** Set the legend font size */
void setLegendFontSize(const NumericalScalar legendFontSize) /* throw(InvalidArgumentException) */;
/** Check for legend position validity */
Bool isValidLegendPosition(const String & position) const;
/** Initialize valid legend positions **/
static void initializeValidLegendPositions();
/** Method save() stores the object through the StorageManager */
void save(StorageManager::Advocate & adv) const;
/** Method load() reloads the object from the StorageManager */
void load(StorageManager::Advocate & adv);
/** Gives all the valid legend positions */
static Description GetValidLegendPositions();
private :
/** Compute the best bounding box to enclose all the drawables */
void computeBoundingBox() const;
/** Make R legend command */
String makeRLegendCommand() const;
/** Make R header command */
String makeRHeaderCommand() const;
/** Make R core command */
String makeRCoreCommand() const;
/** GraphImplementationic main title */
String title_;
/** Legend position */
String legendPosition_;
/** Legend font size */
NumericalScalar legendFontSize_;
/** x axis title */
String xTitle_;
/** y axis title */
String yTitle_;
/** if TRUE, displays the axes on the graphic plot. if FALSE, hides the axes */
Bool showAxes_;
/** Set the log scale for one, both or non of the axes */
LogScale logScale_;
/** if TRUE, displays a grid on the graphic plot. if FALSE, hides the grid */
Bool showGrid_;
/** Is the bounding box automatically computed. */
Bool automaticBoundingBox_;
/** Current bounding box */
/* The format is:
* bb[0] = xmin
* bb[1] = xmax
* bb[2] = ymin
* bb[3] = ymax
*/
mutable BoundingBox boundingBox_;
/** The drawables to be plotted */
DrawablePersistentCollection drawablesCollection_;
/** Path to latest files generated */
String path_;
/** Name of the graphic file*/
String fileName_;
}; /* class GraphImplementation */
}/* namespace GraphImplementation */
}/* namespace Base */
}/* namespace OpenTURNS */
#endif /* OPENTURNS_GRAPHIMPLEMENTATION_HXX */
|