DistribExtension.cpp File Reference

Implementation of DistribExtension. More...

Include dependency graph for DistribExtension.cpp:

Functions
UncertType_t	UncertType_fromString (const char *code)
	Returns the UncertType_t enumeration corresponding to the given string or DISTRIB_UNCERTTYPE_INVALID if there is no such match. More...
int	UncertType_isValid (UncertType_t ut)
	Predicate returning 1 (true) or 0 (false) depending on whether the given UncertType_t is valid. More...
int	UncertType_isValidString (const char *code)
	Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid UncertType_t. More...
const char *	UncertType_toString (UncertType_t ut)
	Returns the string version of the provided UncertType_t enumeration. More...

Variables
static SBMLExtensionRegister< DistribExtension >	distribExtensionRegistry
	Adds this DistribExtension to the SBMLExtensionRegistry class. More...
static const char *	SBML_DISTRIB_TYPECODE_STRINGS []
static const char *	SBML_UNCERT_TYPE_STRINGS []

Detailed Description

Implementation of DistribExtension.

Author

SBMLTeam

Function Documentation

UncertType_fromString()

UncertType_t UncertType_fromString

(

const char *

code

)

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

Parameters

code	the string to convert to a UncertType_t.

Returns

the corresponding UncertType_t or DISTRIB_UNCERTTYPE_INVALID if no match is found.

Note

The matching is case-sensitive: "distribution" will return DISTRIB_UNCERTTYPE_DISTRIBUTION, but "Distribution" will return DISTRIB_UNCERTTYPE_INVALID.

UncertType_isValid()

int UncertType_isValid

(

UncertType_t

ut

)

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

Parameters

ut	the UncertType_t enumeration to query.

Returns

1 (true) if the UncertType_t is DISTRIB_UNCERTTYPE_DISTRIBUTION, DISTRIB_UNCERTTYPE_EXTERNALPARAMETER, DISTRIB_UNCERTTYPE_COEFFIENTOFVARIATION, DISTRIB_UNCERTTYPE_KURTOSIS, DISTRIB_UNCERTTYPE_MEAN, DISTRIB_UNCERTTYPE_MEDIAN, DISTRIB_UNCERTTYPE_MODE, DISTRIB_UNCERTTYPE_SAMPLESIZE, DISTRIB_UNCERTTYPE_SKEWNESS, DISTRIB_UNCERTTYPE_STANDARDDEVIATION, DISTRIB_UNCERTTYPE_STANDARDERROR, DISTRIB_UNCERTTYPE_VARIANCE, DISTRIB_UNCERTTYPE_CONFIDENCEINTERVAL, DISTRIB_UNCERTTYPE_CREDIBLEINTERVAL, DISTRIB_UNCERTTYPE_INTERQUARTILERANGE, or DISTRIB_UNCERTTYPE_RANGE; 0 (false) otherwise (including DISTRIB_UNCERTTYPE_INVALID).

UncertType_isValidString()

int UncertType_isValidString

(

const char *

code

)

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

Parameters

code	the string to query.

Returns

1 (true) if the string is "distribution", "externalParameter", "coeffientOfVariation", "kurtosis", "mean", "median", "mode", "sampleSize", "skewness", "standardDeviation", "standardError", "variance", "confidenceInterval", "credibleInterval", "interquartileRange", "range", or "invalid UncertType value"; 0 (false) otherwise.

Note

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

UncertType_toString()

const char* UncertType_toString

(

UncertType_t

ut

)

Returns the string version of the provided UncertType_t enumeration.

Parameters

ut	the UncertType_t enumeration value to convert.

Returns

A string corresponding to the given type: "distribution", "externalParameter", "coeffientOfVariation", "kurtosis", "mean", "median", "mode", "sampleSize", "skewness", "standardDeviation", "standardError", "variance", "confidenceInterval", "credibleInterval", "interquartileRange", "range", "invalid UncertType value", or NULL if the value is DISTRIB_UNCERTTYPE_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.

Variable Documentation

distribExtensionRegistry

SBMLExtensionRegister<DistribExtension> distribExtensionRegistry

static

Adds this DistribExtension to the SBMLExtensionRegistry class.

SBML_DISTRIB_TYPECODE_STRINGS

const char* SBML_DISTRIB_TYPECODE_STRINGS[]

static

Initial value:

=
{
    "UncertParameter"
  , "Uncertainty"
  , "UncertSpan"
  , "DistribBase"
}

SBML_UNCERT_TYPE_STRINGS

const char* SBML_UNCERT_TYPE_STRINGS[]

static

Initial value:

=
{
  "distribution"
, "externalParameter"
, "coeffientOfVariation"
, "kurtosis"
, "mean"
, "median"
, "mode"
, "sampleSize"
, "skewness"
, "standardDeviation"
, "standardError"
, "variance"
, "confidenceInterval"
, "credibleInterval"
, "interquartileRange"
, "range"
, "invalid UncertType value"
}