libSBML Perl API  5.20.4
Loading...
Searching...
No Matches
SpatialExtension.cpp File Reference

Implementation of SpatialExtension. More...

Include dependency graph for SpatialExtension.cpp:

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.
 

Variables

static const char * SBML_BOUNDARY_KIND_STRINGS []
 
static const char * SBML_COMPRESSION_KIND_STRINGS []
 
static const char * SBML_COORDINATE_KIND_STRINGS []
 
static const char * SBML_DATA_KIND_STRINGS []
 
static const char * SBML_DIFFUSION_KIND_STRINGS []
 
static const char * SBML_FUNCTION_KIND_STRINGS []
 
static const char * SBML_GEOMETRY_KIND_STRINGS []
 
static const char * SBML_INTERPOLATION_KIND_STRINGS []
 
static const char * SBML_POLYGON_KIND_STRINGS []
 
static const char * SBML_PRIMITIVE_KIND_STRINGS []
 
static const char * SBML_SET_OPERATION_STRINGS []
 
static const char * SBML_SPATIAL_TYPECODE_STRINGS []
 
static SBMLExtensionRegister< SpatialExtensionspatialExtensionRegistry
 Adds this SpatialExtension to the SBMLExtensionRegistry class.
 

Detailed Description

Implementation of SpatialExtension.

Author
SBMLTeam

Function Documentation

◆ BoundaryKind_fromString()

BoundaryKind_t BoundaryKind_fromString ( const char *  code)

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

Parameters
codethe string to convert to a BoundaryKind_t.
Returns
the corresponding BoundaryKind_t or if no match is found.
Note
The matching is case-sensitive: "Neumann" will return , but "neumann" will return

◆ 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
bkthe BoundaryKind_t enumeration to query.
Returns
1 (true) if the BoundaryKind_t is , or ; 0 (false) otherwise (including ).

◆ 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
codethe 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
bkthe BoundaryKind_t enumeration value to convert.
Returns
A string corresponding to the given type: "Neumann", "Dirichlet", or NULL if the value is 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 if there is no such match.

Parameters
codethe string to convert to a CompressionKind_t.
Returns
the corresponding CompressionKind_t or if no match is found.
Note
The matching is case-sensitive: "uncompressed" will return , but "Uncompressed" will return

◆ 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
ckthe CompressionKind_t enumeration to query.
Returns
1 (true) if the CompressionKind_t is , or ; 0 (false) otherwise (including ).

◆ 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
codethe 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
ckthe CompressionKind_t enumeration value to convert.
Returns
A string corresponding to the given type: "uncompressed", "deflated", or NULL if the value is 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 if there is no such match.

Parameters
codethe string to convert to a CoordinateKind_t.
Returns
the corresponding CoordinateKind_t or if no match is found.
Note
The matching is case-sensitive: "cartesianX" will return , but "CartesianX" will return

◆ 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
ckthe CoordinateKind_t enumeration to query.
Returns
1 (true) if the CoordinateKind_t is , , or ; 0 (false) otherwise (including ).

◆ 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
codethe 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
ckthe 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 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 if there is no such match.

Parameters
codethe string to convert to a DataKind_t.
Returns
the corresponding DataKind_t or if no match is found.
Note
The matching is case-sensitive: "double" will return , but "Double" will return

◆ 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
dkthe DataKind_t enumeration to query.
Returns
1 (true) if the DataKind_t is

, , , , or ; 0 (false) otherwise (including ).

◆ 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
codethe 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
dkthe 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 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 if there is no such match.

Parameters
codethe string to convert to a DiffusionKind_t.
Returns
the corresponding DiffusionKind_t or if no match is found.
Note
The matching is case-sensitive: "isotropic" will return , but "Isotropic" will return

◆ 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
dkthe DiffusionKind_t enumeration to query.
Returns
1 (true) if the DiffusionKind_t is , , or ; 0 (false) otherwise (including ).

◆ 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
codethe 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
dkthe DiffusionKind_t enumeration value to convert.
Returns
A string corresponding to the given type: "isotropic", "anisotropic", "tensor", or NULL if the value is 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 if there is no such match.

Parameters
codethe string to convert to a FunctionKind_t.
Returns
the corresponding FunctionKind_t or if no match is found.
Note
The matching is case-sensitive: "layered" will return , but "Layered" will return

◆ 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
fkthe FunctionKind_t enumeration to query.
Returns
1 (true) if the FunctionKind_t is ; 0 (false) otherwise (including ).

◆ 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
codethe 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
fkthe FunctionKind_t enumeration value to convert.
Returns
A string corresponding to the given type: "layered", or NULL if the value is 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 if there is no such match.

Parameters
codethe string to convert to a GeometryKind_t.
Returns
the corresponding GeometryKind_t or if no match is found.
Note
The matching is case-sensitive: "cartesian" will return , but "Cartesian" will return

◆ 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
gkthe GeometryKind_t enumeration to query.
Returns
1 (true) if the GeometryKind_t is ; 0 (false) otherwise (including ).

◆ 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
codethe 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
gkthe GeometryKind_t enumeration value to convert.
Returns
A string corresponding to the given type: "cartesian", or NULL if the value is 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 if there is no such match.

Parameters
codethe string to convert to a InterpolationKind_t.
Returns
the corresponding InterpolationKind_t or if no match is found.
Note
The matching is case-sensitive: "nearestNeighbor" will return , but "NearestNeighbor" will return

◆ 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
ikthe InterpolationKind_t enumeration to query.
Returns
1 (true) if the InterpolationKind_t is , or ; 0 (false) otherwise (including ).

◆ 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
codethe 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
ikthe InterpolationKind_t enumeration value to convert.
Returns
A string corresponding to the given type: "nearestNeighbor", "linear", or NULL if the value is 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 if there is no such match.

Parameters
codethe string to convert to a PolygonKind_t.
Returns
the corresponding PolygonKind_t or if no match is found.
Note
The matching is case-sensitive: "triangle" will return , but "Triangle" will return

◆ 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
pkthe PolygonKind_t enumeration to query.
Returns
1 (true) if the PolygonKind_t is , or 0 (false) otherwise (including ).

◆ 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
codethe 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
pkthe PolygonKind_t enumeration value to convert.
Returns
A string corresponding to the given type: "triangle", or NULL if the value is 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 if there is no such match.

Parameters
codethe string to convert to a PrimitiveKind_t.
Returns
the corresponding PrimitiveKind_t or if no match is found.
Note
The matching is case-sensitive: "sphere" will return , but "Sphere" will return

◆ 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
pkthe PrimitiveKind_t enumeration to query.
Returns
1 (true) if the PrimitiveKind_t is , , , , , , or 0 (false) otherwise (including ).

◆ 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
codethe 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
pkthe 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 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 if there is no such match.

Parameters
codethe string to convert to a SetOperation_t.
Returns
the corresponding SetOperation_t or if no match is found.
Note
The matching is case-sensitive: "union" will return , but "Union" will return

◆ 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
sothe SetOperation_t enumeration to query.
Returns
1 (true) if the SetOperation_t is , , or ; 0 (false) otherwise (including ).

◆ 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
codethe 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
sothe SetOperation_t enumeration value to convert.
Returns
A string corresponding to the given type: "union", "intersection", "difference", or NULL if the value is 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.

Variable Documentation

◆ SBML_BOUNDARY_KIND_STRINGS

const char* SBML_BOUNDARY_KIND_STRINGS[]
static
Initial value:
=
{
"Neumann"
, "Dirichlet"
, "invalid BoundaryKind value"
}

◆ SBML_COMPRESSION_KIND_STRINGS

const char* SBML_COMPRESSION_KIND_STRINGS[]
static
Initial value:
=
{
"uncompressed"
, "deflated"
, "invalid CompressionKind value"
}

◆ SBML_COORDINATE_KIND_STRINGS

const char* SBML_COORDINATE_KIND_STRINGS[]
static
Initial value:
=
{
"cartesianX"
, "cartesianY"
, "cartesianZ"
, "invalid CoordinateKind value"
}

◆ SBML_DATA_KIND_STRINGS

const char* SBML_DATA_KIND_STRINGS[]
static
Initial value:
=
{
"double"
, "float"
, "uint8"
, "uint16"
, "uint32"
, "uint"
, "int"
, "invalid DataKind value"
}

◆ SBML_DIFFUSION_KIND_STRINGS

const char* SBML_DIFFUSION_KIND_STRINGS[]
static
Initial value:
=
{
"isotropic"
, "anisotropic"
, "tensor"
, "invalid DiffusionKind value"
}

◆ SBML_FUNCTION_KIND_STRINGS

const char* SBML_FUNCTION_KIND_STRINGS[]
static
Initial value:
=
{
"layered"
, "invalid FunctionKind value"
}

◆ SBML_GEOMETRY_KIND_STRINGS

const char* SBML_GEOMETRY_KIND_STRINGS[]
static
Initial value:
=
{
"cartesian"
, "invalid GeometryKind value"
}

◆ SBML_INTERPOLATION_KIND_STRINGS

const char* SBML_INTERPOLATION_KIND_STRINGS[]
static
Initial value:
=
{
"nearestNeighbor"
, "linear"
, "invalid InterpolationKind value"
}

◆ SBML_POLYGON_KIND_STRINGS

const char* SBML_POLYGON_KIND_STRINGS[]
static
Initial value:
=
{
"triangle"
, "invalid PolygonKind value"
}

◆ SBML_PRIMITIVE_KIND_STRINGS

const char* SBML_PRIMITIVE_KIND_STRINGS[]
static
Initial value:
=
{
"sphere"
, "cube"
, "cylinder"
, "cone"
, "circle"
, "square"
, "invalid PrimitiveKind value"
}

◆ SBML_SET_OPERATION_STRINGS

const char* SBML_SET_OPERATION_STRINGS[]
static
Initial value:
=
{
"union"
, "intersection"
, "difference"
, "invalid SetOperation value"
}

◆ SBML_SPATIAL_TYPECODE_STRINGS

const char* SBML_SPATIAL_TYPECODE_STRINGS[]
static

◆ spatialExtensionRegistry

SBMLExtensionRegister<SpatialExtension> spatialExtensionRegistry
static

Adds this SpatialExtension to the SBMLExtensionRegistry class.