Groups

The libSBML “groups” extension implements support for the SBML Level 3 Groups package.

Introduction

The SBML Level 3 Groups package offers a more flexible mechanism for indicating that components of an SBML model are related in some way. The nature of the relationship is left up to the modeler, and can be clarified by means of annotations on model components. Groups may contain either the same or different types of SBML objects, and groups may be nested if desired. There are no predefined behavioral semantics associated with groups. The term groups is used in this package rather than types, because the latter would imply stronger behavioral constraints on objects than what Groups provides. This package only provides a way of conceptually grouping components of a model. It does not provide a way to define types in the computer science sense; therefore, a different term is appropriate.

Authors

The primary authors of the SBML Level 3 Groups specification are Michael Hucka and Lucian P. Smith.

The specification for this SBML package

This API documentation for libSBML does not provide a complete explanation of the SBML Level 3 Groups package (whose nickname is also “groups”). If you are developing software that uses “groups”, you are strongly urged to read the actual specification for the package. A link to the specification document current is provided below, along with a link to the page of known issues (if any).

Specification for SBML Level 3 Groups, current at the time of this libSBML release (5.18.0). Note: an Internet connection is required to access these documents.

Specification (in PDF format)	Known issues
Groups package, Version 1 Release 1	Errata page

More...

Classes
class	libsbmlcs.Group
	groups Representation of a group of SBML components. More...
class	libsbmlcs.GroupsExtension
	groups Base extension class for the package. More...
class	libsbmlcs.GroupsModelPlugin
	groups Extension of Model. More...
class	libsbmlcs.ListOfGroups
	groups A list of Group objects. More...
class	libsbmlcs.ListOfMembers
	groups A list of Member objects. More...
class	libsbmlcs.Member
	groups The Member class defines what objects are parts of a Group. More...

Detailed Description

The libSBML “groups” extension implements support for the SBML Level 3 Groups package.

Introduction

The SBML Level 3 Groups package offers a more flexible mechanism for indicating that components of an SBML model are related in some way. The nature of the relationship is left up to the modeler, and can be clarified by means of annotations on model components. Groups may contain either the same or different types of SBML objects, and groups may be nested if desired. There are no predefined behavioral semantics associated with groups. The term groups is used in this package rather than types, because the latter would imply stronger behavioral constraints on objects than what Groups provides. This package only provides a way of conceptually grouping components of a model. It does not provide a way to define types in the computer science sense; therefore, a different term is appropriate.

Authors

The primary authors of the SBML Level 3 Groups specification are Michael Hucka and Lucian P. Smith.

The specification for this SBML package

This API documentation for libSBML does not provide a complete explanation of the SBML Level 3 Groups package (whose nickname is also “groups”). If you are developing software that uses “groups”, you are strongly urged to read the actual specification for the package. A link to the specification document current is provided below, along with a link to the page of known issues (if any).

Specification for SBML Level 3 Groups, current at the time of this libSBML release (5.18.0). Note: an Internet connection is required to access these documents.

Specification (in PDF format)	Known issues
Groups package, Version 1 Release 1	Errata page