libSBML C++ API
5.18.0
|
Definition of GroupsExtension. More...
Classes | |
class | GroupsExtension |
groups
Base extension class for the package. More... | |
Macros | |
#define | GROUPS_CREATE_NS(variable, sbmlns) EXTENSION_CREATE_NS(GroupsPkgNamespaces, variable, sbmlns); |
Typedefs | |
typedef SBMLExtensionNamespaces< GroupsExtension > | GroupsPkgNamespaces |
Required typedef definitions. More... | |
Enumerations | |
enum | GroupKind_t { GROUP_KIND_CLASSIFICATION, GROUP_KIND_PARTONOMY, GROUP_KIND_COLLECTION, GROUP_KIND_UNKNOWN } |
Enumeration of values permitted as the value of the "kind" attribute on Group objects. More... | |
enum | SBMLGroupsTypeCode_t { SBML_GROUPS_MEMBER = 500, SBML_GROUPS_GROUP = 501 } |
SBMLGroupsTypeCode_t Enumeration of possible types in the libSBML “groups” package implementation. More... | |
Functions | |
GroupKind_t | GroupKind_fromString (const char *code) |
Returns the enumeration value corresponding to the given string or GROUP_KIND_UNKNOWN if there is no such match. More... | |
int | GroupKind_isValid (GroupKind_t gk) |
Predicate returning 1 (true) or 0 (false) depending on whether the given enumeration value is valid. More... | |
int | GroupKind_isValidString (const char *code) |
Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid enumeration value. More... | |
const char * | GroupKind_toString (GroupKind_t gk) |
Returns the string version of the provided enumeration value. More... | |
Definition of GroupsExtension.
#define GROUPS_CREATE_NS | ( | variable, | |
sbmlns | |||
) | EXTENSION_CREATE_NS(GroupsPkgNamespaces, variable, sbmlns); |
Required typedef definitions.
GroupsPkgNamespaces is derived from SBMLNamespaces class and used when creating an object of SBase derived classes defined in the groups package
SBMLExtensionNamespaces<GroupsExtension> must be instantiated in GroupsExtension.cpp for DLL
enum GroupKind_t |
Enumeration of values permitted as the value of the "kind" attribute on Group objects.
enum SBMLGroupsTypeCode_t |
SBMLGroupsTypeCode_t Enumeration of possible types in the libSBML “groups” package implementation.
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.
SBMLLayoutTypeCode_t
for the SBML Level 3 Layout extension, SBMLFbcTypeCode_t
for the SBML Level 3 Flux Balance Constraints extension, etc.).NULL
if the value you give it is actually from a package.The following example code illustrates the combined use of SBase::getPackageName() and SBase::getTypeCode():
Enumerator | |
---|---|
SBML_GROUPS_MEMBER | |
SBML_GROUPS_GROUP |
GroupKind_t GroupKind_fromString | ( | const char * | code | ) |
Returns the enumeration value corresponding to the given string or GROUP_KIND_UNKNOWN if there is no such match.
code | the string to convert to an enumeration value. |
int GroupKind_isValid | ( | GroupKind_t | gk | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given enumeration value is valid.
gk | the enumeration value to query. |
1
(true) if the value is GROUP_KIND_CLASSIFICATION, GROUP_KIND_PARTONOMY, or GROUP_KIND_COLLECTION; 0
(false) otherwise (including GROUP_KIND_UNKNOWN). int GroupKind_isValidString | ( | const char * | code | ) |
Predicate returning 1
(true) or 0
(false) depending on whether the given string is a valid enumeration value.
code | the string to query. |
1
(true) if the string is "classification", "partonomy", or "collection"; 0
(false) otherwise.1
(true), but "Classification" will return 0
(false). const char* GroupKind_toString | ( | GroupKind_t | gk | ) |
Returns the string version of the provided enumeration value.
gk | the enumeration value to convert. |
NULL
if the value is GROUP_KIND_UNKNOWN or another invalid enumeration value.