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 SPATIAL_BOUNDARYKIND_INVALID 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 SPATIAL_COMPRESSIONKIND_INVALID 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 SPATIAL_COORDINATEKIND_INVALID 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 SPATIAL_DATAKIND_INVALID 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 SPATIAL_DIFFUSIONKIND_INVALID 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 SPATIAL_FUNCTIONKIND_INVALID 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 SPATIAL_GEOMETRYKIND_INVALID 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 SPATIAL_INTERPOLATIONKIND_INVALID 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 SPATIAL_POLYGONKIND_INVALID 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 SPATIAL_PRIMITIVEKIND_INVALID 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 SPATIAL_SETOPERATION_INVALID 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< SpatialExtension >	spatialExtensionRegistry
	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 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.

=
{
  "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.

Functions

Variables

Detailed Description

Function Documentation

◆ BoundaryKind_fromString()

◆ BoundaryKind_isValid()

◆ BoundaryKind_isValidString()

◆ BoundaryKind_parse()

◆ BoundaryKind_toString()

◆ CompressionKind_fromString()

◆ CompressionKind_isValid()

◆ CompressionKind_isValidString()

◆ CompressionKind_parse()

◆ CompressionKind_toString()

◆ CoordinateKind_fromString()

◆ CoordinateKind_isValid()

◆ CoordinateKind_isValidString()

◆ CoordinateKind_parse()

◆ CoordinateKind_toString()

◆ DataKind_fromString()

◆ DataKind_isValid()

◆ DataKind_isValidString()

◆ DataKind_parse()

◆ DataKind_toString()

◆ DiffusionKind_fromString()

◆ DiffusionKind_isValid()

◆ DiffusionKind_isValidString()

◆ DiffusionKind_parse()

◆ DiffusionKind_toString()

◆ FunctionKind_fromString()

◆ FunctionKind_isValid()

◆ FunctionKind_isValidString()

◆ FunctionKind_parse()

◆ FunctionKind_toString()

◆ GeometryKind_fromString()

◆ GeometryKind_isValid()

◆ GeometryKind_isValidString()

◆ GeometryKind_parse()

◆ GeometryKind_toString()

◆ InterpolationKind_fromString()

◆ InterpolationKind_isValid()

◆ InterpolationKind_isValidString()

◆ InterpolationKind_parse()

◆ InterpolationKind_toString()

◆ PolygonKind_fromString()

◆ PolygonKind_isValid()

◆ PolygonKind_isValidString()

◆ PolygonKind_parse()

◆ PolygonKind_toString()

◆ PrimitiveKind_fromString()

◆ PrimitiveKind_isValid()

◆ PrimitiveKind_isValidString()

◆ PrimitiveKind_parse()

◆ PrimitiveKind_toString()

◆ SetOperation_fromString()

◆ SetOperation_isValid()

◆ SetOperation_isValidString()

◆ SetOperation_parse()

◆ SetOperation_toString()

Variable Documentation

◆ SBML_BOUNDARY_KIND_STRINGS

◆ SBML_COMPRESSION_KIND_STRINGS

◆ SBML_COORDINATE_KIND_STRINGS

◆ SBML_DATA_KIND_STRINGS

◆ SBML_DIFFUSION_KIND_STRINGS

◆ SBML_FUNCTION_KIND_STRINGS

◆ SBML_GEOMETRY_KIND_STRINGS

◆ SBML_INTERPOLATION_KIND_STRINGS

◆ SBML_POLYGON_KIND_STRINGS

◆ SBML_PRIMITIVE_KIND_STRINGS

◆ SBML_SET_OPERATION_STRINGS

◆ SBML_SPATIAL_TYPECODE_STRINGS

◆ spatialExtensionRegistry