/usr/include/sbml/packages/layout/extension/LayoutExtension.h is in libsbml5-dev 5.13.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 | /**
* @file LayoutExtension.h
* @brief Definition of LayoutExtension, the core module of layout package.
* @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-2016 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 LayoutExtension
* @sbmlbrief{layout} Base extension class for the package.
*
* @class LayoutPkgNamespaces
* @sbmlbrief{layout} SBMLNamespaces extension for the package.
*/
#ifndef LayoutExtension_h
#define LayoutExtension_h
#include <sbml/extension/SBMLExtension.h>
#include <sbml/extension/SBMLExtensionNamespaces.h>
#include <sbml/extension/SBMLExtensionRegister.h>
#ifndef LAYOUT_CREATE_NS
#define LAYOUT_CREATE_NS(variable,sbmlns)\
EXTENSION_CREATE_NS(LayoutPkgNamespaces,variable,sbmlns);
#endif
#ifdef __cplusplus
#include <vector>
LIBSBML_CPP_NAMESPACE_BEGIN
class LIBSBML_EXTERN LayoutExtension : public SBMLExtension
{
public:
//---------------------------------------------------------------
//
// Required class methods
//
//---------------------------------------------------------------
/**
* Returns the nickname of the SBML Level 3 package implemented by
* this libSBML extension.
*
* @return the package nickname, as a string.
*
* @copydetails doc_note_static_methods
*/
static const std::string& getPackageName ();
/**
* Returns the default SBML Level used by this libSBML package extension.
*
* @return the SBML Level.
*
* @copydetails doc_note_static_methods
*/
static unsigned int getDefaultLevel();
/**
* Returns the default SBML Version used by this libSBML package extension.
*
* @return the Version within the default SBML Level.
*
* @copydetails doc_note_static_methods
*/
static unsigned int getDefaultVersion();
/**
* Returns the default version of the SBML Level 3 package implemented
* by this libSBML extension.
*
* @return the default version number of the SBML Level 3 package
* definition.
*
* @copydetails doc_note_static_methods
*/
static unsigned int getDefaultPackageVersion();
/**
* Returns the XML namespace URI of the SBML Level 3 package
* implemented by this libSBML extension.
*
* @return the XML namespace as a string.
*
* @copydetails doc_note_static_methods
*/
static const std::string& getXmlnsL3V1V1();
/**
* Returns the XML namespace URI of the SBML Level 2 version
* of the package implemented by this libSBML Extension.
*
* Unique among the SBML Level 3 packages, the Layout package existed
* and was in widespread use prior to the introduction of SBML
* Level 3. The Layout package was used as model annotations in SBML
* Level 2. This method returns the SBML annotation XML namespace
* used for Level 2.
*
* @return the XML namespace as a string.
*
* @copydetails doc_note_static_methods
*/
static const std::string& getXmlnsL2();
/**
* Returns the XML namespace URI of any additional XML namespaces needed
* or used by this SBML Level 3 package.
*
* @return the XML namespace as a string.
*
* @copydetails doc_note_static_methods
*/
static const std::string& getXmlnsXSI();
//---------------------------------------------------------------
/**
* Creates a new LayoutExtension instance.
*/
LayoutExtension ();
/**
* Copy constructor.
*/
LayoutExtension(const LayoutExtension&);
/**
* Destroy this object.
*/
virtual ~LayoutExtension ();
/**
* Assignment operator for LayoutExtension.
*/
LayoutExtension& operator=(const LayoutExtension&);
/**
* Creates and returns a deep copy of this LayoutExtension object.
*
* @return a (deep) copy of this LayoutExtension object
*/
virtual LayoutExtension* clone () const;
/**
* Returns the name of this package ("layout")
*
* @return the name of this package ("layout")
*/
virtual const std::string& getName() const;
/**
* Returns the namespace URI corresponding to the combination of the given
* SBML Level, Version, and package version.
*
* @param sbmlLevel the level of SBML
* @param sbmlVersion the version of SBML
* @param pkgVersion the version of package
*
* @return a string of the package URI, or an empty string if no
* corresponding URI exists.
*/
virtual const std::string& getURI(unsigned int sbmlLevel, unsigned int sbmlVersion,
unsigned int pkgVersion) const;
/**
* Returns the SBML Level for the given URI of this package.
*
* @param uri a URI that represents a version of this package.
*
* @return the SBML Level for the given URI of this package, or @c 0 if the
* given URI is invalid.
*/
virtual unsigned int getLevel(const std::string &uri) const;
/**
* Returns the Version within the SBML Level for the given URI of this
* package.
*
* @param uri a URI that represents a version of this package.
*
* @return the SBML Version within the SBML Level for the given URI of this
* package, or @c 0 if the given URI is invalid.
*/
virtual unsigned int getVersion(const std::string &uri) const;
/**
* Returns the SBML Level 3 package version for the given URI of this
* package.
*
* @param uri a URI that represents one of the valid versions of this
* package.
*
* @return the version of the SBML Level 3 package with the given URI,
* or @c 0 if the given URI is invalid.
*/
virtual unsigned int getPackageVersion(const std::string &uri) const;
/**
* Takes a type code of the “layout” package and returns a string
* describing the code.
*
* @param typeCode a libSBML type code defined by the libSBML extension
* implementing support for the SBML Level 3 “layout” package.
*
* @return a text string representing the type code given by @p typeCode.
* If the type code is unrecognized for this implementation of the libSBML
* “layout” package, the string returned will be
* <code>"(Unknown SBML Layout Type)"</code>.
*/
virtual const char* getStringFromTypeCode(int typeCode) const;
/**
* Returns an LayoutPkgNamespaces object.
*
* @param uri a URI that represents one of the valid versions of the
* “layout” package
*
* @return an LayoutPkgNamespace object corresponding to the given @p uri,
* or @c NULL if the URI is not defined in the Layout package.
*/
virtual SBMLNamespaces* getSBMLExtensionNamespaces(const std::string &uri) const;
/** @cond doxygenLibsbmlInternal */
/**
* Initializes layout extension by creating an object of this class with
* required SBasePlugin derived objects and registering the object
* to the SBMLExtensionRegistry class.
*
* (NOTE) This function is automatically invoked when creating the following
* global object in LayoutExtension.cpp
*
* static SBMLExtensionRegister<LayoutExtension> layoutExtensionRegistry;
*
*/
static void init();
/** @endcond */
/**
* Removes the L2 Namespace from a document.
*
* This method should be overridden by all extensions that want to serialize
* to an L2 annotation.
*/
virtual void removeL2Namespaces(XMLNamespaces* xmlns) const;
/**
* adds all L2 Extension namespaces to the namespace list.
*
* This method should be overridden by all extensions that want to serialize
* to an L2 annotation.
*/
virtual void addL2Namespaces(XMLNamespaces *xmlns) const;
/**
* Adds the L2 Namespace to the document and enables the extension.
*
* If the extension supports serialization to SBML L2 Annotations, this
* method should be overrridden, so it will be activated.
*/
virtual void enableL2NamespaceForDocument(SBMLDocument* doc) const;
/**
* Determines whether this extension is being used by the given SBMLDocument
*
* The implementation returns true if the model object contains one
* or more layouts.
*
* @param doc the sbml document to test.
*
* @return a boolean indicating whether the extension is actually being used
* byy the document.
*/
virtual bool isInUse(SBMLDocument *doc) const;
/** @cond doxygenLibsbmlInternal */
/**
* Return the entry in the error table at this index.
*
* @param index an unsigned intgere representing the index of the error in the LayoutSBMLErrorTable
*
* @return packageErrorTableEntry object in the LayoutSBMLErrorTable corresponding to the index given.
*/
virtual packageErrorTableEntry getErrorTable(unsigned int index) const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Return the index in the error table with the given errorId.
*
* @param errorId an unsigned intgere representing the errorId of the error in the LayoutSBMLErrorTable
*
* @return unsigned integer representing the index in the LayoutSBMLErrorTable corresponding to the errorId given.
*/
virtual unsigned int getErrorTableIndex(unsigned int errorId) const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Return the offset for the errorId range for the layout L3 package.
*
* @return unsigned intege representing the offset for errors LayoutSBMLErrorTable.
*/
virtual unsigned int getErrorIdOffset() const;
/** @endcond */
};
// --------------------------------------------------------------------
//
// Required typedef definitions
//
// LayoutPkgNamespaces is derived from the SBMLNamespaces class and
// used when creating an object of SBase derived classes defined in
// layout package.
//
// --------------------------------------------------------------------
//
// (NOTE)
//
// SBMLExtensionNamespaces<LayoutExtension> must be instantiated
// in LayoutExtension.cpp for DLL.
//
typedef SBMLExtensionNamespaces<LayoutExtension> LayoutPkgNamespaces;
#endif /* __cplusplus */
/**
* @enum SBMLLayoutTypeCode_t
* @brief SBMLFbcTypeCode_t Enumeration of possible types in the libSBML
* “layout” package implementation.
*
* @copydetails doc_what_are_typecodes
*
* @copydetails doc_additional_typecode_details
*/
typedef enum
{
SBML_LAYOUT_BOUNDINGBOX = 100 /*!< BoundingBox */
, SBML_LAYOUT_COMPARTMENTGLYPH = 101 /*!< CompartmentGlyph */
, SBML_LAYOUT_CUBICBEZIER = 102 /*!< CubicBezier*/
, SBML_LAYOUT_CURVE = 103 /*!< Curve */
, SBML_LAYOUT_DIMENSIONS = 104 /*!< Dimensions */
, SBML_LAYOUT_GRAPHICALOBJECT = 105 /*!< GraphicalObject */
, SBML_LAYOUT_LAYOUT = 106 /*!< Layout */
, SBML_LAYOUT_LINESEGMENT = 107 /*!< LineSegment */
, SBML_LAYOUT_POINT = 108 /*!< Point */
, SBML_LAYOUT_REACTIONGLYPH = 109 /*!< ReactionGlyph */
, SBML_LAYOUT_SPECIESGLYPH = 110 /*!< SpeciesGlyph */
, SBML_LAYOUT_SPECIESREFERENCEGLYPH = 111 /*!< SpeciesReferenceGlyph */
, SBML_LAYOUT_TEXTGLYPH = 112 /*!< TextGlyph */
, SBML_LAYOUT_REFERENCEGLYPH = 113 /*!< ReferenceGlyph */
, SBML_LAYOUT_GENERALGLYPH = 114 /*!< GeneralGlyph */
} SBMLLayoutTypeCode_t;
LIBSBML_CPP_NAMESPACE_END
#endif /* LayoutExtension_h */
|