SpatialExtension.h File Reference

Definition of SpatialExtension. More...

Include dependency graph for SpatialExtension.h:

This graph shows which files directly or indirectly include this file:

Classes
class	SpatialExtension

Macros
#define	SPATIAL_CREATE_NS(variable, sbmlns)   EXTENSION_CREATE_NS(SpatialPkgNamespaces, variable, sbmlns);

Typedefs
typedef SBMLExtensionNamespaces< SpatialExtension >	SpatialPkgNamespaces
	Required typedef definitions. More...

Enumerations
enum	BoundaryKind_t {   SPATIAL_BOUNDARYKIND_NEUMANN ,   SPATIAL_BOUNDARYKIND_DIRICHLET ,   SPATIAL_BOUNDARYKIND_INVALID }
	Enumeration of values permitted as the value of the "boundarykind" attribute on Spatial objects. More...
enum	CompressionKind_t {   SPATIAL_COMPRESSIONKIND_UNCOMPRESSED ,   SPATIAL_COMPRESSIONKIND_DEFLATED ,   SPATIAL_COMPRESSIONKIND_INVALID }
	Enumeration of values permitted as the value of the "compressionkind" attribute on Spatial objects. More...
enum	CoordinateKind_t {   SPATIAL_COORDINATEKIND_CARTESIAN_X ,   SPATIAL_COORDINATEKIND_CARTESIAN_Y ,   SPATIAL_COORDINATEKIND_CARTESIAN_Z ,   SPATIAL_COORDINATEKIND_INVALID }
	Enumeration of values permitted as the value of the "coordinatekind" attribute on Spatial objects. More...
enum	DataKind_t {   SPATIAL_DATAKIND_DOUBLE ,   SPATIAL_DATAKIND_FLOAT ,   SPATIAL_DATAKIND_UINT8 ,   SPATIAL_DATAKIND_UINT16 ,   SPATIAL_DATAKIND_UINT32 ,   SPATIAL_DATAKIND_UINT ,   SPATIAL_DATAKIND_INT ,   SPATIAL_DATAKIND_INVALID }
	Enumeration of values permitted as the value of the "datakind" attribute on Spatial objects. More...
enum	DiffusionKind_t {   SPATIAL_DIFFUSIONKIND_ISOTROPIC ,   SPATIAL_DIFFUSIONKIND_ANISOTROPIC ,   SPATIAL_DIFFUSIONKIND_TENSOR ,   SPATIAL_DIFFUSIONKIND_INVALID }
	Enumeration of values permitted as the value of the "diffusionkind" attribute on Spatial objects. More...
enum	FunctionKind_t {   SPATIAL_FUNCTIONKIND_LAYERED ,   SPATIAL_FUNCTIONKIND_INVALID }
	Enumeration of values permitted as the value of the "functionkind" attribute on Spatial objects. More...
enum	GeometryKind_t {   SPATIAL_GEOMETRYKIND_CARTESIAN ,   SPATIAL_GEOMETRYKIND_INVALID }
	Enumeration of values permitted as the value of the "geometrykind" attribute on Spatial objects. More...
enum	InterpolationKind_t {   SPATIAL_INTERPOLATIONKIND_NEARESTNEIGHBOR ,   SPATIAL_INTERPOLATIONKIND_LINEAR ,   SPATIAL_INTERPOLATIONKIND_INVALID }
	Enumeration of values permitted as the value of the "interpolationkind" attribute on Spatial objects. More...
enum	PolygonKind_t {   SPATIAL_POLYGONKIND_TRIANGLE ,   SPATIAL_POLYGONKIND_INVALID }
	Enumeration of values permitted as the value of the "polygonkind" attribute on Spatial objects. More...
enum	PrimitiveKind_t {   SPATIAL_PRIMITIVEKIND_SPHERE ,   SPATIAL_PRIMITIVEKIND_CUBE ,   SPATIAL_PRIMITIVEKIND_CYLINDER ,   SPATIAL_PRIMITIVEKIND_CONE ,   SPATIAL_PRIMITIVEKIND_CIRCLE ,   SPATIAL_PRIMITIVEKIND_SQUARE ,   SPATIAL_PRIMITIVEKIND_INVALID }
	Enumeration of values permitted as the value of the "primitivekind" attribute on Spatial objects. More...
enum	SBMLSpatialTypeCode_t {   SBML_SPATIAL_DOMAINTYPE = 300 ,   SBML_SPATIAL_DOMAIN = 301 ,   SBML_SPATIAL_INTERIORPOINT = 302 ,   SBML_SPATIAL_BOUNDARY = 303 ,   SBML_SPATIAL_ADJACENTDOMAINS = 304 ,   SBML_SPATIAL_GEOMETRYDEFINITION = 305 ,   SBML_SPATIAL_COMPARTMENTMAPPING = 306 ,   SBML_SPATIAL_COORDINATECOMPONENT = 307 ,   SBML_SPATIAL_SAMPLEDFIELDGEOMETRY = 308 ,   SBML_SPATIAL_SAMPLEDFIELD = 309 ,   SBML_SPATIAL_SAMPLEDVOLUME = 310 ,   SBML_SPATIAL_ANALYTICGEOMETRY = 311 ,   SBML_SPATIAL_ANALYTICVOLUME = 312 ,   SBML_SPATIAL_PARAMETRICGEOMETRY = 313 ,   SBML_SPATIAL_PARAMETRICOBJECT = 314 ,   SBML_SPATIAL_CSGEOMETRY = 315 ,   SBML_SPATIAL_CSGOBJECT = 316 ,   SBML_SPATIAL_CSGNODE = 317 ,   SBML_SPATIAL_CSGTRANSFORMATION = 318 ,   SBML_SPATIAL_CSGTRANSLATION = 319 ,   SBML_SPATIAL_CSGROTATION = 320 ,   SBML_SPATIAL_CSGSCALE = 321 ,   SBML_SPATIAL_CSGHOMOGENEOUSTRANSFORMATION = 322 ,   SBML_SPATIAL_TRANSFORMATIONCOMPONENT = 323 ,   SBML_SPATIAL_CSGPRIMITIVE = 324 ,   SBML_SPATIAL_CSGSETOPERATOR = 325 ,   SBML_SPATIAL_SPATIALSYMBOLREFERENCE = 326 ,   SBML_SPATIAL_DIFFUSIONCOEFFICIENT = 327 ,   SBML_SPATIAL_ADVECTIONCOEFFICIENT = 328 ,   SBML_SPATIAL_BOUNDARYCONDITION = 329 ,   SBML_SPATIAL_GEOMETRY = 330 ,   SBML_SPATIAL_MIXEDGEOMETRY = 331 ,   SBML_SPATIAL_ORDINALMAPPING = 332 ,   SBML_SPATIAL_SPATIALPOINTS = 333 }
	SBMLSpatialTypeCode_t Enumeration of possible types in the libSBML “spatial” package implementation. More...
enum	SetOperation_t {   SPATIAL_SETOPERATION_UNION ,   SPATIAL_SETOPERATION_INTERSECTION ,   SPATIAL_SETOPERATION_DIFFERENCE ,   SPATIAL_SETOPERATION_INVALID }
	Enumeration of values permitted as the value of the "setoperation" attribute on Spatial objects. More...

Functions
BoundaryKind_t	BoundaryKind_fromString (const char *code)
	Returns the BoundaryKind_t enumeration corresponding to the given string or SPATIAL_BOUNDARYKIND_INVALID if there is no such match. More...
int	BoundaryKind_isValid (BoundaryKind_t bk)
	Predicate returning 1 (true) or 0 (false) depending on whether the given BoundaryKind_t is valid. More...
int	BoundaryKind_isValidString (const char *code)
	Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid BoundaryKind_t. More...
BoundaryKind_t	BoundaryKind_parse (const char *code)
const char *	BoundaryKind_toString (BoundaryKind_t bk)
	Returns the string version of the provided BoundaryKind_t enumeration. More...
CompressionKind_t	CompressionKind_fromString (const char *code)
	Returns the CompressionKind_t enumeration corresponding to the given string or SPATIAL_COMPRESSIONKIND_INVALID if there is no such match. More...
int	CompressionKind_isValid (CompressionKind_t ck)
	Predicate returning 1 (true) or 0 (false) depending on whether the given CompressionKind_t is valid. More...
int	CompressionKind_isValidString (const char *code)
	Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid CompressionKind_t. More...
CompressionKind_t	CompressionKind_parse (const char *code)
const char *	CompressionKind_toString (CompressionKind_t ck)
	Returns the string version of the provided CompressionKind_t enumeration. More...
CoordinateKind_t	CoordinateKind_fromString (const char *code)
	Returns the CoordinateKind_t enumeration corresponding to the given string or SPATIAL_COORDINATEKIND_INVALID if there is no such match. More...
int	CoordinateKind_isValid (CoordinateKind_t ck)
	Predicate returning 1 (true) or 0 (false) depending on whether the given CoordinateKind_t is valid. More...
int	CoordinateKind_isValidString (const char *code)
	Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid CoordinateKind_t. More...
CoordinateKind_t	CoordinateKind_parse (const char *code)
const char *	CoordinateKind_toString (CoordinateKind_t ck)
	Returns the string version of the provided CoordinateKind_t enumeration. More...
DataKind_t	DataKind_fromString (const char *code)
	Returns the DataKind_t enumeration corresponding to the given string or SPATIAL_DATAKIND_INVALID if there is no such match. More...
int	DataKind_isValid (DataKind_t dk)
	Predicate returning 1 (true) or 0 (false) depending on whether the given DataKind_t is valid. More...
int	DataKind_isValidString (const char *code)
	Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid DataKind_t. More...
DataKind_t	DataKind_parse (const char *code)
const char *	DataKind_toString (DataKind_t dk)
	Returns the string version of the provided DataKind_t enumeration. More...
DiffusionKind_t	DiffusionKind_fromString (const char *code)
	Returns the DiffusionKind_t enumeration corresponding to the given string or SPATIAL_DIFFUSIONKIND_INVALID if there is no such match. More...
int	DiffusionKind_isValid (DiffusionKind_t dk)
	Predicate returning 1 (true) or 0 (false) depending on whether the given DiffusionKind_t is valid. More...
int	DiffusionKind_isValidString (const char *code)
	Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid DiffusionKind_t. More...
DiffusionKind_t	DiffusionKind_parse (const char *code)
const char *	DiffusionKind_toString (DiffusionKind_t dk)
	Returns the string version of the provided DiffusionKind_t enumeration. More...
FunctionKind_t	FunctionKind_fromString (const char *code)
	Returns the FunctionKind_t enumeration corresponding to the given string or SPATIAL_FUNCTIONKIND_INVALID if there is no such match. More...
int	FunctionKind_isValid (FunctionKind_t fk)
	Predicate returning 1 (true) or 0 (false) depending on whether the given FunctionKind_t is valid. More...
int	FunctionKind_isValidString (const char *code)
	Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid FunctionKind_t. More...
FunctionKind_t	FunctionKind_parse (const char *code)
const char *	FunctionKind_toString (FunctionKind_t fk)
	Returns the string version of the provided FunctionKind_t enumeration. More...
GeometryKind_t	GeometryKind_fromString (const char *code)
	Returns the GeometryKind_t enumeration corresponding to the given string or SPATIAL_GEOMETRYKIND_INVALID if there is no such match. More...
int	GeometryKind_isValid (GeometryKind_t gk)
	Predicate returning 1 (true) or 0 (false) depending on whether the given GeometryKind_t is valid. More...
int	GeometryKind_isValidString (const char *code)
	Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid GeometryKind_t. More...
GeometryKind_t	GeometryKind_parse (const char *code)
const char *	GeometryKind_toString (GeometryKind_t gk)
	Returns the string version of the provided GeometryKind_t enumeration. More...
InterpolationKind_t	InterpolationKind_fromString (const char *code)
	Returns the InterpolationKind_t enumeration corresponding to the given string or SPATIAL_INTERPOLATIONKIND_INVALID if there is no such match. More...
int	InterpolationKind_isValid (InterpolationKind_t ik)
	Predicate returning 1 (true) or 0 (false) depending on whether the given InterpolationKind_t is valid. More...
int	InterpolationKind_isValidString (const char *code)
	Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid InterpolationKind_t. More...
InterpolationKind_t	InterpolationKind_parse (const char *code)
const char *	InterpolationKind_toString (InterpolationKind_t ik)
	Returns the string version of the provided InterpolationKind_t enumeration. More...
PolygonKind_t	PolygonKind_fromString (const char *code)
	Returns the PolygonKind_t enumeration corresponding to the given string or SPATIAL_POLYGONKIND_INVALID if there is no such match. More...
int	PolygonKind_isValid (PolygonKind_t pk)
	Predicate returning 1 (true) or 0 (false) depending on whether the given PolygonKind_t is valid. More...
int	PolygonKind_isValidString (const char *code)
	Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid PolygonKind_t. More...
PolygonKind_t	PolygonKind_parse (const char *code)
const char *	PolygonKind_toString (PolygonKind_t pk)
	Returns the string version of the provided PolygonKind_t enumeration. More...
PrimitiveKind_t	PrimitiveKind_fromString (const char *code)
	Returns the PrimitiveKind_t enumeration corresponding to the given string or SPATIAL_PRIMITIVEKIND_INVALID if there is no such match. More...
int	PrimitiveKind_isValid (PrimitiveKind_t pk)
	Predicate returning 1 (true) or 0 (false) depending on whether the given PrimitiveKind_t is valid. More...
int	PrimitiveKind_isValidString (const char *code)
	Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid PrimitiveKind_t. More...
PrimitiveKind_t	PrimitiveKind_parse (const char *code)
const char *	PrimitiveKind_toString (PrimitiveKind_t pk)
	Returns the string version of the provided PrimitiveKind_t enumeration. More...
SetOperation_t	SetOperation_fromString (const char *code)
	Returns the SetOperation_t enumeration corresponding to the given string or SPATIAL_SETOPERATION_INVALID if there is no such match. More...
int	SetOperation_isValid (SetOperation_t so)
	Predicate returning 1 (true) or 0 (false) depending on whether the given SetOperation_t is valid. More...
int	SetOperation_isValidString (const char *code)
	Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid SetOperation_t. More...
SetOperation_t	SetOperation_parse (const char *code)
const char *	SetOperation_toString (SetOperation_t so)
	Returns the string version of the provided SetOperation_t enumeration. More...

Detailed Description

Definition of SpatialExtension.

Author

SBMLTeam

Macro Definition Documentation

SPATIAL_CREATE_NS

#define SPATIAL_CREATE_NS	(		variable,
			sbmlns
	)		EXTENSION_CREATE_NS(SpatialPkgNamespaces, variable, sbmlns);

Typedef Documentation

SpatialPkgNamespaces

typedef SBMLExtensionNamespaces<SpatialExtension> SpatialPkgNamespaces

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

Enumeration Type Documentation

BoundaryKind_t

enum BoundaryKind_t

Enumeration of values permitted as the value of the "boundarykind" attribute on Spatial objects.

See also

Spatial::getBoundarykind()

Spatial::setBoundarykind()

Enumerator
SPATIAL_BOUNDARYKIND_NEUMANN	The spatial boundarykind is "Neumann".
SPATIAL_BOUNDARYKIND_DIRICHLET	The spatial boundarykind is "Dirichlet".
SPATIAL_BOUNDARYKIND_INVALID	Invalid BoundaryKind value.

CompressionKind_t

enum CompressionKind_t

Enumeration of values permitted as the value of the "compressionkind" attribute on Spatial objects.

See also

Spatial::getCompressionkind()

Spatial::setCompressionkind()

Enumerator
SPATIAL_COMPRESSIONKIND_UNCOMPRESSED	The spatial compressionkind is "uncompressed".
SPATIAL_COMPRESSIONKIND_DEFLATED	The spatial compressionkind is "deflated".
SPATIAL_COMPRESSIONKIND_INVALID	Invalid CompressionKind value.

CoordinateKind_t

enum CoordinateKind_t

Enumeration of values permitted as the value of the "coordinatekind" attribute on Spatial objects.

See also

Spatial::getCoordinatekind()

Spatial::setCoordinatekind()

Enumerator
SPATIAL_COORDINATEKIND_CARTESIAN_X	The spatial coordinatekind is "cartesianX".
SPATIAL_COORDINATEKIND_CARTESIAN_Y	The spatial coordinatekind is "cartesianY".
SPATIAL_COORDINATEKIND_CARTESIAN_Z	The spatial coordinatekind is "cartesianZ".
SPATIAL_COORDINATEKIND_INVALID	Invalid CoordinateKind value.

DataKind_t

enum DataKind_t

Enumeration of values permitted as the value of the "datakind" attribute on Spatial objects.

See also

Spatial::getDatakind()

Spatial::setDatakind()

Enumerator
SPATIAL_DATAKIND_DOUBLE	The spatial datakind is "double".
SPATIAL_DATAKIND_FLOAT	The spatial datakind is "float".
SPATIAL_DATAKIND_UINT8	The spatial datakind is "uint8".
SPATIAL_DATAKIND_UINT16	The spatial datakind is "uint16".
SPATIAL_DATAKIND_UINT32	The spatial datakind is "uint32".
SPATIAL_DATAKIND_UINT	The spatial datakind is "uint".
SPATIAL_DATAKIND_INT	The spatial datakind is "int".
SPATIAL_DATAKIND_INVALID	Invalid DataKind value.

DiffusionKind_t

enum DiffusionKind_t

Enumeration of values permitted as the value of the "diffusionkind" attribute on Spatial objects.

See also

Spatial::getDiffusionkind()

Spatial::setDiffusionkind()

Enumerator
SPATIAL_DIFFUSIONKIND_ISOTROPIC	The spatial diffusionkind is "isotropic".
SPATIAL_DIFFUSIONKIND_ANISOTROPIC	The spatial diffusionkind is "anisotropic".
SPATIAL_DIFFUSIONKIND_TENSOR	The spatial diffusionkind is "tensor".
SPATIAL_DIFFUSIONKIND_INVALID	Invalid DiffusionKind value.

FunctionKind_t

enum FunctionKind_t

Enumeration of values permitted as the value of the "functionkind" attribute on Spatial objects.

See also

Spatial::getFunctionkind()

Spatial::setFunctionkind()

Enumerator
SPATIAL_FUNCTIONKIND_LAYERED	The spatial functionkind is "layered".
SPATIAL_FUNCTIONKIND_INVALID	Invalid FunctionKind value.

GeometryKind_t

enum GeometryKind_t

Enumeration of values permitted as the value of the "geometrykind" attribute on Spatial objects.

See also

Spatial::getGeometrykind()

Spatial::setGeometrykind()

Enumerator
SPATIAL_GEOMETRYKIND_CARTESIAN	The spatial geometrykind is "cartesian".
SPATIAL_GEOMETRYKIND_INVALID	Invalid GeometryKind value.

InterpolationKind_t

enum InterpolationKind_t

Enumeration of values permitted as the value of the "interpolationkind" attribute on Spatial objects.

See also

Spatial::getInterpolationkind()

Spatial::setInterpolationkind()

Enumerator
SPATIAL_INTERPOLATIONKIND_NEARESTNEIGHBOR	The spatial interpolationkind is "nearestNeighbor".
SPATIAL_INTERPOLATIONKIND_LINEAR	The spatial interpolationkind is "linear".
SPATIAL_INTERPOLATIONKIND_INVALID	Invalid InterpolationKind value.

PolygonKind_t

enum PolygonKind_t

Enumeration of values permitted as the value of the "polygonkind" attribute on Spatial objects.

See also

Spatial::getPolygonkind()

Spatial::setPolygonkind()

Enumerator
SPATIAL_POLYGONKIND_TRIANGLE	The spatial polygonkind is "triangle".
SPATIAL_POLYGONKIND_INVALID	Invalid PolygonKind value.

PrimitiveKind_t

enum PrimitiveKind_t

Enumeration of values permitted as the value of the "primitivekind" attribute on Spatial objects.

See also

Spatial::getPrimitivekind()

Spatial::setPrimitivekind()

Enumerator
SPATIAL_PRIMITIVEKIND_SPHERE	The spatial primitivekind is "sphere".
SPATIAL_PRIMITIVEKIND_CUBE	The spatial primitivekind is "cube".
SPATIAL_PRIMITIVEKIND_CYLINDER	The spatial primitivekind is "cylinder".
SPATIAL_PRIMITIVEKIND_CONE	The spatial primitivekind is "cone".
SPATIAL_PRIMITIVEKIND_CIRCLE	The spatial primitivekind is "circle".
SPATIAL_PRIMITIVEKIND_SQUARE	The spatial primitivekind is "square".
SPATIAL_PRIMITIVEKIND_INVALID	Invalid PrimitiveKind value.

SBMLSpatialTypeCode_t

enum SBMLSpatialTypeCode_t

SBMLSpatialTypeCode_t Enumeration of possible types in the libSBML “spatial” package implementation.

LibSBML attaches an identifying code to every kind of SBML object. These are integer constants known as SBML type codes. The names of all the codes begin with the characters SBML_. The set of possible type codes for core elements is defined in the enumeration SBMLTypeCode_t, and in addition, libSBML plug-ins for SBML Level 3 packages define their own extra enumerations of type codes (e.g., SBMLLayoutTypeCode_t for the Level 3 Layout package). 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 SBML_LIST_OF, regardless of what package they are from.

Here follow some additional general information about libSBML type codes:

• The codes are the possible return values (integers) for the following functions:
  • SBase::getTypeCode()
  • ListOf::getItemTypeCode()
  (Compatibility note: in libSBML 5, the type of return values of these functions changed from an enumeration to an integer for extensibility in the face of different programming languages.)

• Each package extension must define similar sets of values for each SBase subclass (e.g. SBMLLayoutTypeCode_t for the SBML Level 3 Layout extension, SBMLFbcTypeCode_t for the SBML Level 3 Flux Balance Constraints extension, etc.).

• The value of each package-specific type code can be duplicated between those of different packages. (This is necessary because the development of libSBML extensions for different SBML packages may be undertaken by different developers at different times; requiring the developers to coordinate their use of type codes would be nettlesome and probably doomed to failure.)

• To distinguish between the type codes of different packages, both the return value of SBase::getTypeCode() and SBase::getPackageName() must be checked. This is particularly important for functions that take an SBML type code as an argument, such as SBase::getAncestorOfType(), which by default assumes you are handing it a core type, and will return 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():

void example (const SBase *sb)
{
  cons std::string pkgName = sb->getPackageName();
  if (pkgName == "core")
  {
    switch (sb->getTypeCode())
    {
      case SBML_MODEL:
         ....
         break;
      case SBML_REACTION:
         ....
    }
  }
  else if (pkgName == "layout")
  {
    switch (sb->getTypeCode())
    {
      case SBML_LAYOUT_LAYOUT:
         ....
         break;
      case SBML_LAYOUT_REACTIONGLYPH:
         ....
    }
  }
  ...
}

Enumerator
SBML_SPATIAL_DOMAINTYPE	DomainType
SBML_SPATIAL_DOMAIN	Domain
SBML_SPATIAL_INTERIORPOINT	InteriorPoint
SBML_SPATIAL_BOUNDARY	Boundary
SBML_SPATIAL_ADJACENTDOMAINS	AdjacentDomains
SBML_SPATIAL_GEOMETRYDEFINITION	GeometryDefinition
SBML_SPATIAL_COMPARTMENTMAPPING	CompartmentMapping
SBML_SPATIAL_COORDINATECOMPONENT	CoordinateComponent
SBML_SPATIAL_SAMPLEDFIELDGEOMETRY	SampledFieldGeometry
SBML_SPATIAL_SAMPLEDFIELD	SampledField
SBML_SPATIAL_SAMPLEDVOLUME	SampledVolume
SBML_SPATIAL_ANALYTICGEOMETRY	AnalyticGeometry
SBML_SPATIAL_ANALYTICVOLUME	AnalyticVolume
SBML_SPATIAL_PARAMETRICGEOMETRY	ParametricGeometry
SBML_SPATIAL_PARAMETRICOBJECT	ParametricObject
SBML_SPATIAL_CSGEOMETRY	CSGeometry
SBML_SPATIAL_CSGOBJECT	CSGObject
SBML_SPATIAL_CSGNODE	CSGNode
SBML_SPATIAL_CSGTRANSFORMATION	CSGTransformation
SBML_SPATIAL_CSGTRANSLATION	CSGTranslation
SBML_SPATIAL_CSGROTATION	CSGRotation
SBML_SPATIAL_CSGSCALE	CSGScale
SBML_SPATIAL_CSGHOMOGENEOUSTRANSFORMATION	CSGHomogeneousTransformation
SBML_SPATIAL_TRANSFORMATIONCOMPONENT	TransformationComponent
SBML_SPATIAL_CSGPRIMITIVE	CSGPrimitive
SBML_SPATIAL_CSGSETOPERATOR	CSGSetOperator
SBML_SPATIAL_SPATIALSYMBOLREFERENCE	SpatialSymbolReference
SBML_SPATIAL_DIFFUSIONCOEFFICIENT	DiffusionCoefficient
SBML_SPATIAL_ADVECTIONCOEFFICIENT	AdvectionCoefficient
SBML_SPATIAL_BOUNDARYCONDITION	BoundaryCondition
SBML_SPATIAL_GEOMETRY	Geometry
SBML_SPATIAL_MIXEDGEOMETRY	MixedGeometry
SBML_SPATIAL_ORDINALMAPPING	OrdinalMapping
SBML_SPATIAL_SPATIALPOINTS	SpatialPoints

SetOperation_t

enum SetOperation_t

Enumeration of values permitted as the value of the "setoperation" attribute on Spatial objects.

See also

Spatial::getSetoperation()

Spatial::setSetoperation()

Enumerator
SPATIAL_SETOPERATION_UNION	The spatial setoperation is "union".
SPATIAL_SETOPERATION_INTERSECTION	The spatial setoperation is "intersection".
SPATIAL_SETOPERATION_DIFFERENCE	The spatial setoperation is "difference".
SPATIAL_SETOPERATION_INVALID	Invalid SetOperation value.

Function Documentation

BoundaryKind_fromString()

BoundaryKind_t BoundaryKind_fromString

(

const char *

code

)

Returns the BoundaryKind_t enumeration corresponding to the given string or SPATIAL_BOUNDARYKIND_INVALID if there is no such match.

Parameters

code	the string to convert to a BoundaryKind_t.

Returns

the corresponding BoundaryKind_t or SPATIAL_BOUNDARYKIND_INVALID if no match is found.

Note

The matching is case-sensitive: "Neumann" will return SPATIAL_BOUNDARYKIND_NEUMANN, but "neumann" will return SPATIAL_BOUNDARYKIND_INVALID.

BoundaryKind_isValid()

int BoundaryKind_isValid

(

BoundaryKind_t

bk

)

Predicate returning 1 (true) or 0 (false) depending on whether the given BoundaryKind_t is valid.

Parameters

bk	the BoundaryKind_t enumeration to query.

Returns

1 (true) if the BoundaryKind_t is SPATIAL_BOUNDARYKIND_NEUMANN, or SPATIAL_BOUNDARYKIND_DIRICHLET; 0 (false) otherwise (including SPATIAL_BOUNDARYKIND_INVALID).

BoundaryKind_isValidString()

int BoundaryKind_isValidString

(

const char *

code

)

Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid BoundaryKind_t.

Parameters

code	the string to query.

Returns

1 (true) if the string is "Neumann", "Dirichlet", or "invalid BoundaryKind value"; 0 (false) otherwise.

Note

The matching is case-sensitive: "Neumann" will return 1 (true), but "neumann" will return 0 (false).

BoundaryKind_parse()

BoundaryKind_t BoundaryKind_parse

(

const char *

code

)

BoundaryKind_toString()

const char* BoundaryKind_toString

(

BoundaryKind_t

bk

)

Returns the string version of the provided BoundaryKind_t enumeration.

Parameters

bk	the BoundaryKind_t enumeration value to convert.

Returns

A string corresponding to the given type: "Neumann", "Dirichlet", or NULL if the value is SPATIAL_BOUNDARYKIND_INVALID or another invalid enumeration value.

Note

The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

CompressionKind_fromString()

CompressionKind_t CompressionKind_fromString

(

const char *

code

)

Returns the CompressionKind_t enumeration corresponding to the given string or SPATIAL_COMPRESSIONKIND_INVALID if there is no such match.

Parameters

code	the string to convert to a CompressionKind_t.

Returns

the corresponding CompressionKind_t or SPATIAL_COMPRESSIONKIND_INVALID if no match is found.

Note

The matching is case-sensitive: "uncompressed" will return SPATIAL_COMPRESSIONKIND_UNCOMPRESSED, but "Uncompressed" will return SPATIAL_COMPRESSIONKIND_INVALID.

CompressionKind_isValid()

int CompressionKind_isValid

(

CompressionKind_t

ck

)

Predicate returning 1 (true) or 0 (false) depending on whether the given CompressionKind_t is valid.

Parameters

ck	the CompressionKind_t enumeration to query.

Returns

1 (true) if the CompressionKind_t is SPATIAL_COMPRESSIONKIND_UNCOMPRESSED, or SPATIAL_COMPRESSIONKIND_DEFLATED; 0 (false) otherwise (including SPATIAL_COMPRESSIONKIND_INVALID).

CompressionKind_isValidString()

int CompressionKind_isValidString

(

const char *

code

)

Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid CompressionKind_t.

Parameters

code	the string to query.

Returns

1 (true) if the string is "uncompressed", or "deflated"; 0 (false) otherwise.

Note

The matching is case-sensitive: "uncompressed" will return 1 (true), but "Uncompressed" will return 0 (false).

CompressionKind_parse()

CompressionKind_t CompressionKind_parse

(

const char *

code

)

CompressionKind_toString()

const char* CompressionKind_toString

(

CompressionKind_t

ck

)

Returns the string version of the provided CompressionKind_t enumeration.

Parameters

ck	the CompressionKind_t enumeration value to convert.

Returns

A string corresponding to the given type: "uncompressed", "deflated", or NULL if the value is SPATIAL_COMPRESSIONKIND_INVALID or another invalid enumeration value.

Note

The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

CoordinateKind_fromString()

CoordinateKind_t CoordinateKind_fromString

(

const char *

code

)

Returns the CoordinateKind_t enumeration corresponding to the given string or SPATIAL_COORDINATEKIND_INVALID if there is no such match.

Parameters

code	the string to convert to a CoordinateKind_t.

Returns

the corresponding CoordinateKind_t or SPATIAL_COORDINATEKIND_INVALID if no match is found.

Note

The matching is case-sensitive: "cartesianX" will return SPATIAL_COORDINATEKIND_CARTESIAN_X, but "CartesianX" will return SPATIAL_COORDINATEKIND_INVALID.

CoordinateKind_isValid()

int CoordinateKind_isValid

(

CoordinateKind_t

ck

)

Predicate returning 1 (true) or 0 (false) depending on whether the given CoordinateKind_t is valid.

Parameters

ck	the CoordinateKind_t enumeration to query.

Returns

1 (true) if the CoordinateKind_t is SPATIAL_COORDINATEKIND_CARTESIAN_X, SPATIAL_COORDINATEKIND_CARTESIAN_Y, or SPATIAL_COORDINATEKIND_CARTESIAN_Z; 0 (false) otherwise (including SPATIAL_COORDINATEKIND_INVALID).

CoordinateKind_isValidString()

int CoordinateKind_isValidString

(

const char *

code

)

Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid CoordinateKind_t.

Parameters

code	the string to query.

Returns

1 (true) if the string is "cartesianX", "cartesianY", or "cartesianZ"; 0 (false) otherwise.

Note

The matching is case-sensitive: "cartesianX" will return 1 (true), but "CartesianX" will return 0 (false).

CoordinateKind_parse()

CoordinateKind_t CoordinateKind_parse

(

const char *

code

)

CoordinateKind_toString()

const char* CoordinateKind_toString

(

CoordinateKind_t

ck

)

Returns the string version of the provided CoordinateKind_t enumeration.

Parameters

ck	the CoordinateKind_t enumeration value to convert.

Returns

A string corresponding to the given type: "cartesianX", "cartesianY", "cartesianZ", "invalid CoordinateKind value", or NULL if the value is SPATIAL_COORDINATEKIND_INVALID or another invalid enumeration value.

Note

The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

DataKind_fromString()

DataKind_t DataKind_fromString

(

const char *

code

)

Returns the DataKind_t enumeration corresponding to the given string or SPATIAL_DATAKIND_INVALID if there is no such match.

Parameters

code	the string to convert to a DataKind_t.

Returns

the corresponding DataKind_t or SPATIAL_DATAKIND_INVALID if no match is found.

Note

The matching is case-sensitive: "double" will return SPATIAL_DATAKIND_DOUBLE, but "Double" will return SPATIAL_DATAKIND_INVALID.

DataKind_isValid()

int DataKind_isValid

(

DataKind_t

dk

)

Predicate returning 1 (true) or 0 (false) depending on whether the given DataKind_t is valid.

Parameters

dk	the DataKind_t enumeration to query.

Returns

1 (true) if the DataKind_t is SPATIAL_DATAKIND_UINT SPATIAL_DATAKIND_INT SPATIAL_DATAKIND_DOUBLE, SPATIAL_DATAKIND_FLOAT, SPATIAL_DATAKIND_UINT8, SPATIAL_DATAKIND_UINT16, or SPATIAL_DATAKIND_UINT32; 0 (false) otherwise (including SPATIAL_DATAKIND_INVALID).

DataKind_isValidString()

int DataKind_isValidString

(

const char *

code

)

Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid DataKind_t.

Parameters

code	the string to query.

Returns

1 (true) if the string is "uint", "int", "double", "float", "uint8", "uint16", or "uint32"; 0 (false) otherwise.

Note

The matching is case-sensitive: "double" will return 1 (true), but "Double" will return 0 (false).

DataKind_parse()

DataKind_t DataKind_parse

(

const char *

code

)

DataKind_toString()

const char* DataKind_toString

(

DataKind_t

dk

)

Returns the string version of the provided DataKind_t enumeration.

Parameters

dk	the DataKind_t enumeration value to convert.

Returns

A string corresponding to the given type: "uint", "int", "double", "float", "uint8", "uint16", "uint32", or NULL if the value is SPATIAL_DATAKIND_INVALID or another invalid enumeration value.

Note

The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

DiffusionKind_fromString()

DiffusionKind_t DiffusionKind_fromString

(

const char *

code

)

Returns the DiffusionKind_t enumeration corresponding to the given string or SPATIAL_DIFFUSIONKIND_INVALID if there is no such match.

Parameters

code	the string to convert to a DiffusionKind_t.

Returns

the corresponding DiffusionKind_t or SPATIAL_DIFFUSIONKIND_INVALID if no match is found.

Note

The matching is case-sensitive: "isotropic" will return SPATIAL_DIFFUSIONKIND_ISOTROPIC, but "Isotropic" will return SPATIAL_DIFFUSIONKIND_INVALID.

DiffusionKind_isValid()

int DiffusionKind_isValid

(

DiffusionKind_t

dk

)

Predicate returning 1 (true) or 0 (false) depending on whether the given DiffusionKind_t is valid.

Parameters

dk	the DiffusionKind_t enumeration to query.

Returns

1 (true) if the DiffusionKind_t is SPATIAL_DIFFUSIONKIND_ISOTROPIC, SPATIAL_DIFFUSIONKIND_ANISOTROPIC, or SPATIAL_DIFFUSIONKIND_TENSOR; 0 (false) otherwise (including SPATIAL_DIFFUSIONKIND_INVALID).

DiffusionKind_isValidString()

int DiffusionKind_isValidString

(

const char *

code

)

Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid DiffusionKind_t.

Parameters

code	the string to query.

Returns

1 (true) if the string is "isotropic", "anisotropic", or "tensor"; 0 (false) otherwise.

Note

The matching is case-sensitive: "isotropic" will return 1 (true), but "Isotropic" will return 0 (false).

DiffusionKind_parse()

DiffusionKind_t DiffusionKind_parse

(

const char *

code

)

DiffusionKind_toString()

const char* DiffusionKind_toString

(

DiffusionKind_t

dk

)

Returns the string version of the provided DiffusionKind_t enumeration.

Parameters

dk	the DiffusionKind_t enumeration value to convert.

Returns

A string corresponding to the given type: "isotropic", "anisotropic", "tensor", or NULL if the value is SPATIAL_DIFFUSIONKIND_INVALID or another invalid enumeration value.

Note

The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

FunctionKind_fromString()

FunctionKind_t FunctionKind_fromString

(

const char *

code

)

Returns the FunctionKind_t enumeration corresponding to the given string or SPATIAL_FUNCTIONKIND_INVALID if there is no such match.

Parameters

code	the string to convert to a FunctionKind_t.

Returns

the corresponding FunctionKind_t or SPATIAL_FUNCTIONKIND_INVALID if no match is found.

Note

The matching is case-sensitive: "layered" will return SPATIAL_FUNCTIONKIND_LAYERED, but "Layered" will return SPATIAL_FUNCTIONKIND_INVALID.

FunctionKind_isValid()

int FunctionKind_isValid

(

FunctionKind_t

fk

)

Predicate returning 1 (true) or 0 (false) depending on whether the given FunctionKind_t is valid.

Parameters

fk	the FunctionKind_t enumeration to query.

Returns

1 (true) if the FunctionKind_t is SPATIAL_FUNCTIONKIND_LAYERED; 0 (false) otherwise (including SPATIAL_FUNCTIONKIND_INVALID).

FunctionKind_isValidString()

int FunctionKind_isValidString

(

const char *

code

)

Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid FunctionKind_t.

Parameters

code	the string to query.

Returns

1 (true) if the string is "layered"; 0 (false) otherwise.

Note

The matching is case-sensitive: "layered" will return 1 (true), but "Layered" will return 0 (false).

FunctionKind_parse()

FunctionKind_t FunctionKind_parse

(

const char *

code

)

FunctionKind_toString()

const char* FunctionKind_toString

(

FunctionKind_t

fk

)

Returns the string version of the provided FunctionKind_t enumeration.

Parameters

fk	the FunctionKind_t enumeration value to convert.

Returns

A string corresponding to the given type: "layered", or NULL if the value is SPATIAL_FUNCTIONKIND_INVALID or another invalid enumeration value.

Note

The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

GeometryKind_fromString()

GeometryKind_t GeometryKind_fromString

(

const char *

code

)

Returns the GeometryKind_t enumeration corresponding to the given string or SPATIAL_GEOMETRYKIND_INVALID if there is no such match.

Parameters

code	the string to convert to a GeometryKind_t.

Returns

the corresponding GeometryKind_t or SPATIAL_GEOMETRYKIND_INVALID if no match is found.

Note

The matching is case-sensitive: "cartesian" will return SPATIAL_GEOMETRYKIND_CARTESIAN, but "Cartesian" will return SPATIAL_GEOMETRYKIND_INVALID.

GeometryKind_isValid()

int GeometryKind_isValid

(

GeometryKind_t

gk

)

Predicate returning 1 (true) or 0 (false) depending on whether the given GeometryKind_t is valid.

Parameters

gk	the GeometryKind_t enumeration to query.

Returns

1 (true) if the GeometryKind_t is SPATIAL_GEOMETRYKIND_CARTESIAN; 0 (false) otherwise (including SPATIAL_GEOMETRYKIND_INVALID).

GeometryKind_isValidString()

int GeometryKind_isValidString

(

const char *

code

)

Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid GeometryKind_t.

Parameters

code	the string to query.

Returns

1 (true) if the string is "cartesian"; 0 (false) otherwise.

Note

The matching is case-sensitive: "cartesian" will return 1 (true), but "Cartesian" will return 0 (false).

GeometryKind_parse()

GeometryKind_t GeometryKind_parse

(

const char *

code

)

GeometryKind_toString()

const char* GeometryKind_toString

(

GeometryKind_t

gk

)

Returns the string version of the provided GeometryKind_t enumeration.

Parameters

gk	the GeometryKind_t enumeration value to convert.

Returns

A string corresponding to the given type: "cartesian", or NULL if the value is SPATIAL_GEOMETRYKIND_INVALID or another invalid enumeration value.

Note

The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

InterpolationKind_fromString()

InterpolationKind_t InterpolationKind_fromString

(

const char *

code

)

Returns the InterpolationKind_t enumeration corresponding to the given string or SPATIAL_INTERPOLATIONKIND_INVALID if there is no such match.

Parameters

code	the string to convert to a InterpolationKind_t.

Returns

the corresponding InterpolationKind_t or SPATIAL_INTERPOLATIONKIND_INVALID if no match is found.

Note

The matching is case-sensitive: "nearestNeighbor" will return SPATIAL_INTERPOLATIONKIND_NEARESTNEIGHBOR, but "NearestNeighbor" will return SPATIAL_INTERPOLATIONKIND_INVALID.

InterpolationKind_isValid()

int InterpolationKind_isValid

(

InterpolationKind_t

ik

)

Predicate returning 1 (true) or 0 (false) depending on whether the given InterpolationKind_t is valid.

Parameters

ik	the InterpolationKind_t enumeration to query.

Returns

1 (true) if the InterpolationKind_t is SPATIAL_INTERPOLATIONKIND_NEARESTNEIGHBOR, or SPATIAL_INTERPOLATIONKIND_LINEAR; 0 (false) otherwise (including SPATIAL_INTERPOLATIONKIND_INVALID).

InterpolationKind_isValidString()

int InterpolationKind_isValidString

(

const char *

code

)

Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid InterpolationKind_t.

Parameters

code	the string to query.

Returns

1 (true) if the string is "nearestNeighbor", or "linear"; 0 (false) otherwise.

Note

The matching is case-sensitive: "nearestNeighbor" will return 1 (true), but "NearestNeighbor" will return 0 (false).

InterpolationKind_parse()

InterpolationKind_t InterpolationKind_parse

(

const char *

code

)

InterpolationKind_toString()

const char* InterpolationKind_toString

(

InterpolationKind_t

ik

)

Returns the string version of the provided InterpolationKind_t enumeration.

Parameters

ik	the InterpolationKind_t enumeration value to convert.

Returns

A string corresponding to the given type: "nearestNeighbor", "linear", or NULL if the value is SPATIAL_INTERPOLATIONKIND_INVALID or another invalid enumeration value.

Note

The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

PolygonKind_fromString()

PolygonKind_t PolygonKind_fromString

(

const char *

code

)

Returns the PolygonKind_t enumeration corresponding to the given string or SPATIAL_POLYGONKIND_INVALID if there is no such match.

Parameters

code	the string to convert to a PolygonKind_t.

Returns

the corresponding PolygonKind_t or SPATIAL_POLYGONKIND_INVALID if no match is found.

Note

The matching is case-sensitive: "triangle" will return SPATIAL_POLYGONKIND_TRIANGLE, but "Triangle" will return SPATIAL_POLYGONKIND_INVALID.

PolygonKind_isValid()

int PolygonKind_isValid

(

PolygonKind_t

pk

)

Predicate returning 1 (true) or 0 (false) depending on whether the given PolygonKind_t is valid.

Parameters

pk	the PolygonKind_t enumeration to query.

Returns

1 (true) if the PolygonKind_t is SPATIAL_POLYGONKIND_TRIANGLE, or 0 (false) otherwise (including SPATIAL_POLYGONKIND_INVALID).

PolygonKind_isValidString()

int PolygonKind_isValidString

(

const char *

code

)

Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid PolygonKind_t.

Parameters

code	the string to query.

Returns

1 (true) if the string is "triangle", or 0 (false) otherwise.

Note

The matching is case-sensitive: "triangle" will return 1 (true), but "Triangle" will return 0 (false).

PolygonKind_parse()

PolygonKind_t PolygonKind_parse

(

const char *

code

)

PolygonKind_toString()

const char* PolygonKind_toString

(

PolygonKind_t

pk

)

Returns the string version of the provided PolygonKind_t enumeration.

Parameters

pk	the PolygonKind_t enumeration value to convert.

Returns

A string corresponding to the given type: "triangle", or NULL if the value is SPATIAL_POLYGONKIND_INVALID or another invalid enumeration value.

Note

The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

PrimitiveKind_fromString()

PrimitiveKind_t PrimitiveKind_fromString

(

const char *

code

)

Returns the PrimitiveKind_t enumeration corresponding to the given string or SPATIAL_PRIMITIVEKIND_INVALID if there is no such match.

Parameters

code	the string to convert to a PrimitiveKind_t.

Returns

the corresponding PrimitiveKind_t or SPATIAL_PRIMITIVEKIND_INVALID if no match is found.

Note

The matching is case-sensitive: "sphere" will return SPATIAL_PRIMITIVEKIND_SPHERE, but "Sphere" will return SPATIAL_PRIMITIVEKIND_INVALID.

PrimitiveKind_isValid()

int PrimitiveKind_isValid

(

PrimitiveKind_t

pk

)

Predicate returning 1 (true) or 0 (false) depending on whether the given PrimitiveKind_t is valid.

Parameters

pk	the PrimitiveKind_t enumeration to query.

Returns

1 (true) if the PrimitiveKind_t is SPATIAL_PRIMITIVEKIND_SPHERE, SPATIAL_PRIMITIVEKIND_CUBE, SPATIAL_PRIMITIVEKIND_CYLINDER, SPATIAL_PRIMITIVEKIND_CONE, SPATIAL_PRIMITIVEKIND_CIRCLE, SPATIAL_PRIMITIVEKIND_SQUARE, or 0 (false) otherwise (including SPATIAL_PRIMITIVEKIND_INVALID).

PrimitiveKind_isValidString()

int PrimitiveKind_isValidString

(

const char *

code

)

Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid PrimitiveKind_t.

Parameters

code	the string to query.

Returns

1 (true) if the string is "sphere", "cube", "cylinder", "cone", "circle", "square", or 0 (false) otherwise.

Note

The matching is case-sensitive: "sphere" will return 1 (true), but "Sphere" will return 0 (false).

PrimitiveKind_parse()

PrimitiveKind_t PrimitiveKind_parse

(

const char *

code

)

PrimitiveKind_toString()

const char* PrimitiveKind_toString

(

PrimitiveKind_t

pk

)

Returns the string version of the provided PrimitiveKind_t enumeration.

Parameters

pk	the PrimitiveKind_t enumeration value to convert.

Returns

A string corresponding to the given type: "sphere", "cube", "cylinder", "cone", "circle", "square", or NULL if the value is SPATIAL_PRIMITIVEKIND_INVALID or another invalid enumeration value.

Note

The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

SetOperation_fromString()

SetOperation_t SetOperation_fromString

(

const char *

code

)

Returns the SetOperation_t enumeration corresponding to the given string or SPATIAL_SETOPERATION_INVALID if there is no such match.

Parameters

code	the string to convert to a SetOperation_t.

Returns

the corresponding SetOperation_t or SPATIAL_SETOPERATION_INVALID if no match is found.

Note

The matching is case-sensitive: "union" will return SPATIAL_SETOPERATION_UNION, but "Union" will return SPATIAL_SETOPERATION_INVALID.

SetOperation_isValid()

int SetOperation_isValid

(

SetOperation_t

so

)

Predicate returning 1 (true) or 0 (false) depending on whether the given SetOperation_t is valid.

Parameters

so	the SetOperation_t enumeration to query.

Returns

1 (true) if the SetOperation_t is SPATIAL_SETOPERATION_UNION, SPATIAL_SETOPERATION_INTERSECTION, or SPATIAL_SETOPERATION_DIFFERENCE; 0 (false) otherwise (including SPATIAL_SETOPERATION_INVALID).

SetOperation_isValidString()

int SetOperation_isValidString

(

const char *

code

)

Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid SetOperation_t.

Parameters

code	the string to query.

Returns

1 (true) if the string is "union", "intersection", "difference", or "invalid SetOperation value"; 0 (false) otherwise.

Note

The matching is case-sensitive: "union" will return 1 (true), but "Union" will return 0 (false).

SetOperation_parse()

SetOperation_t SetOperation_parse

(

const char *

code

)

SetOperation_toString()

const char* SetOperation_toString

(

SetOperation_t

so

)

Returns the string version of the provided SetOperation_t enumeration.

Parameters

so	the SetOperation_t enumeration value to convert.

Returns

A string corresponding to the given type: "union", "intersection", "difference", or NULL if the value is SPATIAL_SETOPERATION_INVALID or another invalid enumeration value.

Note

The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.