/usr/include/sbml/packages/render/extension/RenderExtension.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 | /**
* @file RenderExtension.h
* @brief Definition of RenderExtension, the core module of the render package.
* @author Frank T. Bergmann
*
* $Id$
* $HeadURL$
*
*<!---------------------------------------------------------------------------
* This file is part of libSBML. Please visit http://sbml.org for more
* information about SBML, and the latest version of libSBML.
*
* Copyright 2009-2013 California Institute of Technology.
*
* 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 RenderExtension_h
#define RenderExtension_h
#include <sbml/common/extern.h>
#ifdef __cplusplus
#include <sbml/extension/SBMLExtension.h>
#include <sbml/extension/SBMLExtensionNamespaces.h>
#include <sbml/extension/SBMLExtensionRegister.h>
#ifndef RENDER_CREATE_NS
#define RENDER_CREATE_NS(variable,sbmlns)\
EXTENSION_CREATE_NS(RenderPkgNamespaces,variable,sbmlns);
#endif
#include <vector>
LIBSBML_CPP_NAMESPACE_BEGIN
class LIBSBML_EXTERN RenderExtension : public SBMLExtension
{
public:
//---------------------------------------------------------------
//
// Required class methods
//
//---------------------------------------------------------------
/**
* Returns the package name of this extension.
*/
static const std::string& getPackageName ();
/**
* Returns the default SBML Level this extension.
*/
static unsigned int getDefaultLevel();
/**
* Returns the default SBML Version this extension.
*/
static unsigned int getDefaultVersion();
/**
* Returns the default SBML version this extension.
*/
static unsigned int getDefaultPackageVersion();
/**
* Returns URI of supported versions of this package.
*/
static const std::string& getXmlnsL3V1V1();
static const std::string& getXmlnsL2();
//
// Other URI needed in this package (if any)
//
//---------------------------------------------------------------
/**
* Constructor
*/
RenderExtension ();
/**
* Copy constructor.
*/
RenderExtension(const RenderExtension&);
/**
* Destroy this object.
*/
virtual ~RenderExtension ();
/**
* Assignment operator for GroupsExtension.
*/
RenderExtension& operator=(const RenderExtension&);
/**
* Creates and returns a deep copy of this RenderExtension object.
*
* @return a (deep) copy of this RenderExtension object
*/
virtual RenderExtension* clone () const;
/**
* Returns the name of this package ("fbc")
*
* @pram the name of this package ("fbc")
*/
virtual const std::string& getName() const;
/**
* Returns the URI (namespace) of the package corresponding to the combination of
* the given sbml level, sbml version, and package version.
* Empty string will be returned if no corresponding URI exists.
*
* @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
*/
virtual const std::string& getURI(unsigned int sbmlLevel, unsigned int sbmlVersion,
unsigned int pkgVersion) const;
/**
* Returns the SBML level with the given URI of this package.
*
* @param uri the string of URI that represents one of versions of layout package
*
* @return the SBML level with the given URI of this package. 0 will be returned
* if the given URI is invalid.
*
*/
virtual unsigned int getLevel(const std::string &uri) const;
/**
* Returns the SBML version with the given URI of this package.
*
* @param uri the string of URI that represents one of versions of layout package
*
* @return the SBML version with the given URI of this package. 0 will be returned
* if the given URI is invalid.
*/
virtual unsigned int getVersion(const std::string &uri) const;
/**
* Returns the package version with the given URI of this package.
*
* @param uri the string of URI that represents one of versions of layout package
*
* @return the package version with the given URI of this package. 0 will be returned
* if the given URI is invalid.
*/
virtual unsigned int getPackageVersion(const std::string &uri) const;
/**
* Returns an SBMLExtensionNamespaces<GroupsExtension> object whose alias type is
* LayoutPkgNamespace.
* Null will be returned if the given uri is not defined in the layout package.
*
* @param uri the string of URI that represents one of versions of layout package
*
* @return an LayoutPkgNamespace object corresponding to the given uri. NULL will
* be returned if the given URI is not defined in layout package.
*/
virtual SBMLNamespaces* getSBMLExtensionNamespaces(const std::string &uri) const;
/**
* This method takes a type code of groups package and returns a string representing
* the code.
*/
virtual const char* getStringFromTypeCode(int typeCode) 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 GroupsExtension.cpp
*
* static SBMLExtensionRegister<GroupsExtension> groupsExtensionRegistry;
*
*/
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 list of layouts contains a global render information,
* or a layout object contains a local render information object.
*
* @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;
};
//
// (NOTE)
//
// SBMLExtensionNamespaces<RenderExtension> must be instantiated
// in RenderExtension.cpp for DLL.
//
typedef SBMLExtensionNamespaces<RenderExtension> RenderPkgNamespaces;
typedef enum
{
SBML_RENDER_COLORDEFINITION = 1000
, SBML_RENDER_ELLIPSE = 1001
, SBML_RENDER_GLOBALRENDERINFORMATION = 1002
, SBML_RENDER_GLOBALSTYLE = 1003
, SBML_RENDER_GRADIENTDEFINITION = 1004
, SBML_RENDER_GRADIENT_STOP = 1005
, SBML_RENDER_GROUP = 1006
, SBML_RENDER_IMAGE = 1007
, SBML_RENDER_LINEENDING = 1008
, SBML_RENDER_LINEARGRADIENT = 1009
, SBML_RENDER_LINESEGMENT = 1010
, SBML_RENDER_LISTOFGLOBALSTYLES = 1011
, SBML_RENDER_LISTOFLOCALSTYLES = 1012
, SBML_RENDER_LOCALRENDERINFORMATION = 1013
, SBML_RENDER_LOCALSTYLE = 1014
, SBML_RENDER_POLYGON = 1015
, SBML_RENDER_RADIALGRADIENT = 1016
, SBML_RENDER_RECTANGLE = 1017
, SBML_RENDER_RELABSVECTOR = 1018
, SBML_RENDER_CUBICBEZIER = 1019
, SBML_RENDER_CURVE = 1020
, SBML_RENDER_POINT = 1021
, SBML_RENDER_TEXT = 1022
, SBML_RENDER_TRANSFORMATION2D = 1023
} SBMLRenderTypeCode_t;
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#endif /* RenderExtension_h */
|