libSBML Perl API  libSBML 5.17.2 Perl API
GroupsExtension.h File Reference

Definition of GroupsExtension. More...

Include dependency graph for GroupsExtension.h:
This graph shows which files directly or indirectly include this file:

Classes

class  GroupsExtension
 {groups} More...
 

Macros

#define GROUPS_CREATE_NS(variable, sbmlns)   EXTENSION_CREATE_NS(GroupsPkgNamespaces, variable, sbmlns);
 

Typedefs

typedef SBMLExtensionNamespaces< GroupsExtensionGroupsPkgNamespaces
 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. 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...
 

Detailed Description

Definition of GroupsExtension.

Author
SBMLTeam

Macro Definition Documentation

◆ GROUPS_CREATE_NS

#define GROUPS_CREATE_NS (   variable,
  sbmlns 
)    EXTENSION_CREATE_NS(GroupsPkgNamespaces, variable, sbmlns);

Typedef Documentation

◆ GroupsPkgNamespaces

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

Enumeration Type Documentation

◆ GroupKind_t

Enumeration of values permitted as the value of the "kind" attribute on Group objects.

See also
Group::getKind()
Group::setKind()
Enumerator
GROUP_KIND_CLASSIFICATION 

The group kind is "classification".

GROUP_KIND_PARTONOMY 

The group kind is "partonomy".

GROUP_KIND_COLLECTION 

The group kind is "collection".

GROUP_KIND_UNKNOWN 

Invalid GroupKind value.

◆ SBMLGroupsTypeCode_t

SBMLGroupsTypeCode_t Enumeration of possible types in the libSBML “groups” package implementation.

Enumerator
SBML_GROUPS_MEMBER 

Member

SBML_GROUPS_GROUP 

Group

Function Documentation

◆ GroupKind_fromString()

GroupKind_t GroupKind_fromString ( const char *  code)

Returns the enumeration value corresponding to the given string or.

◆ GroupKind_isValid()

int GroupKind_isValid ( GroupKind_t  gk)

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

Parameters
gkthe enumeration value to query.
Returns
1 (true) if the value is

◆ GroupKind_isValidString()

int GroupKind_isValidString ( const char *  code)

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

Parameters
codethe string to query.
Returns
1 (true) if the string is "classification", "partonomy", or "collection"; 0 (false) otherwise.
Note
The matching is case-sensitive: "classification" will return 1 (true), but "Classification" will return 0 (false).

◆ GroupKind_toString()

const char* GroupKind_toString ( GroupKind_t  gk)

Returns the string version of the provided enumeration value.

Parameters
gkthe enumeration value to convert.
Returns
A string corresponding to the given type: "classification", "partonomy", "collection", or NULL if the value is