libSBML Perl API
5.20.4
|
Definition of SpatialExtension. More...
Classes | |
class | SpatialExtension |
Macros | |
#define | SPATIAL_CREATE_NS(variable, sbmlns) EXTENSION_CREATE_NS(SpatialPkgNamespaces, variable, sbmlns); |
Typedefs | |
typedef SBMLExtensionNamespaces< SpatialExtension > | SpatialPkgNamespaces |
Required typedef definitions. | |
Functions | |
BoundaryKind_t | BoundaryKind_fromString (const char *code) |
Returns the BoundaryKind_t enumeration corresponding to the given string or if there is no such match. | |
int | BoundaryKind_isValid (BoundaryKind_t bk) |
Predicate returning 1 (true) or 0 (false) depending on whether the given BoundaryKind_t is valid. | |
int | BoundaryKind_isValidString (const char *code) |
Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid BoundaryKind_t. | |
BoundaryKind_t | BoundaryKind_parse (const char *code) |
const char * | BoundaryKind_toString (BoundaryKind_t bk) |
Returns the string version of the provided BoundaryKind_t enumeration. | |
CompressionKind_t | CompressionKind_fromString (const char *code) |
Returns the CompressionKind_t enumeration corresponding to the given string or if there is no such match. | |
int | CompressionKind_isValid (CompressionKind_t ck) |
Predicate returning 1 (true) or 0 (false) depending on whether the given CompressionKind_t is valid. | |
int | CompressionKind_isValidString (const char *code) |
Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid CompressionKind_t. | |
CompressionKind_t | CompressionKind_parse (const char *code) |
const char * | CompressionKind_toString (CompressionKind_t ck) |
Returns the string version of the provided CompressionKind_t enumeration. | |
CoordinateKind_t | CoordinateKind_fromString (const char *code) |
Returns the CoordinateKind_t enumeration corresponding to the given string or if there is no such match. | |
int | CoordinateKind_isValid (CoordinateKind_t ck) |
Predicate returning 1 (true) or 0 (false) depending on whether the given CoordinateKind_t is valid. | |
int | CoordinateKind_isValidString (const char *code) |
Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid CoordinateKind_t. | |
CoordinateKind_t | CoordinateKind_parse (const char *code) |
const char * | CoordinateKind_toString (CoordinateKind_t ck) |
Returns the string version of the provided CoordinateKind_t enumeration. | |
DataKind_t | DataKind_fromString (const char *code) |
Returns the DataKind_t enumeration corresponding to the given string or if there is no such match. | |
int | DataKind_isValid (DataKind_t dk) |
Predicate returning 1 (true) or 0 (false) depending on whether the given DataKind_t is valid. | |
int | DataKind_isValidString (const char *code) |
Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid DataKind_t. | |
DataKind_t | DataKind_parse (const char *code) |
const char * | DataKind_toString (DataKind_t dk) |
Returns the string version of the provided DataKind_t enumeration. | |
DiffusionKind_t | DiffusionKind_fromString (const char *code) |
Returns the DiffusionKind_t enumeration corresponding to the given string or if there is no such match. | |
int | DiffusionKind_isValid (DiffusionKind_t dk) |
Predicate returning 1 (true) or 0 (false) depending on whether the given DiffusionKind_t is valid. | |
int | DiffusionKind_isValidString (const char *code) |
Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid DiffusionKind_t. | |
DiffusionKind_t | DiffusionKind_parse (const char *code) |
const char * | DiffusionKind_toString (DiffusionKind_t dk) |
Returns the string version of the provided DiffusionKind_t enumeration. | |
FunctionKind_t | FunctionKind_fromString (const char *code) |
Returns the FunctionKind_t enumeration corresponding to the given string or if there is no such match. | |
int | FunctionKind_isValid (FunctionKind_t fk) |
Predicate returning 1 (true) or 0 (false) depending on whether the given FunctionKind_t is valid. | |
int | FunctionKind_isValidString (const char *code) |
Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid FunctionKind_t. | |
FunctionKind_t | FunctionKind_parse (const char *code) |
const char * | FunctionKind_toString (FunctionKind_t fk) |
Returns the string version of the provided FunctionKind_t enumeration. | |
GeometryKind_t | GeometryKind_fromString (const char *code) |
Returns the GeometryKind_t enumeration corresponding to the given string or if there is no such match. | |
int | GeometryKind_isValid (GeometryKind_t gk) |
Predicate returning 1 (true) or 0 (false) depending on whether the given GeometryKind_t is valid. | |
int | GeometryKind_isValidString (const char *code) |
Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid GeometryKind_t. | |
GeometryKind_t | GeometryKind_parse (const char *code) |
const char * | GeometryKind_toString (GeometryKind_t gk) |
Returns the string version of the provided GeometryKind_t enumeration. | |
InterpolationKind_t | InterpolationKind_fromString (const char *code) |
Returns the InterpolationKind_t enumeration corresponding to the given string or if there is no such match. | |
int | InterpolationKind_isValid (InterpolationKind_t ik) |
Predicate returning 1 (true) or 0 (false) depending on whether the given InterpolationKind_t is valid. | |
int | InterpolationKind_isValidString (const char *code) |
Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid InterpolationKind_t. | |
InterpolationKind_t | InterpolationKind_parse (const char *code) |
const char * | InterpolationKind_toString (InterpolationKind_t ik) |
Returns the string version of the provided InterpolationKind_t enumeration. | |
PolygonKind_t | PolygonKind_fromString (const char *code) |
Returns the PolygonKind_t enumeration corresponding to the given string or if there is no such match. | |
int | PolygonKind_isValid (PolygonKind_t pk) |
Predicate returning 1 (true) or 0 (false) depending on whether the given PolygonKind_t is valid. | |
int | PolygonKind_isValidString (const char *code) |
Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid PolygonKind_t. | |
PolygonKind_t | PolygonKind_parse (const char *code) |
const char * | PolygonKind_toString (PolygonKind_t pk) |
Returns the string version of the provided PolygonKind_t enumeration. | |
PrimitiveKind_t | PrimitiveKind_fromString (const char *code) |
Returns the PrimitiveKind_t enumeration corresponding to the given string or if there is no such match. | |
int | PrimitiveKind_isValid (PrimitiveKind_t pk) |
Predicate returning 1 (true) or 0 (false) depending on whether the given PrimitiveKind_t is valid. | |
int | PrimitiveKind_isValidString (const char *code) |
Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid PrimitiveKind_t. | |
PrimitiveKind_t | PrimitiveKind_parse (const char *code) |
const char * | PrimitiveKind_toString (PrimitiveKind_t pk) |
Returns the string version of the provided PrimitiveKind_t enumeration. | |
SetOperation_t | SetOperation_fromString (const char *code) |
Returns the SetOperation_t enumeration corresponding to the given string or if there is no such match. | |
int | SetOperation_isValid (SetOperation_t so) |
Predicate returning 1 (true) or 0 (false) depending on whether the given SetOperation_t is valid. | |
int | SetOperation_isValidString (const char *code) |
Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid SetOperation_t. | |
SetOperation_t | SetOperation_parse (const char *code) |
const char * | SetOperation_toString (SetOperation_t so) |
Returns the string version of the provided SetOperation_t enumeration. | |
Definition of SpatialExtension.
#define SPATIAL_CREATE_NS | ( | variable, | |
sbmlns | |||
) | EXTENSION_CREATE_NS(SpatialPkgNamespaces, variable, sbmlns); |
Required typedef definitions.
SpatialPkgNamespace is derived from SBMLNamespaces class and used when creating an object of SBase derived classes defined in the spatial package
SBMLExtensionNamespaces<SpatialExtension> must be instantiated in SpatialExtension.cpp for DLL
enum BoundaryKind_t |
Enumeration of values permitted as the value of the "boundarykind" attribute on Spatial objects.
enum CompressionKind_t |
Enumeration of values permitted as the value of the "compressionkind" attribute on Spatial objects.
enum CoordinateKind_t |
Enumeration of values permitted as the value of the "coordinatekind" attribute on Spatial objects.
enum DataKind_t |
Enumeration of values permitted as the value of the "datakind" attribute on Spatial objects.
enum DiffusionKind_t |
Enumeration of values permitted as the value of the "diffusionkind" attribute on Spatial objects.
enum FunctionKind_t |
enum GeometryKind_t |
enum InterpolationKind_t |
Enumeration of values permitted as the value of the "interpolationkind" attribute on Spatial objects.
enum PolygonKind_t |
enum PrimitiveKind_t |
Enumeration of values permitted as the value of the "primitivekind" attribute on Spatial objects.
SBMLSpatialTypeCode_t Enumeration of possible types in the libSBML “spatial” package implementation.
SBML_
. Note that different Level 3 package plug-ins may use overlapping type codes; to identify the package to which a given object belongs, call the SBase::getPackageName()
method on the object.The exception to this is lists: all SBML-style list elements have the type , regardless of what package they are from.
SBMLLayoutTypeCode_t
for the SBML Level 3 Layout extension, SBMLFbcTypeCode_t
for the SBML Level 3 Flux Balance Constraints extension, etc.).NULL
if the value you give it is actually from a package.The following example code illustrates the combined use of SBase::getPackageName() and SBase::getTypeCode():
enum SetOperation_t |
Enumeration of values permitted as the value of the "setoperation" attribute on Spatial objects.
BoundaryKind_t BoundaryKind_fromString | ( | const char * | code | ) |
Returns the BoundaryKind_t enumeration corresponding to the given string or if there is no such match.
code | the string to convert to a BoundaryKind_t. |
int BoundaryKind_isValid | ( | BoundaryKind_t | bk | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given BoundaryKind_t is valid.
bk | the BoundaryKind_t enumeration to query. |
1
(true) if the BoundaryKind_t is , or ; 0
(false) otherwise (including ).int BoundaryKind_isValidString | ( | const char * | code | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given string is a valid BoundaryKind_t.
code | the string to query. |
1
(true) if the string is "Neumann", "Dirichlet", or "invalid BoundaryKind value"; 0
(false) otherwise.1
(true), but "neumann" will return 0
(false).BoundaryKind_t BoundaryKind_parse | ( | const char * | code | ) |
const char * BoundaryKind_toString | ( | BoundaryKind_t | bk | ) |
Returns the string version of the provided BoundaryKind_t enumeration.
bk | the BoundaryKind_t enumeration value to convert. |
NULL
if the value is or another invalid enumeration value.CompressionKind_t CompressionKind_fromString | ( | const char * | code | ) |
Returns the CompressionKind_t enumeration corresponding to the given string or if there is no such match.
code | the string to convert to a CompressionKind_t. |
int CompressionKind_isValid | ( | CompressionKind_t | ck | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given CompressionKind_t is valid.
ck | the CompressionKind_t enumeration to query. |
1
(true) if the CompressionKind_t is , or ; 0
(false) otherwise (including ).int CompressionKind_isValidString | ( | const char * | code | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given string is a valid CompressionKind_t.
code | the string to query. |
1
(true) if the string is "uncompressed", or "deflated"; 0
(false) otherwise.1
(true), but "Uncompressed" will return 0
(false).CompressionKind_t CompressionKind_parse | ( | const char * | code | ) |
const char * CompressionKind_toString | ( | CompressionKind_t | ck | ) |
Returns the string version of the provided CompressionKind_t enumeration.
ck | the CompressionKind_t enumeration value to convert. |
NULL
if the value is or another invalid enumeration value.CoordinateKind_t CoordinateKind_fromString | ( | const char * | code | ) |
Returns the CoordinateKind_t enumeration corresponding to the given string or if there is no such match.
code | the string to convert to a CoordinateKind_t. |
int CoordinateKind_isValid | ( | CoordinateKind_t | ck | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given CoordinateKind_t is valid.
ck | the CoordinateKind_t enumeration to query. |
1
(true) if the CoordinateKind_t is , , or ; 0
(false) otherwise (including ).int CoordinateKind_isValidString | ( | const char * | code | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given string is a valid CoordinateKind_t.
code | the string to query. |
1
(true) if the string is "cartesianX", "cartesianY", or "cartesianZ"; 0
(false) otherwise.1
(true), but "CartesianX" will return 0
(false).CoordinateKind_t CoordinateKind_parse | ( | const char * | code | ) |
const char * CoordinateKind_toString | ( | CoordinateKind_t | ck | ) |
Returns the string version of the provided CoordinateKind_t enumeration.
ck | the CoordinateKind_t enumeration value to convert. |
NULL
if the value is or another invalid enumeration value.DataKind_t DataKind_fromString | ( | const char * | code | ) |
Returns the DataKind_t enumeration corresponding to the given string or if there is no such match.
code | the string to convert to a DataKind_t. |
int DataKind_isValid | ( | DataKind_t | dk | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given DataKind_t is valid.
dk | the DataKind_t enumeration to query. |
1
(true) if the DataKind_t is , , , , or ; 0
(false) otherwise (including ).
int DataKind_isValidString | ( | const char * | code | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given string is a valid DataKind_t.
code | the string to query. |
1
(true) if the string is "uint", "int", "double", "float", "uint8", "uint16", or "uint32"; 0
(false) otherwise.1
(true), but "Double" will return 0
(false).DataKind_t DataKind_parse | ( | const char * | code | ) |
const char * DataKind_toString | ( | DataKind_t | dk | ) |
Returns the string version of the provided DataKind_t enumeration.
dk | the DataKind_t enumeration value to convert. |
NULL
if the value is or another invalid enumeration value.DiffusionKind_t DiffusionKind_fromString | ( | const char * | code | ) |
Returns the DiffusionKind_t enumeration corresponding to the given string or if there is no such match.
code | the string to convert to a DiffusionKind_t. |
int DiffusionKind_isValid | ( | DiffusionKind_t | dk | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given DiffusionKind_t is valid.
dk | the DiffusionKind_t enumeration to query. |
1
(true) if the DiffusionKind_t is , , or ; 0
(false) otherwise (including ).int DiffusionKind_isValidString | ( | const char * | code | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given string is a valid DiffusionKind_t.
code | the string to query. |
1
(true) if the string is "isotropic", "anisotropic", or "tensor"; 0
(false) otherwise.1
(true), but "Isotropic" will return 0
(false).DiffusionKind_t DiffusionKind_parse | ( | const char * | code | ) |
const char * DiffusionKind_toString | ( | DiffusionKind_t | dk | ) |
Returns the string version of the provided DiffusionKind_t enumeration.
dk | the DiffusionKind_t enumeration value to convert. |
NULL
if the value is or another invalid enumeration value.FunctionKind_t FunctionKind_fromString | ( | const char * | code | ) |
Returns the FunctionKind_t enumeration corresponding to the given string or if there is no such match.
code | the string to convert to a FunctionKind_t. |
int FunctionKind_isValid | ( | FunctionKind_t | fk | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given FunctionKind_t is valid.
fk | the FunctionKind_t enumeration to query. |
1
(true) if the FunctionKind_t is ; 0
(false) otherwise (including ).int FunctionKind_isValidString | ( | const char * | code | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given string is a valid FunctionKind_t.
code | the string to query. |
1
(true) if the string is "layered"; 0
(false) otherwise.1
(true), but "Layered" will return 0
(false).FunctionKind_t FunctionKind_parse | ( | const char * | code | ) |
const char * FunctionKind_toString | ( | FunctionKind_t | fk | ) |
Returns the string version of the provided FunctionKind_t enumeration.
fk | the FunctionKind_t enumeration value to convert. |
NULL
if the value is or another invalid enumeration value.GeometryKind_t GeometryKind_fromString | ( | const char * | code | ) |
Returns the GeometryKind_t enumeration corresponding to the given string or if there is no such match.
code | the string to convert to a GeometryKind_t. |
int GeometryKind_isValid | ( | GeometryKind_t | gk | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given GeometryKind_t is valid.
gk | the GeometryKind_t enumeration to query. |
1
(true) if the GeometryKind_t is ; 0
(false) otherwise (including ).int GeometryKind_isValidString | ( | const char * | code | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given string is a valid GeometryKind_t.
code | the string to query. |
1
(true) if the string is "cartesian"; 0
(false) otherwise.1
(true), but "Cartesian" will return 0
(false).GeometryKind_t GeometryKind_parse | ( | const char * | code | ) |
const char * GeometryKind_toString | ( | GeometryKind_t | gk | ) |
Returns the string version of the provided GeometryKind_t enumeration.
gk | the GeometryKind_t enumeration value to convert. |
NULL
if the value is or another invalid enumeration value.InterpolationKind_t InterpolationKind_fromString | ( | const char * | code | ) |
Returns the InterpolationKind_t enumeration corresponding to the given string or if there is no such match.
code | the string to convert to a InterpolationKind_t. |
int InterpolationKind_isValid | ( | InterpolationKind_t | ik | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given InterpolationKind_t is valid.
ik | the InterpolationKind_t enumeration to query. |
1
(true) if the InterpolationKind_t is , or ; 0
(false) otherwise (including ).int InterpolationKind_isValidString | ( | const char * | code | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given string is a valid InterpolationKind_t.
code | the string to query. |
1
(true) if the string is "nearestNeighbor", or "linear"; 0
(false) otherwise.1
(true), but "NearestNeighbor" will return 0
(false).InterpolationKind_t InterpolationKind_parse | ( | const char * | code | ) |
const char * InterpolationKind_toString | ( | InterpolationKind_t | ik | ) |
Returns the string version of the provided InterpolationKind_t enumeration.
ik | the InterpolationKind_t enumeration value to convert. |
NULL
if the value is or another invalid enumeration value.PolygonKind_t PolygonKind_fromString | ( | const char * | code | ) |
Returns the PolygonKind_t enumeration corresponding to the given string or if there is no such match.
code | the string to convert to a PolygonKind_t. |
int PolygonKind_isValid | ( | PolygonKind_t | pk | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given PolygonKind_t is valid.
pk | the PolygonKind_t enumeration to query. |
1
(true) if the PolygonKind_t is , or 0
(false) otherwise (including ).int PolygonKind_isValidString | ( | const char * | code | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given string is a valid PolygonKind_t.
code | the string to query. |
1
(true) if the string is "triangle", or 0
(false) otherwise.1
(true), but "Triangle" will return 0
(false).PolygonKind_t PolygonKind_parse | ( | const char * | code | ) |
const char * PolygonKind_toString | ( | PolygonKind_t | pk | ) |
Returns the string version of the provided PolygonKind_t enumeration.
pk | the PolygonKind_t enumeration value to convert. |
NULL
if the value is or another invalid enumeration value.PrimitiveKind_t PrimitiveKind_fromString | ( | const char * | code | ) |
Returns the PrimitiveKind_t enumeration corresponding to the given string or if there is no such match.
code | the string to convert to a PrimitiveKind_t. |
int PrimitiveKind_isValid | ( | PrimitiveKind_t | pk | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given PrimitiveKind_t is valid.
pk | the PrimitiveKind_t enumeration to query. |
1
(true) if the PrimitiveKind_t is , , , , , , or 0
(false) otherwise (including ).int PrimitiveKind_isValidString | ( | const char * | code | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given string is a valid PrimitiveKind_t.
code | the string to query. |
1
(true) if the string is "sphere", "cube", "cylinder", "cone", "circle", "square", or 0
(false) otherwise.1
(true), but "Sphere" will return 0
(false).PrimitiveKind_t PrimitiveKind_parse | ( | const char * | code | ) |
const char * PrimitiveKind_toString | ( | PrimitiveKind_t | pk | ) |
Returns the string version of the provided PrimitiveKind_t enumeration.
pk | the PrimitiveKind_t enumeration value to convert. |
NULL
if the value is or another invalid enumeration value.SetOperation_t SetOperation_fromString | ( | const char * | code | ) |
Returns the SetOperation_t enumeration corresponding to the given string or if there is no such match.
code | the string to convert to a SetOperation_t. |
int SetOperation_isValid | ( | SetOperation_t | so | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given SetOperation_t is valid.
so | the SetOperation_t enumeration to query. |
1
(true) if the SetOperation_t is , , or ; 0
(false) otherwise (including ).int SetOperation_isValidString | ( | const char * | code | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given string is a valid SetOperation_t.
code | the string to query. |
1
(true) if the string is "union", "intersection", "difference", or "invalid SetOperation value"; 0
(false) otherwise.1
(true), but "Union" will return 0
(false).SetOperation_t SetOperation_parse | ( | const char * | code | ) |
const char * SetOperation_toString | ( | SetOperation_t | so | ) |
Returns the string version of the provided SetOperation_t enumeration.
so | the SetOperation_t enumeration value to convert. |
NULL
if the value is or another invalid enumeration value.