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

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

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

typedef SBMLExtensionNamespaces<GroupsExtension> 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

enum 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

enum 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_. 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.

Here follow some additional general information about libSBML type codes:

• The codes are the possible return values (integers) for the following functions:
  • SBase::getTypeCode()
  • ListOf::getItemTypeCode()
  (Compatibility note: in libSBML 5, the type of return values of these functions changed from an enumeration to an integer for extensibility in the face of different programming languages.)

• Each package extension must define similar sets of values for each SBase subclass (e.g. SBMLLayoutTypeCode_t for the SBML Level 3 Layout extension, SBMLFbcTypeCode_t for the SBML Level 3 Flux Balance Constraints extension, etc.).

• The value of each package-specific type code can be duplicated between those of different packages. (This is necessary because the development of libSBML extensions for different SBML packages may be undertaken by different developers at different times; requiring the developers to coordinate their use of type codes would be nettlesome and probably doomed to failure.)

• To distinguish between the type codes of different packages, both the return value of SBase::getTypeCode() and SBase::getPackageName() must be checked. This is particularly important for functions that take an SBML type code as an argument, such as SBase::getAncestorOfType(), which by default assumes you are handing it a core type, and will return 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():

void example (const SBase *sb)
{
  cons std::string pkgName = sb->getPackageName();
  if (pkgName == "core")
  {
    switch (sb->getTypeCode())
    {
      case SBML_MODEL:
         ....
         break;
      case SBML_REACTION:
         ....
    }
  }
  else if (pkgName == "layout")
  {
    switch (sb->getTypeCode())
    {
      case SBML_LAYOUT_LAYOUT:
         ....
         break;
      case SBML_LAYOUT_REACTIONGLYPH:
         ....
    }
  }
  ...
}

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 GROUP_KIND_UNKNOWN if there is no such match.

Parameters

code	the string to convert to an enumeration value.

Returns

the corresponding value, or GROUP_KIND_UNKNOWN if no match is found.

Note

The matching is case-sensitive: "classification" will return GROUP_KIND_CLASSIFICATION, but "Classification" will return GROUP_KIND_UNKNOWN.

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

gk	the enumeration value to query.

Returns

1 (true) if the value is GROUP_KIND_CLASSIFICATION, GROUP_KIND_PARTONOMY, or GROUP_KIND_COLLECTION; 0 (false) otherwise (including GROUP_KIND_UNKNOWN).

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

code	the 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

gk	the enumeration value to convert.

Returns

A string corresponding to the given type: "classification", "partonomy", "collection", or NULL if the value is GROUP_KIND_UNKNOWN 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.