/usr/include/sbml/packages/layout/extension/LayoutModelPlugin.h is in libsbml5-dev 5.10.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 | /**
* @file LayoutModelPlugin.h
* @brief Definition of LayoutModelPlugin, the plugin class of
* layout package for Model element.
* @author Akiya Jouraku
*
* <!--------------------------------------------------------------------------
* 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-2014 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
*
* Copyright (C) 2006-2008 by the California Institute of Technology,
* Pasadena, CA, USA
*
* Copyright (C) 2002-2005 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. Japan Science and Technology Agency, Japan
*
* 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
* ------------------------------------------------------------------------ -->
*
* @class LayoutModelPlugin
* @sbmlbrief{layout} Implementation of the 'layout' package extention to the
* %Model construct.
*/
#ifndef LayoutModelPlugin_h
#define LayoutModelPlugin_h
#include <sbml/common/extern.h>
#include <sbml/common/sbmlfwd.h>
#include <sbml/packages/layout/common/layoutfwd.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/layout/sbml/Layout.h>
LIBSBML_CPP_NAMESPACE_BEGIN
class LIBSBML_EXTERN LayoutModelPlugin : public SBasePlugin
{
public:
/**
* Constructor
*/
LayoutModelPlugin (const std::string &uri, const std::string &prefix,
LayoutPkgNamespaces* layoutns);
/**
* Copy constructor. Creates a copy of this SBase object.
*/
LayoutModelPlugin(const LayoutModelPlugin& orig);
/**
* Destroy this object.
*/
virtual ~LayoutModelPlugin ();
/**
* Assignment operator for LayoutModelPlugin.
*/
LayoutModelPlugin& operator=(const LayoutModelPlugin& orig);
/**
* Creates and returns a deep copy of this LayoutModelPlugin object.
*
* @return a (deep) copy of this LayoutModelPlugin object
*/
virtual LayoutModelPlugin* clone () const;
#ifndef SWIG
// --------------------------------------------------------
//
// overridden virtual functions for reading/writing/checking
// elements
//
// --------------------------------------------------------
/** @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 */
/**
* Parses Layout Extension of SBML Level 2
*/
virtual bool readOtherXML (SBase* parentObject, 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 */
/**
* This function is a bit tricky.
* This function is used only for setting annotation element of layout
* extension for SBML Level2 because annotation element needs to be
* set before invoking the above writeElements function.
* Thus, no attribute is written by this function.
*/
virtual void writeAttributes (XMLOutputStream& stream) const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/* function returns true if component has all the required
* elements
* needs to be overloaded for each component
*/
virtual bool hasRequiredElements() const ;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Parse L2 annotation if supported
*
*/
virtual void parseAnnotation(SBase *parentObject, XMLNode *annotation);
/** @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 */
#endif
/** ------------------------------------------------------------------
*
* Additional public functions
*
* ------------------------------------------------------------------
*/
/**
* 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);
/**
* Returns the ListOfLayouts object for this Model.
*
* @return the ListOfLayouts object for this Model.
*/
const ListOfLayouts* getListOfLayouts () const;
/**
* Returns the ListOfLayouts object for this Model.
*
* @return the ListOfLayouts object for this Model.
*/
ListOfLayouts* getListOfLayouts ();
/**
* Returns the layout object that belongs to the given index. If the
* index is invalid, @c NULL is returned.
*
* @param index the index of list of layout objects.
*
* @return the Layout object that belongs to the given index. NULL
* is returned if the index is invalid.
*/
Layout* getLayout (unsigned int index);
/**
* Returns the layout object that belongs to the given index. If the
* index is invalid, @c NULL is returned.
*
* @param index the index of list of layout objects.
*
* @return the Layout object that belongs to the given index. NULL
* is returned if the index is invalid.
*/
const Layout* getLayout (unsigned int index) const;
/**
* Returns the layout object with the given @p sid attribute. If the
* id is invalid, @c NULL is returned.
*
* @param sid the id attribute of the layout object.
*
* @return the Layout object with the given @p sid attribute. NULL
* is returned if the given @p sid is invalid.
*/
Layout* getLayout (const std::string& sid);
/**
* Returns the layout object with the given @p sid attribute. If the
* id is invalid, @c NULL is returned.
*
* @param sid the id attribute of the layout object.
*
* @return the Layout object with the given @p sid attribute. NULL
* is returned if the given @p sid is invalid.
*/
const Layout* getLayout (const std::string& sid) const;
/**
* Adds a copy of the layout object to the list of layouts.
*
* @param layout the layout object to be added.
*
* @return integer value indicating success/failure of the
* function. @if clike The value is drawn from the
* enumeration #OperationReturnValues_t. @endif@~ The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
*/
int addLayout (const Layout* layout);
/**
* Creates a new layout object and adds it to the list of layout objects
* and returns it.
*
* @return a new layout object.
*/
Layout* createLayout();
/**
* Removes the nth Layout object from this Model object and
* returns a pointer to it.
*
* The caller owns the returned object and is responsible for deleting it.
*
* @param n the index of the Layout object to remove
*
* @return the Layout object removed. As mentioned above, the caller owns the
* returned object. @c NULL is returned if the given index is out of range.
*/
Layout* removeLayout (unsigned int n);
/**
* Returns the number of layout objects.
*
* @return the number of layout objects.
*/
int getNumLayouts() const;
// ---------------------------------------------------------
//
// virtual functions (internal implementation) which should
// be overridden by subclasses.
//
// ---------------------------------------------------------
/** @cond doxygenLibsbmlInternal */
int appendFrom(const Model* model);
/** @endcond */
/** @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
*
* @if cpp
* @see setSBMLDocument
* @see enablePackageInternal
* @endif
*/
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.
*
* @if cpp
* @see setSBMLDocument
* @see connectToParent
* @endif
*/
virtual void enablePackageInternal(const std::string& pkgURI,
const std::string& pkgPrefix, bool flag);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
virtual bool accept (SBMLVisitor& v) const;
/** @endcond */
protected:
/** @cond doxygenLibsbmlInternal */
/*-- data members --*/
ListOfLayouts mLayouts;
/** @endcond */
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#endif /* LayoutModelPlugin_h */
|