libSBML Perl API  libSBML 5.13.0 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)
 
int GroupKind_isValid (GroupKind_t gk)
 
int GroupKind_isValidString (const char *code)
 
const char * GroupKind_toString (GroupKind_t gk)
 

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.

GroupsPkgNamespace 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.

LibSBML attaches an identifying code to every kind of SBML object. These are integer constants known as SBML type codes. The names of all the codes begin with the characters SBML_. 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 getPackageName() method on the object.
Enumerator
SBML_GROUPS_MEMBER 

Member

SBML_GROUPS_GROUP 

Group

Function Documentation

§ GroupKind_fromString()

GroupKind_t GroupKind_fromString ( const char *  code)

§ GroupKind_isValid()

int GroupKind_isValid ( GroupKind_t  gk)

§ GroupKind_isValidString()

int GroupKind_isValidString ( const char *  code)

§ GroupKind_toString()

const char* GroupKind_toString ( GroupKind_t  gk)