sbmlPtr-class: Class '"sbmlPtr"'

In SysBioChalmers/sybil-SBML: 'SBML' Integration in Package 'Sybil'

Class "sbmlPtr"

Description

Containing SBML pointer objects.

Objects from the Class

Objects can be created by calls of the form

doc <- sbmlDocPointer(pointer).

pointer:

an object of class sbml_doc_ptr containing a pointer to a SBML document.

doc <- sbmlModPointer(pointer, sbmlDoc).

pointer:

an object of class sbml_mod_ptr containing a pointer to a SBML model.

sbmlDoc:

an object of class sbmlPtr containing a pointer to a SBML document (returned by sbmlDocPointer).

This constructor functions are only used internally, objects of class sbmlPtr are returned by the functions openSBMLfile and getSBMLmodel.

Slots

sbmlPtrType:

Object of class "character" containing the type of the pointer.

sbmlPointer:

Object of class "externalptr" containing a pointer to a SBML document or model.

sbmlFileName:

Object of class "character" containing the file name of the SBML file generating the errors.

sbmlDocKey:

Object of class "character" containing a single character string functioning as a unique key to a SBML document object.

Methods

isNULLpointerSBML

signature(object = "sbmlPtr"): returns TRUE if sbmlPointer(object) is a NULL pointer, otherwise FALSE.

isSBMLdocpointer

signature(object = "sbmlPtr"): returns TRUE if sbmlPointer(object) is a pointer to a SBML document, otherwise FALSE.

isSBMLmodpointer

signature(object = "sbmlPtr"): returns TRUE if sbmlPointer(object) is a pointer to a SBML model, otherwise FALSE.

sbmlDocKey

signature(object = "sbmlPtr"): gets the sbmlDocKey slot.

sbmlFileName

signature(object = "sbmlPtr"): gets the sbmlFileName slot.

sbmlPointer

signature(object = "sbmlPtr"): gets the sbmlPointer slot.

sbmlPtrType

signature(object = "sbmlPtr"): gets the sbmlPtrType slot.

Author(s)

Gabriel Gelius-Dietrich <[e-mail]>

Maintainer: Mayo Roettger <[e-mail]>

See Also

openSBMLfile, getSBMLmodel

Examples

  showClass("sbmlError")

SysBioChalmers/sybil-SBML documentation built on Aug. 24, 2023, 1:11 p.m.