/usr/include/sbml/packages/render/extension/RenderLayoutPlugin.h is in libsbml5-dev 5.16.0+dfsg-1.
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 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 | /**
* @file RenderLayoutPlugin.h
* @brief Definition of RenderLayoutPlugin, the plugin class of
* fbc package for the Model element.
* @author Frank T. Bergmann
*
*<!---------------------------------------------------------------------------
* This file is part of libSBML. Please visit http://sbml.org for more
* information about SBML, and the latest version of libSBML.
*
* Copyright (C) 2013-2017 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
* 3. University of Heidelberg, Heidelberg, Germany
*
* Copyright (C) 2009-2013 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
*
* 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. A copy of the license agreement is provided
* in the file named "LICENSE.txt" included with this software distribution
* and also available online as http://sbml.org/software/libsbml/license.html
*------------------------------------------------------------------------- -->
*/
#ifndef RenderLayoutPlugin_h
#define RenderLayoutPlugin_h
#include <sbml/common/extern.h>
#include <sbml/common/sbmlfwd.h>
#include <sbml/packages/render/common/renderfwd.h>
#ifdef __cplusplus
#include <sbml/SBMLErrorLog.h>
#include <sbml/Model.h>
#include <sbml/xml/XMLInputStream.h>
#include <sbml/xml/XMLOutputStream.h>
#include <sbml/extension/SBasePlugin.h>
#include <sbml/packages/render/extension/RenderExtension.h>
#include <sbml/packages/render/sbml/LocalRenderInformation.h>
LIBSBML_CPP_NAMESPACE_BEGIN
class LIBSBML_EXTERN RenderLayoutPlugin : public SBasePlugin
{
public:
/**
* Constructor
*/
RenderLayoutPlugin (const std::string &uri, const std::string &prefix,
RenderPkgNamespaces *groupsns);
/**
* Copy constructor. Creates a copy of this SBase object.
*/
RenderLayoutPlugin (const RenderLayoutPlugin & orig);
/**
* Destroy this object.
*/
virtual ~RenderLayoutPlugin ();
/**
* Assignment operator for RenderLayoutPlugin .
*/
RenderLayoutPlugin & operator=(const RenderLayoutPlugin & orig);
/**
* Creates and returns a deep copy of this RenderLayoutPlugin object.
*
* @return a (deep) copy of this RenderLayoutPlugin object
*/
virtual RenderLayoutPlugin * clone () const;
// --------------------------------------------------------
//
// overridden virtual functions for reading/writing/checking
// elements
//
// --------------------------------------------------------
/**
* Returns a pointer to the list object that contains local render information.
*/
ListOfLocalRenderInformation* getListOfLocalRenderInformation();
/**
* Returns a const pointer to the list object that contains local render information.
*/
const ListOfLocalRenderInformation* getListOfLocalRenderInformation() const;
/**
* Returns the number of local render information objects.
*/
unsigned int getNumLocalRenderInformationObjects() const;
/**
* Returns a pointer to the local render information object with the given
* index.
* If the index is invalid, @c NULL is returned.
*/
LocalRenderInformation* getRenderInformation(unsigned int index);
/**
* Returns a const pointer to the local render information object with the given
* index.
* If the index is invalid, @c NULL is returned.
*/
const LocalRenderInformation* getRenderInformation(unsigned int index) const;
/**
* Returns a pointer to the local render information object with the given
* id.
* If no object with the given @p id exists, @c NULL is returned.
*/
LocalRenderInformation* getRenderInformation(const std::string& id);
/**
* Returns a const pointer to the local render information object with the given
* id.
* If no object with the given @p id exists, @c NULL is returned.
*/
const LocalRenderInformation* getRenderInformation(const std::string& id) const;
/**
* Adds a copy of the given local render information object to the list of
* local render information objects.
* If an object with the same id exists, it is replaced.
*/
void addLocalRenderInformation(const LocalRenderInformation* pLRI);
/**
* Creates a new local render information object and adds it to the list.
* The created object does not have a id and it is the responsibility of
* the calling code to ensure that it gets one.
* For constraints on the id, please consult the render information document.
*/
LocalRenderInformation* createLocalRenderInformation();
/**
* Removed the render information with the given index from the list.
* The removed object is returned. It is the responsibility of the calling
* code to delete the object.
* If the index is not valid, @c NULL is returned.
*/
LocalRenderInformation* removeLocalRenderInformation(unsigned int index);
/**
* Removed the render information with the given @p id from the list.
* The removed object is returned. It is the responsibility of the calling
* code to delete the object.
* If an object with the given @p id does not exist, @c NULL is returned.
*/
LocalRenderInformation* removeLocalRenderInformation(const std::string& id);
/**
* Returns a List of all child SBase objects, including those nested to an
* arbitrary depth
*
* @return a List* of pointers to all children objects.
*/
virtual List* getAllElements(ElementFilter* filter=NULL);
/**
* Sets the value of the "annotation" subelement of this SBML object to a
* copy of @p annotation.
*
* Any existing content of the "annotation" subelement is discarded.
* Unless you have taken steps to first copy and reconstitute any
* existing annotations into the @p annotation that is about to be
* assigned, it is likely that performing such wholesale replacement is
* unfriendly towards other software applications whose annotations are
* discarded. An alternative may be to use appendAnnotation().
*
* @param annotation an XML structure that is to be used as the content
* of the "annotation" subelement of this object
*
* @see appendAnnotation(const XMLNode* annotation)
*/
//virtual int setAnnotation (const XMLNode* annotation);
/**
* Sets the value of the "annotation" subelement of this SBML object to a
* copy of @p annotation.
*
* Any existing content of the "annotation" subelement is discarded.
* Unless you have taken steps to first copy and reconstitute any
* existing annotations into the @p annotation that is about to be
* assigned, it is likely that performing such wholesale replacement is
* unfriendly towards other software applications whose annotations are
* discarded. An alternative may be to use appendAnnotation().
*
* @param annotation an XML string that is to be used as the content
* of the "annotation" subelement of this object
*
* @see appendAnnotation(const std::string& annotation)
*/
//virtual int setAnnotation (const std::string& annotation);
/**
* Appends annotation content to any existing content in the "annotation"
* subelement of this object.
*
* The content in @p annotation is copied. Unlike setAnnotation(), this
* method allows other annotations to be preserved when an application
* adds its own data.
*
* @param annotation an XML structure that is to be copied and appended
* to the content of the "annotation" subelement of this object
*
* @see setAnnotation(const XMLNode* annotation)
*/
//virtual int appendAnnotation (const XMLNode* annotation);
/**
* Appends annotation content to any existing content in the "annotation"
* subelement of this object.
*
* The content in @p annotation is copied. Unlike setAnnotation(), this
* method allows other annotations to be preserved when an application
* adds its own data.
*
* @param annotation an XML string that is to be copied and appended
* to the content of the "annotation" subelement of this object
*
* @see setAnnotation(const std::string& annotation)
*/
//virtual int appendAnnotation (const std::string& annotation);
/** @cond doxygenLibsbmlInternal */
/**
* Subclasses must override this method to create, store, and then
* return an SBML object corresponding to the next XMLToken in the
* XMLInputStream if they have their specific elements.
*
* @return the SBML object corresponding to next XMLToken in the
* XMLInputStream or NULL if the token was not recognized.
*/
virtual SBase* createObject (XMLInputStream& stream);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Subclasses must override this method to write out their contained
* SBML objects as XML elements if they have their specific elements.
*/
virtual void writeElements (XMLOutputStream& stream) const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Serialize the render information as L2 annotation
*/
virtual void writeAttributes (XMLOutputStream& stream) const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Checks if this plugin object has all the required elements.
*
* Subclasses should override this function if they have their specific
* elements.
*
* @return true if this pugin object has all the required elements,
* otherwise false will be returned.
*/
virtual bool hasRequiredElements() const ;
/** @endcond */
/** ------------------------------------------------------------------
*
* Additional public functions
*
* ------------------------------------------------------------------
*/
// ---------------------------------------------------------
//
// virtual functions (internal implementation) which should
// be overridden by subclasses.
//
// ---------------------------------------------------------
/** @cond doxygenLibsbmlInternal */
/**
* Sets the parent SBMLDocument of this plugin object.
*
* Subclasses which contain one or more SBase derived elements must
* override this function.
*
* @param d the SBMLDocument object to use
*
* @see connectToParent
* @see enablePackageInternal
*/
virtual void setSBMLDocument (SBMLDocument* d);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Sets the parent SBML object of this plugin object to
* this object and child elements (if any).
* (Creates a child-parent relationship by this plugin object)
*
* This function is called when this object is created by
* the parent element.
* Subclasses must override this this function if they have one
* or more child elements.Also, SBasePlugin::connectToParent()
* must be called in the overridden function.
*
* @param sbase the SBase object to use
*
* @see setSBMLDocument
* @see enablePackageInternal
*/
virtual void connectToParent (SBase *sbase);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Enables/Disables the given package with child elements in this plugin
* object (if any).
* (This is an internal implementation invoked from
* SBase::enablePakcageInternal() function)
*
* @note Subclasses in which one or more SBase derived elements are
* defined must override this function.
*
* @see setSBMLDocument
* @see connectToParent
*/
virtual void enablePackageInternal(const std::string& pkgURI,
const std::string& pkgPrefix, bool flag);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Accepts the given SBMLVisitor.
*
* @return the result of calling <code>v.visit()</code>, which indicates
* whether or not the Visitor would like to visit the SBML object's next
* sibling object (if available).
*/
virtual bool accept (SBMLVisitor& v) const;
/** @endcond */
protected:
/*-- data members --*/
/** @cond doxygenLibsbmlInternal */
ListOfLocalRenderInformation mLocalRenderInformation;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Synchronizes the annotation of this SBML object.
*
* Annotation element (XMLNode* mAnnotation) is synchronized with the
* current CVTerm objects (List* mCVTerm), ModelHistory object
* (ModelHistory* mHistory) and ListOfLayouts object (ListOfLayouts mLayouts).
* Currently, this method is called in getAnnotation, isSetAnnotation,
* and writeElements methods.
*/
virtual void syncAnnotation(SBase* parentObject, XMLNode *annotation);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Parse L2 annotation if supported
*
*/
virtual void parseAnnotation(SBase *parentObject, XMLNode *annotation);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Subclasses should override this method to read (and store) XHTML,
* MathML, etc. directly from the XMLInputStream.
*
* @return true if the subclass read from the stream, false otherwise.
*/
virtual bool readOtherXML (SBase* parentObject, XMLInputStream& stream);
/** @endcond */
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#ifndef SWIG
LIBSBML_CPP_NAMESPACE_BEGIN
BEGIN_C_DECLS
END_C_DECLS
LIBSBML_CPP_NAMESPACE_END
#endif /* !SWIG */
#endif /* RenderLayoutPlugin_h */
|