C API Reference

This is the API reference for the C API of the SBMLNetwork library.

Functions

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getVersion()

Returns the version of the library.

Returns:

the version of the library.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCurrentDirectoryOfLibrary()

Returns the directory of the library.

Returns:

the directory of the library.

SBMLDocument *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_readSBML(const char *sbml)

Reads an SBML document from the given file name or the given text string.

Parameters:

sbml – either the name or full pathname of the file to be read or a string containing a full SBML model.

Returns:

a pointer to the SBMLDocument structure created from the SBML content in the given file name or from the SBML content in the given text string.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_writeSBMLToFile(SBMLDocument *document, const char *fileName)

Writes the given SBML document to a filename.

Parameters:
  • document – the SBML document to be written.

  • fileName – the name or full pathname of the file where the SBML is to be written.

Returns:

true on success and false if the filename could not be opened for writing.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_writeSBMLToString(SBMLDocument *document)

Writes the given SBML document to a string and returns it.

Parameters:

document – the SBML document to be written.

Returns:

the string on success and empty string if one of the underlying parser components fail.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSBMLLevel(SBMLDocument *document)

Returns the SBML Level of the SBMLDocument object containing this object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the SBML Level of the SBMLDocument object containing this object.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSBMLVersion(SBMLDocument *document)

Returns the Version within the SBML Level of the SBMLDocument object containing this object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the Version within the SBML Level of the SBMLDocument object containing this object.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_freeSBMLDocument(SBMLDocument *document)

Free the given SBML document.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

boolean value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getErrorLog(SBMLDocument *document)

@breif Returns the error log.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the error log.

void LIBSBMLNETWORK_CPP_NAMESPACE::c_api_clearErrorLog(SBMLDocument *document)

Clears the error log.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

boolean value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetModel(SBMLDocument *document)

Returns true if the Model object has been set, otherwise returns false.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

true if the Model object has been set, otherwise returns false.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_autolayout(SBMLDocument *document, const int maxNumConnectedEdges = 3, bool resetFixedPositionElements = false, const char ***fixedPositionNodes = NULL, const int fixedPositionNodesSize = 0, const int iterations = -1)

Create a Layout object, a GlobalRenderInformation object, and LocalRenderInformation resume object, add them to the the SBML document, and set all the necessary features for them.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • maxNumConnectedEdges – the maximum number of connected edges to a species glyph.

  • resetFixedPositionElements – a variable that determines whether to reset the fixed position elements in the autolayout algorithm.

  • fixedPositionNodeIds – an array of strings containing the ids of the nodes and the indices of their associated graphical objects that must have fixed position in the autolayout algorithm.

  • fixedPositionNodesSize – the size of fixedPositionNodeIds

  • iterations – the number of iterations to run the autolayout algorithm for. If -1, the algorithm will set it based on the number of species and reactions

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_autorender(SBMLDocument *document, const int maxNumConnectedEdges = 3)

Create a Render object, add it to the the SBML document, and set all the necessary features for it.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • maxNumConnectedEdges – the maximum number of connected edges to a species glyph.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_updateReactionCurves(SBMLDocument *document, const int layoutIndex = 0)

Updates the curves of the centroid node position of the ReactionGlyphs and the curve of their SpeciesReferenceGlyphs in the Layout object with the given index in the given SBMLDocument.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_align(SBMLDocument *document, const char ***nodes, const int nodesSize, const char *alignment, bool ignoreFixedPositionNodes = false)

Align the nodes position in the SBML document in the given alignment type.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • nodes – an array of strings containing the ids of the nodes and their associated graphical objects that should be aligned.

  • nodesSize – the size of nodeIds

  • alignment – determines how to align the nodes.

  • ignoreFixedPositionNodes – a variable that determines whether to ignore the fixed position nodes in the autolayout algorithm.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_distribute(SBMLDocument *document, const char ***nodes, const int nodesSize, const char *direction, const double spacing = -1.0)

Distribute the nodes position in the SBML document in the given direction.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • nodes – an array of strings containing the ids of the nodes and their associated graphical objects that should be distributed.

  • nodesSize – the size of nodeIds

  • direction – determines how to distribute the nodes.

  • spacing – the spacing between the distributed nodes.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_makeAllVisible(SBMLDocument *document, int layoutIndex = 0)

Make all the elements in the Layout object with the given index of the SBML document visible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_makeAllInvisible(SBMLDocument *document, int layoutIndex = 0)

Make all the elements in the Layout object with the given index of the SBML document invisible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_makeCompartmentsVisible(SBMLDocument *document, int layoutIndex = 0)

Make all the compartments in the Layout object with the given index of the SBML document visible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_makeCompartmentsInvisible(SBMLDocument *document, int layoutIndex = 0)

Make all the compartments in the Layout object with the given index of the SBML document invisible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_makeSpeciesVisible(SBMLDocument *document, int layoutIndex = 0)

Make all the species in the Layout object with the given index of the SBML document visible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_makeSpeciesInvisible(SBMLDocument *document, int layoutIndex = 0)

Make all the species in the Layout object with the given index of the SBML document invisible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_makeReactionsVisible(SBMLDocument *document, int layoutIndex = 0)

Make all the reactions in the Layout object with the given index of the SBML document visible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_makeReactionsInvisible(SBMLDocument *document, int layoutIndex = 0)

Make all the reactions in the Layout object with the given index of the SBML document invisible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_makeSpeciesReferencesVisible(SBMLDocument *document, int layoutIndex = 0)

Make all the species references in the Layout object with the given index of the SBML document visible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_makeSpeciesReferencesInvisible(SBMLDocument *document, int layoutIndex = 0)

Make all the species references in the Layout object with the given index of the SBML document invisible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_makeLineEndingsVisible(SBMLDocument *document, int layoutIndex = 0)

Make all the line endings in the Layout object with the given index of the SBML document visible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_makeLineEndingsInvisible(SBMLDocument *document, int layoutIndex = 0)

Make all the line endings in the Layout object with the given index of the SBML document invisible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isVisible(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the graphical object with the given index associated with the entered model in the layout object with the given index of the SBML document visible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the graphical object to check visibility.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

@true if the graphical object with the given index associated with the entered model in the layout object with the given index of the SBML document visible, @false otherwise.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_makeVisible(SBMLDocument *document, const char *id, bool applyToConnectedElements = true, int graphicalObjectIndex = 0, int layoutIndex = 0)

Make the graphical object with the given index associated with the entered model in the layout object with the given index of the SBML document visible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the graphical object to make visible.

  • applyToConnectedElements – a variable that determines whether to apply the visibility change to the connected elements.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_makeInvisible(SBMLDocument *document, const char *id, bool applyToConnectedElements = true, int graphicalObjectIndex = 0, int layoutIndex = 0)

Make the graphical object with the given index associated with the entered model in the layout object with the given index of the SBML document invisible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the graphical object to make invisible.

  • applyToConnectedElements – a variable that determines whether to apply the visibility change to the connected elements.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumLayouts(SBMLDocument *document)

Returns the number of items in the ListOfLayouts of this SBML document.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the number of items in of this SBML document, or 0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_removeLayouts(SBMLDocument *document)

Remove all the layout objects from the list of layouts of the SBML document.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_createDefaultLayoutFeatures(SBMLDocument *document, const int maxNumConnectedEdges = 3)

Create a Layout object, add it to list of layouts of the SBML document, and set all the necessary features for it.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • maxNumConnectedEdges – the maximum number of connected edges to a species glyph.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_createDefaultLayoutLocations(SBMLDocument *document, const int maxNumConnectedEdges = 3, bool resetFixedPositionElements = false, const char ***fixedPositionNodeIds = NULL, const int fixedPositionNodesSize = 0, const int iterations = -1)

Create a Layout object, add it to list of layouts of the SBML document, and set all the necessary features for it, and set the positions of the nodes in the layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • maxNumConnectedEdges – the maximum number of connected edges to a species glyph.

  • useMagnetism – a variable that determines whether to use magnetism in the autolayout algorithm.

  • useGrid – a variable that determines whether to use grid restriction in the autolayout algorithm.

  • resetFixedPositionElements – a variable that determines whether to reset the fixed position elements in the autolayout algorithm.

  • fixedPositionNodesSize – the size of fixedPositionNodeIds

  • fixedPositionNodeIds – an array of strings containing the ids of the nodes that must have fixed position in the autolayout algorithm.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getStoichiometricSpeciesReference(SBMLDocument *document)

Returns the value of the option to generate stoichiometric species reference in the autolayout algorithm.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the value of the option to generate stoichiometric species reference in the autolayout algorithm.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setStoichiometricSpeciesReference(SBMLDocument *document, bool stoichiometricSpeciesReference)

Sets the value of the option to generate stoichiometric species reference in the autolayout algorithm.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • stoichiometricSpeciesReference – the value of the option to generate stoichiometric species reference in the autolayout algorithm.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getUseNameAsTextLabel(SBMLDocument *document, int layoutIndex = 0)

Returns the option to use the name of the model entity as the text label of the GraphicalObject associated with the model entities in the Layout object with the given index in the ListOfLayouts of the SBMLDocument.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

the option to use the name of the model entity as the text label of the GraphicalObject associated with the model entities.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setUseNameAsTextLabel(SBMLDocument *document, bool useNameAsTextLabel, int layoutIndex = 0)

Sets the option to use the name of the model entity as the text label of the GraphicalObject associated with the model entities in the Layout object with the given index in the ListOfLayouts of the SBMLDocument.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • useNameAsTextLabel – the option to use the name of the model entity as the text label of the GraphicalObject associated with the model entities.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_createAliasSpeciesGlyph(SBMLDocument *document, const char *speciesId, const char *reactionId, int reactionGlyphIndex, int layoutIndex, int updateCurves)

Create an alias SpeciesGlyph object for Species with the given id and connect all the SpeciesReferences in the ReactionGlyph object with the given id and index that contain Species as a participant to the alias SpeciesGlyph in the Layout object with the given index in the ListOfLayouts of the SBMLDocument.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • speciesId – the id of the species to create an alias SpeciesGlyph for.

  • reactionId – the id of the reaction to create an alias SpeciesGlyph for.

  • reactionGlyphIndex – the index of the ReactionGlyph object.

  • layoutIndex – the index number of the Layout to return.

  • updateCurves – whether to re-run auto-layout after adding the glyph.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_createAliasReactionGlyph(SBMLDocument *document, const char *reactionId, int layoutIndex)

Create an alias ReactionGlyph object for Reaction with the given id.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction to create an alias ReactionGlyph for.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCanvasWidth(SBMLDocument *document, int layoutIndex = 0)

Returns the value of the “width” attribute of the Dimensions object of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

the value of the “width” attribute of the Dimensions object of the Layout object.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCanvasWidth(SBMLDocument *document, const double width, int layoutIndex = 0)

Sets the value of the “width” attribute of the Dimensions object of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

  • width – a double value to use as the value of the “width” attribute of the Dimensions object of the Layout object.

Returns:

integer value indicating success/failure of the function.

double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCanvasHeight(SBMLDocument *document, int layoutIndex = 0)

Returns the value of the “height” attribute of the Dimensions object of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

the value of the “height” attribute of the Dimensions object of the Layout object.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCanvasHeight(SBMLDocument *document, const double height, int layoutIndex = 0)

Sets the value of the “height” attribute of the Dimensions object of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

  • height – a double value to use as the value of the “height” attribute of the Dimensions object of the Layout object.

Returns:

integer value indicating success/failure of the function.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumAllGraphicalObjects(SBMLDocument *document, int layoutIndex = 0)

Returns the number of GraphicalObjects of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

the number of GraphicalObjects of this Layout object, or 0 if the object is NULL

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumGraphicalObjects(SBMLDocument *document, const char *id, int layoutIndex = 0)

Returns the number of GraphicalObjects of the Layout object with the given index in the ListOfLayouts of the SBML document associated with the entered model entity id.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the number of GraphicalObject objects associated with it is going to be returned.

  • layoutIndex – the index number of the Layout to return.

Returns:

the number of GraphicalObject objects associated with the entered model entity id, or 0 if the object is NULL or has no associated GraphicalObject objects

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_removeGraphicalObject(SBMLDocument *document, const char *id, int graphicalObjectIndex, int layoutIndex)
bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetId(SBMLDocument *document, const char *entityId, int graphicalObjectIndex, int layoutIndex)

Predicate returning true if the id of the GraphicalObject with the given id in the Layout object with the given index of the SBML document associated with the entered model entity id is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • entityId – the id of the model entity.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the id of the GraphicalObject is set, false otherwise

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getId(SBMLDocument *document, const char *entityId, int graphicalObjectIndex, int layoutIndex)

Returns the id of the GraphicalObject with the given id in the Layout object with the given index of the SBML document associated with the entered model entity id.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • entityId – the id of the model entity.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the id of the GraphicalObject, or "" if the id is not set or the object does not exists.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setId(SBMLDocument *document, const char *entityId, const char *graphicalObjectId, int graphicalObjectIndex, int layoutIndex)

Sets the id of the GraphicalObject with the given id in the Layout object with the given index of the SBML document associated with the entered model entity id.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • entityId – the id of the model entity.

  • graphicalObjectId – the id of the GraphicalObject.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getTextGlyphId(SBMLDocument *document, const char *entityId, int graphicalObjectIndex, int textGlyphIndex, int layoutIndex)

Returns the id of the TextGlyph with the given index of the GraphicalObject with the given id in the Layout object with the given index of the SBML document associated with the entered model entity id.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • entityId – the id of the model entity.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • textGlyphIndex – the index number of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the id of the GraphicalObject, or "" if the id is not set or the object does not exists.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setTextGlyphId(SBMLDocument *document, const char *entityId, const char *graphicalObjectId, int graphicalObjectIndex, int textGlyphIndex, int layoutIndex)

Sets the id of the TextGlyph with the given index of the GraphicalObject with the given id in the Layout object with the given index of the SBML document associated with the entered model entity id.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • entityId – the id of the model entity.

  • graphicalObjectId – the id of the GraphicalObject.

  • textGlyphIndex – the id of the TextGlyph.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetMetaId(SBMLDocument *document, const char *entityId, int graphicalObjectIndex, int layoutIndex)

Predicate returning true if the meta id of the GraphicalObject with the given id in the Layout object with the given index of the SBML document associated with the entered model entity id is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • entityId – the id of the model entity.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the meta id of the GraphicalObject is set, false otherwise

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getMetaId(SBMLDocument *document, const char *entityId, int graphicalObjectIndex, int layoutIndex)

Returns the meta id of the GraphicalObject with the given id in the Layout object with the given index of the SBML document associated with the entered model entity id.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • entityId – the id of the model entity.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the meta id of the GraphicalObject, or "" if the meta id is not set or the object does not exists.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setMetaId(SBMLDocument *document, const char *entityId, const char *metaId, int graphicalObjectIndex, int layoutIndex)

Sets the meta id of the GraphicalObject with the given id in the Layout object with the given index of the SBML document associated with the entered model entity id.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • entityId – the id of the model entity.

  • metaId – the meta id of the GraphicalObject.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetName(SBMLDocument *document, const char *entityId, int graphicalObjectIndex, int layoutIndex)

Predicate returning true if the name of the GraphicalObject with the given id in the Layout object with the given index of the SBML document associated with the entered model entity id is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • entityId – the id of the model entity.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the name of the GraphicalObject is set, false otherwise

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getName(SBMLDocument *document, const char *entityId, int graphicalObjectIndex, int layoutIndex)

Returns the name of the GraphicalObject with the given id in the Layout object with the given index of the SBML document associated with the entered model entity id.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • entityId – the id of the model entity.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the name of the GraphicalObject, or "" if the name is not set or the object does not exists.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setName(SBMLDocument *document, const char *entityId, const char *name, int graphicalObjectIndex, int layoutIndex)

Sets the name of the GraphicalObject with the given id in the Layout object with the given index of the SBML document associated with the entered model entity id.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • entityId – the id of the model entity.

  • name – the name of the GraphicalObject.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumCompartments(SBMLDocument *document)

Returns the number of Compartment objects in the given SBML document.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the number of Compartment objects in the given SBML document.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentId(SBMLDocument *document, int compartmentIndex)

Returns the id of the Compartment object with the given index in the given SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • compartmentIndex – the index of the Compartment object.

Returns:

the id of the Compartment object with the given index in the given SBML document, or "" if the object does not exists.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumAllCompartmentGlyphs(SBMLDocument *document, int layoutIndex = 0)

Returns the number of CompartmentGlyphs of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

the number of CompartmentGlyphs of this Layout object, or 0 if the object is NULL

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumCompartmentGlyphs(SBMLDocument *document, const char *compartmentId, int layoutIndex = 0)

Returns the number of CompartmentGlyphs of the Layout object with the given index in the ListOfLayouts of the SBML document associated with the entered compartment id.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

  • compartmentId – the id of the compartment the number of CompartmentGlyph objects associated with it is going to be returned.

Returns:

the number of CompartmentGlyph objects associated with the entered compartment id, or 0 if the object is NULL or has no associated CompartmentGlyph objects

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isCompartmentGlyph(SBMLDocument *document, const char *compartmentId, int layoutIndex = 0)

Predicate returning true if the abstract GraphicalObject with the given id in the Layout object with the given index of the SBML document is of type CompartmentGlyph.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

  • id – the id of the GraphicalObject.

Returns:

true if this abstract GraphicalObject is of type CompartmentGlyph, false otherwise

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGraphicalObjectCompartmentId(SBMLDocument *document, const char *id, int graphicalObjectIndex, int layoutIndex)

@breif Returns the id of the compartment associated with the given GraphicalObject with the given id in the Layout object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the GraphicalObject.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the id of the compartment associated with the given GraphicalObject, or "" if the object does not exists.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumSpecies(SBMLDocument *document)

Returns the number of Species objects in the given SBML document.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the number of Species objects in the given SBML document.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesId(SBMLDocument *document, int speciesIndex)

Returns the id of the Species object wtih the given index in the given SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • speciesIndex – the index of the Species object.

Returns:

the id of the Species object wtih the given index in the given SBML document, or "" if the object does not exists.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumAllSpeciesGlyphs(SBMLDocument *document, int layoutIndex = 0)

Returns the number of SpeciesGlyphs of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

the number of SpeciesGlyphs of this Layout object, or 0 if the object is NULL

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumSpeciesGlyphs(SBMLDocument *document, const char *speciesId, int layoutIndex)

Returns the number of SpeciesGlyphs of the Layout object with the given index in the ListOfLayouts of the SBML document associated with the entered species id.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

  • speciesId – the id of the species the number of SpeciesGlyph objects associated with it is going to be returned.

Returns:

the number of SpeciesGlyph objects associated with the entered species id, or 0 if the object is NULL or has no associated SpeciesGlyph objects

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGlyphIndexInReactionGlyph(SBMLDocument *document, const char *speciesId, int speceisGlyphIndex, const char *reactionId, int reactionGlyphIndex = 0, int layoutIndex = 0)

Sets which index of SpeciesGlyph of the Species with the given id to be assigned to the ReactionGlyph with the given id and index in the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • speciesId – the id of the species the SpeciesGlyph object associated with it is going to be set.

  • speciesGlyphIndex – the index of the SpeciesGlyph object.

  • reactionId – the id of the reaction the SpeciesGlyph object is going to be associated with.

  • reactionGlyphIndex – the index of the ReactionGlyph object.

  • layoutIndex – the index number of the Layout to return.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGlyphIndex(SBMLDocument *document, const char *speciesId, const char *reactionId, int reactionGlyphIndex = 0, int layoutIndex = 0)

Returns the index of the SpeciesGlyph object among the list of SpeciesGlyph objects associated with the given species id that is associated with the given reaction id with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • a – pointer to the SBMLDocument object.

  • speciesId – the id of the species the index of the SpeciesGlyph object associated with it is going to be returned.

  • reactionId – the id of the reaction the SpeciesGlyph object is associated with.

  • reactionGlyphIndex – the index of the ReactionGlyph object.

  • layoutIndex – the index number of the Layout to return.

Returns:

the index of the SpeciesGlyph object among the list of SpeciesGlyph objects associated with the given species id that is associated with the given reaction id,

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumConnectedReactionsFor(SBMLDocument *document, const char *speciesId, int speciesGlyphIndex = 0, int layoutIndex = 0)

Returns the number of connected reactions for the SpeciesGlyph with the given species id and index in the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • speciesId – the id of the species the number of connected reactions is going to be returned.

  • speciesGlyphIndex – the index of the SpeciesGlyph object.

  • layoutIndex – the index number of the Layout to return.

Returns:

the number of connected reactions for the SpeciesGlyph with the given species id and index in the Layout object,

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getConnectedReactionsFor(SBMLDocument *document, const char *speciesId, int speciesGlyphIndex = 0, int index = 0, int layoutIndex = 0)

Returns the id of the connected reaction for the SpeciesGlyph with the given species id and index in the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • speciesId – the id of the species the id of the connected reaction is going to be returned.

  • speciesGlyphIndex – the index of the SpeciesGlyph object.

  • index – the index of the connected reaction.

  • layoutIndex – the index number of the Layout to return.

Returns:

the id of the connected reaction for the SpeciesGlyph with the given species id and index in the Layout object,

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSpeciesGlyph(SBMLDocument *document, const char *speciesId, int layoutIndex = 0)

Predicate returning true if the abstract GraphicalObject with the given id in the Layout object with the given index of the SBML document is of type SpeciesGlyph.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

  • id – the id of the GraphicalObject.

Returns:

true if this abstract GraphicalObject is of type SpeciesGlyph, false otherwise

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumReactions(SBMLDocument *document)

Returns the number of Reaction objects in the given SBML document.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the number of Reaction objects in the given SBML document.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionId(SBMLDocument *document, int reactionIndex)

Returns the id of the Reaction object with the given index in the given SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionIndex – the index of the Reaction object.

Returns:

the id of the Reaction object with the given index in the given SBML document, or "" if the object does not exists.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumAllReactionGlyphs(SBMLDocument *document, int layoutIndex = 0)

Returns the number of ReactionGlyphs of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

the number of ReactionGlyphs of this Layout object, or 0 if the object is NULL

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumReactionGlyphs(SBMLDocument *document, const char *reactionId, int layoutIndex)

Returns the number of ReactionGlyphs of the Layout object with the given index in the ListOfLayouts of the SBML document associated with the entered reaction id.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

  • reactionId – the id of the reaction the number of ReactionGlyph objects associated with it is going to be returned.

Returns:

the number of ReactionGlyph objects associated with the entered reaction id, or 0 if the object is NULL or has no associated ReactionGlyph objects

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isReactionGlyph(SBMLDocument *document, const char *reactionId, int layoutIndex = 0)

Predicate returning true if the abstract GraphicalObject with the given id in the Layout object with the given index of the SBML document is of type SpeciesGlyph.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

  • id – the id of the GraphicalObject.

Returns:

true if this abstract GraphicalObject is of type ReactionGlyph, false otherwise

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isReversible(SBMLDocument *document, const char *reactionId)

Predicate returning true if the Reaction object with the given id in the SBML document is reversible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction to check reversibility.

Returns:

true if the Reaction object with the given id is reversible, false otherwise

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumReactants(SBMLDocument *document, const char *reactionId)

Returns the number of Reactants of the Reaction object with the given id in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the number of Reactant objects associated with it is going to be returned.

Returns:

the number of Reactant objects of the Reaction object with the given id, or 0 if the object is NULL

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumProducts(SBMLDocument *document, const char *reactionId)

Returns the number of Products of the Reaction object with the given id in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the number of Product objects associated with it is going to be returned.

Returns:

the number of Product objects of the Reaction object with the given id, or 0 if the object is NULL

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumModifiers(SBMLDocument *document, const char *reactionId)

Returns the number of Modifiers of the Reaction object with the given id in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the number of Modifier objects associated with it is going to be returned.

Returns:

the number of Modifier objects of the Reaction object with the given id, or 0 if the object is NULL

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactantId(SBMLDocument *document, const char *reactionId, int reactantIndex)

Returns the id of Reactant object with the given index of the Reaction object with the given id in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the id of the Reactant object with the given index associated with it is going to be returned.

  • reactantIndex – the index of the Reactant object.

Returns:

the id of the Reactant object with the given index of the Reaction object with the given id, or "" if the object does not exists.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getProductId(SBMLDocument *document, const char *reactionId, int productIndex)

Returns the id of Product object with the given index of the Reaction object with the given id in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the id of the Product object with the givne index associated with it is going to be returned.

  • productIndex – the index of the Product object.

Returns:

the id of the Product object with the given index of the Reaction object with the given id, or "" if the object does not exists.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getModifierId(SBMLDocument *document, const char *reactionId, int modifierIndex)

Returns the id of Modifier object with the given index of the Reaction object with the given id in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the id of the Modifier object with the given index associated with it is going to be returned.

  • modifierIndex – the index of the Modifier object.

Returns:

the id of the Modifier object with the given index of the Reaction object with the given id, or "" if the object does not exists.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumSpeciesReferences(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int layoutIndex = 0)

Returns the number of SpeciesReference objects of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the number of SpeciesReference objects of its ReactionGlyph object with the given index associated with it is going to be returned.

  • reactionGlyphIndex – the index number of the ReactionGlyph object to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the number of SpeciesReference objects of the ReactionGlyph object with the given index associated with the entered reaction id, or 0 if the object is NULL or has no associated SpeciesReference objects.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceId(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the id of the SpeciesReference with the given index associated with the given reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the id of the SpeciesReference object with the given index associated with it is going to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

the id of the SpeciesReference with the givne index associated with the given reaction id, or "" if the object does not exists.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceSpeciesId(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the id of the species glyph associated with the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the number of SpeciesReference objects of its ReactionGlyph object with the given index associated with it is going to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

the id of the “species” attribute of the SpeciesReference object with the given index, or "" if the SpeciesReference does not exits or the object is NULL

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceSpeciesGlyphId(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the id of the species glyph associated with the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the number of SpeciesReference objects of its ReactionGlyph object with the given index associated with it is going to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

the value of the “speciesGlyph” attribute of the SpeciesReference object with the given index, or "" if the SpeciesReference does not exits or the object is NULL

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceEmptySpeciesGlyph(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex, int speciesReferenceIndex, int layoutIndex)

Predicate returning true if the SpeciesGlyph associated with the SpeciesReferenceGlyph with the given index in the given ReactionGlyph object with the given index associated with the entered reaction id is an empty SpeciesGlyph.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the number of SpeciesReference objects of its ReactionGlyph object with the given index associated with it is going to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the SpeciesGlyph associated with the SpeciesReferenceGlyph with the given index is an empty SpeciesGlyph, false otherwise.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceEmptySpeciesGlyphId(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex, int speciesReferenceIndex, int layoutIndex)

Returns the id of the empty species glyph associated with the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the number of SpeciesReference objects of its ReactionGlyph object with the given index associated with it is going to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

the id of the empty SpeciesGlyph associated with the SpeciesReference object with the given index, or "" if the SpeciesGlyph is not empty or the object is NULL

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceRole(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Predicates returning true if the “role” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the number of SpeciesReference objects of its ReactionGlyph object with the given index associated with it is going to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the “role” attribute of the SpeciesReference object with the given index is set, false if either the “role” attribute is not set or the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceRole(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the string representation of the “role” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the the Layout object with the givne index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the number of SpeciesReference objects of its ReactionGlyph object with the given index associated with it is going to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

the value of the “role” attribute of the SpeciesReference object with the given index, or "" if the SpeciesReference does not exits or the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceRole(SBMLDocument *document, const char *reactionId, const char *role, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Sets the value of the “role” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given id of the Layout object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the the ReactionGlyph objects of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • role – a string value to be set as “role” attribute of the SpeciesReference object.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumSpeciesReferenceAssociatedWithSpecies(SBMLDocument *document, const char *speciesId, const char *reactionId, int reactionGlyphIndex = 0, int layoutIndex = 0)

Returns the number of SpeciesReference objects of the ReactionGlyph with the given index associated with the entered species id in the of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • speciesId – the id of the species the number of SpeciesReference objects of its ReactionGlyph object with the given index associated with it is going to be returned.

  • layoutIndex – the index number of the Layout to return.

Returns:

the number of SpeciesReference objects of the ReactionGlyph object with the given index associated with the entered species id, or 0 if the object is NULL or has no associated SpeciesReference objects.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceIndexAssociatedWithSpecies(SBMLDocument *document, const char *speciesId, const char *reactionId, int reactionGlyphIndex = 0, int n = 0, int layoutIndex = 0)

Returns the index of the SpeciesReference object with the given index associated with the given species id in the ReactionGlyph object with the given index associated with the entered reaction id in the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • speciesId – the id of the species the index of the SpeciesReference object associated with it is going to be returned.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • n – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

the index of the SpeciesReference object with the given index associated with the given species id, or -1 if the object does not exists.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumSpeciesReferenceCurveSegments(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the number of curve segments of the Curve object of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the number of SpeciesReference objects of its ReactionGlyph object with the given index associated with it is going to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

the number of curve segments of the Curve object of the SpeciesReference object with the given index, or 0 if the SpeciesReference object does not exits or the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_addSpeciesReferenceLineCurveSegment(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Adds a LineSegment to the Curve object of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_addSpeciesReferenceCubicBezierCurveSegment(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Adds a CubicBezier to the Curve object of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_removeSpeciesReferenceCurveSegment(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Removes the curve segment with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSpeciesReferenceCurveSegmentCubicBezier(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex, int speciesReferenceIndex, int curveSegmentIndex, int layoutIndex)

@breif Predicate returning true if the curve segment with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts is of type CubicBezier.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the curve segment with the given index is of type CubicBezier, false otherwise

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_convertSpeciesReferenceCurveSegmentToLine(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex, int speciesReferenceIndex, int curveSegmentIndex, int layoutIndex)

@breif Converts the curve segment with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts to a LineSegment.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_convertSpeciesReferenceCurveSegmentToCubicBezier(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex, int speciesReferenceIndex, int curveSegmentIndex, int layoutIndex)

@breif Converts the curve segment with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts to a CubicBezier.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceCurveSegmentStartPointX(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Returns the value of the “x” attribute of the start point of the CubicBezier object with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

Returns:

the value of the “x” attribute of the start point of the CubicBezier object with the given index, or 0 if the SpeciesReference object does not exits or the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceCurveSegmentStartPointX(SBMLDocument *document, const char *reactionId, const double x, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of the start point of the CubicBezier object with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

  • x – the value to be set as “x” attribute of the start point of the CubicBezier object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceCurveSegmentStartPointY(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Returns the value of the “y” attribute of the start point of the CubicBezier object with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

Returns:

the value of the “y” attribute of the start point of the CubicBezier object with the given index, or 0 if the SpeciesReference object does not exits or the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceCurveSegmentStartPointY(SBMLDocument *document, const char *reactionId, const double y, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of the start point of the CubicBezier object with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

  • y – the value to be set as “y” attribute of the start point of the CubicBezier object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceCurveSegmentEndPointX(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Returns the value of the “x” attribute of the end point of the CubicBezier object with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

Returns:

the value of the “x” attribute of the end point of the CubicBezier object with the given index, or 0 if the SpeciesReference object does not exits or the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceCurveSegmentEndPointX(SBMLDocument *document, const char *reactionId, const double x, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of the end point of the CubicBezier object with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

  • x – the value to be set as “x” attribute of the end point of the CubicBezier object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceCurveSegmentEndPointY(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Returns the value of the “y” attribute of the end point of the CubicBezier object with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

Returns:

the value of the “y” attribute of the end point of the CubicBezier object with the given index, or 0 if the SpeciesReference object does not exits or the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceCurveSegmentEndPointY(SBMLDocument *document, const char *reactionId, const double y, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of the end point of the CubicBezier object with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

  • y – the value to be set as “y” attribute of the end point of the CubicBezier object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceCurveSegmentBasePoint1X(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Returns the value of the “x” attribute of the base point 1 of the CubicBezier object with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

Returns:

the value of the “x” attribute of the base point 1 of the CubicBezier object with the given index, or 0 if the SpeciesReference object does not exits or the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceCurveSegmentBasePoint1X(SBMLDocument *document, const char *reactionId, const double x, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of the base point 1 of the CubicBezier object with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

  • x – the value to be set as “x” attribute of the base point 1 of the CubicBezier object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceCurveSegmentBasePoint1Y(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Returns the value of the “y” attribute of the base point 1 of the CubicBezier object with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

Returns:

the value of the “y” attribute of the base point 1 of the CubicBezier object with the given index, or 0 if the SpeciesReference object does not exits or the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceCurveSegmentBasePoint1Y(SBMLDocument *document, const char *reactionId, const double y, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of the base point 1 of the CubicBezier object with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

  • y – the value to be set as “y” attribute of the base point 1 of the CubicBezier object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceCurveSegmentBasePoint2X(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Returns the value of the “x” attribute of the base point 2 of the CubicBezier object with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

Returns:

the value of the “x” attribute of the base point 2 of the CubicBezier object with the given index, or 0 if the SpeciesReference object does not exits or the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceCurveSegmentBasePoint2X(SBMLDocument *document, const char *reactionId, const double x, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of the base point 2 of the CubicBezier object with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

  • x – the value to be set as “x” attribute of the base point 2 of the CubicBezier object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceCurveSegmentBasePoint2Y(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Returns the value of the “y” attribute of the base point 2 of the CubicBezier object with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

Returns:

the value of the “y” attribute of the base point 2 of the CubicBezier object with the given index, or 0 if the SpeciesReference object does not exits or the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceCurveSegmentBasePoint2Y(SBMLDocument *document, const char *reactionId, const double y, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of the base point 2 of the CubicBezier object with the given index of the Curve of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • curveSegmentIndex – the index of the CurveSegment.

  • layoutIndex – the index number of the Layout to return.

  • y – the value to be set as “y” attribute of the base point 2 of the CubicBezier object.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_makeSpeciesReferenceVisible(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex, int speciesReferenceIndex, int layoutIndex)

Make the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id visible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_makeSpeciesReferenceInvisible(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex, int speciesReferenceIndex, int layoutIndex)

Make the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id invisible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSpeciesReferenceVisible(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex, int speciesReferenceIndex, int layoutIndex)

Predicates returning true if the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document is visible.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the SpeciesReference object with the given index is visible, false otherwise

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineColor(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Predicates returning true if the “stroke” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the “stroke” attribute of the SpeciesReference object with the given index is set, false if either the “stroke” attribute is not set or the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineColor(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the value of the “stroke” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

the value of the “stroke” attribute of the SpeciesReference object with the given index, or "" if the SpeciesReference does not exits or the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineColor(SBMLDocument *document, const char *reactionId, const char *lineColor, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Sets the value of the “stroke” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • lineColor – a string value to be set as “stroke” attribute of the SpeciesReference object.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineWidth(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Predicates returning true if the “stroke-width” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the “stroke-width” attribute of the SpeciesReference object with the given index is set, false if either the “stroke-width” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineWidth(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the value of the “stroke-width” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

the value of the “stroke-width” attribute of the SpeciesReference object with the given index, or "" if the SpeciesReference does not exits or the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineWidth(SBMLDocument *document, const char *reactionId, const double lineWidth, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Sets the value of the “stroke-width” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • lineWidth – a double value to be set as “stroke-width” attribute of the SpeciesReference object.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumSpeciesReferenceLineDashes(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the size of the “stroke-dasharray” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

the size of the “stroke-dasharray” attribute of the RenderGroup of the Style for this GraphicalObject object, or "" if the object is NULL

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineDash(SBMLDocument *document, const char *reactionId, int lineDashIndex, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the dash at the given index of the “stroke-dasharray” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document at the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • lineDashIndex – the index of the “stroke-dasharray” attribute of the SpeciesReference object.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

the value of the “stroke-dasharray” attribute of the SpeciesReference object with the given index, or "" if the SpeciesReference does not exits or the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineDash(SBMLDocument *document, const char *reactionId, const int lineDash, int lineDashIndex, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Sets the dash at the given index of the “stroke-dasharray” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document at the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • lineDash – a string value to be set as “stroke-dasharray” attribute of the SpeciesReference object.

  • lineDashIndex – the index of the “stroke-dasharray” attribute of the SpeciesReference object.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceStartHead(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Predicates returning true if the “startHead” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the “startHead” attribute of the SpeciesReference object with the given index is set, false if either the “startHead” attribute is not set or the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceStartHead(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the value of the “startHead” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

the value of the “startHead” attribute of the SpeciesReference object with the given index, or "" if the SpeciesReference does not exits or the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceStartHead(SBMLDocument *document, const char *reactionId, const char *startHead, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Sets the value of the “startHead” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • startHead – a string value to be set as “startHead” attribute of the SpeciesReference object.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceEndHead(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Predicates returning true if the “endHead” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the “endHead” attribute of the SpeciesReference object with the given index is set, false if either the “endHead” attribute is not set or the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceEndHead(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the value of the “endHead” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

the value of the “endHead” attribute of the SpeciesReference object with the given index, or "" if the SpeciesReference does not exits or the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceEndHead(SBMLDocument *document, const char *reactionId, const char *endHead, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Sets the value of the “endHead” attribute of the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction the SpeciesReference object of which to be returned.

  • endHead – a string value to be set as “endHead” attribute of the SpeciesReference object.

  • reactionGlyphIndex – the index of the ReactionGlyph.

  • speciesReferenceIndex – the index of the SpeciesReference.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumAllTextGlyphs(SBMLDocument *document, int layoutIndex = 0)

Returns the number of TextGlyphs of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

the number of TextGlyphs of this Layout object, or 0 if the object is NULL

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumTextGlyphs(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the number of TextGlyph objects associated with entered id of the Layout object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the TextGlyph objects associated with it to be returned.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the number of the TextGlyph objects associated with entered id of the Layout object, or 0 if the object is NULL

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getText(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Returns the “text” attribute of the TextGlyph object with the given index associated with the given id in the Layout object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the TextGlyph objects associated with it to be returned.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “text” attribute of this TextGlyph object or empty string if either the “text” attribute is not set , TextGlyph does not exits or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setText(SBMLDocument *document, const char *id, const char *text, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Sets the “text” attribute of the TextGlyph object with the given index associated with the given id in the Layout object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the TextGlyph objects associated with it to be returned.

  • text – a string value to be set as “text” attribute of the TextGlyph object.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_addText(SBMLDocument *document, const char *id, const char *text, int graphicalObjectIndex = 0, int layoutIndex = 0)

Adds a new TextGlyph object associated with the graphical object with the given index of the model entity with the given id in the Layout object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the TextGlyph object to be added.

  • text – a string value to be set as “text” attribute of the TextGlyph object.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_removeText(SBMLDocument *document, const char *id, int graphicalObjectIndex, int textGlyphIndex = 0, int layoutIndex = 0)

Removes the TextGlyph object with the given index associated with the graphical object with the given index of the model entity with the given id in the Layout object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the TextGlyph object to be removed.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumAllIndependentTextGlyphs(SBMLDocument *document, int layoutIndex = 0)

Returns the number of independent text glyphs of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

the number of independent text glyphs of this Layout object, or 0 if the object is NULL

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getIndependentTextGlyphId(SBMLDocument *document, int independentTextGlyphIndex, int layoutIndex = 0)

Returns the id of the independent text glyph with the given index of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • independentTextGlyphIndex – the index of the independent text glyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the id of the independent text glyph with the given index, or NULL if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_addIndependentTextGlyph(SBMLDocument *document, const char *text, double x, double y, double width, double height, int layoutIndex = 0)

Adds a new independent text glyph to the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • text – the displayed text of the independent text glyph

  • x – the x position of the independent text glyph

  • y – the y position of the independent text glyph

  • width – the width dimension of the independent text glyph

  • height – the height position of the independent text glyph

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_removeIndependentTextGlyph(SBMLDocument *document, int independentTextGlyphIndex, int layoutIndex = 0)

Removes the independent text glyph with the given index of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • independentTextGlyphIndex – the index of the independent text glyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumAllAdditionalGraphicalObjects(SBMLDocument *document, int layoutIndex = 0)

Returns the number of additional graphical objects of the Layout object with the given index in the ListOfLayouts of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

the number of additional graphical objects of this Layout object, or 0 if the object is NULL

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getAdditionalGraphicalObjectId(SBMLDocument *document, int additionalGraphicalObjectIndex = 0, int layoutIndex = 0)

Returns the id of the additional graphical object with the given index of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • additionalGraphicalObjectIndex – the index of the additional graphical object to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the id of the additional graphical object with the given index, or NULL if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_addAdditionalGraphicalObject(SBMLDocument *document, const char *id, int layoutIndex = 0)

Adds a new additional graphical object to the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the additional graphical object to be added.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_removeAdditionalGraphicalObject(SBMLDocument *document, int additionalGraphicalObjectIndex, int layoutIndex = 0)

Removes the additional graphical object with the given index of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • additionalGraphicalObjectIndex – the index of the additional graphical object to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getX(SBMLDocument *document, const char *id, const int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “x” attribute of the bounding box of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “x” attribute of the bounding box of the GraphicalObject object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setX(SBMLDocument *document, const char *id, const double x, const int graphicalObjectIndex = 0, int layoutIndex = 0, bool updateCurves = true)

Sets the value of the “x” attribute of the bounding box of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • x – a double value to be set as “x” attribute of the bounding box of the GraphicalObject object.

  • layoutIndex – the index number of the Layout to return.

  • updateCurves – a boolean value to indicate whether the function should update the curves after setting the value.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getY(SBMLDocument *document, const char *id, const int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “y” attribute of the bounding box of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “y” attribute of the bounding box of the GraphicalObject object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setY(SBMLDocument *document, const char *id, const double y, const int graphicalObjectIndex = 0, int layoutIndex = 0, bool updateCurves = true)

Sets the value of the “y” attribute of the bounding box of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • y – a double value to be set as “y” attribute of the bounding box of the GraphicalObject object.

  • layoutIndex – the index number of the Layout to return.

  • updateCurves – a boolean value to indicate whether the function should update the curves after setting the value.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setPosition(SBMLDocument *document, const char *id, const double x, const double y, const int graphicalObjectIndex = 0, int layoutIndex = 0, bool updateCurves = true)

Sets the values of the “x” and “y” attributes of the bounding box of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • x – a double value to be set as “x” attribute of the bounding box of the GraphicalObject object.

  • y – a double value to be set as “y” attribute of the bounding box of the GraphicalObject object.

  • layoutIndex – the index number of the Layout to return.

  • updateCurves – a boolean value to indicate whether the function should update the curves after setting the value.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getWidth(SBMLDocument *document, const char *id, const int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “width” attribute of the bounding box of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “width” attribute of the bounding box of the GraphicalObject object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setWidth(SBMLDocument *document, const char *id, const double width, const int graphicalObjectIndex = 0, int layoutIndex = 0, bool updateCurves = true)

Sets the value of the “width” attribute of the bounding box of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • width – a double value to be set as “width” attribute of the bounding box of the GraphicalObject object.

  • layoutIndex – the index number of the Layout to return.

  • updateCurves – a boolean value to indicate whether the function should update the curves after setting the value.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsWidth(SBMLDocument *document, const double width, int layoutIndex = 0, bool updateCurves = true)

Sets the values of the “width” attribute of the bounding box of all the Compartments of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • width – a double value to be set as “width” attribute of the bounding box of the Compartments object.

  • layoutIndex – the index number of the Layout to return.

  • updateCurves – a boolean value to indicate whether the function should update the curves after setting the value.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesWidth()

Returns the default value of the “width” attribute of the bounding box of the SpeciesGlyph objects.

Returns:

the default value of the “width” attribute of the bounding box of the SpeciesGlyph objects.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesWidth(SBMLDocument *document, const double width, int layoutIndex = 0, bool updateCurves = true)

Sets the values of the “width” attribute of the bounding box of all the Species of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • width – a double value to be set as “width” attribute of the bounding box of the Species object.

  • layoutIndex – the index number of the Layout to return.

  • updateCurves – a boolean value to indicate whether the function should update the curves after setting the value.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsWidth()

Returns the default value of the “width” attribute of the bounding box of the ReactionGlyph objects.

Returns:

the default value of the “width” attribute of the bounding box of the ReactionGlyph objects.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsWidth(SBMLDocument *document, const double width, int layoutIndex = 0, bool updateCurves = true)

Sets the values of the “width” attribute of the bounding box of all the Reactions of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • width – a double value to be set as “width” attribute of the bounding box of the Reactions object.

  • layoutIndex – the index number of the Layout to return.

  • updateCurves – a boolean value to indicate whether the function should update the curves after setting the value.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getHeight(SBMLDocument *document, const char *id, const int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “height” attribute of the bounding box of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “height” attribute of the bounding box of the GraphicalObject object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setHeight(SBMLDocument *document, const char *id, const double height, const int graphicalObjectIndex = 0, int layoutIndex = 0, bool updateCurves = true)

Sets the value of the “height” attribute of the bounding box of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • height – a double value to be set as “height” attribute of the bounding box of the GraphicalObject object.

  • layoutIndex – the index number of the Layout to return.

  • updateCurves – a boolean value to indicate whether the function should update the curves after setting the value.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsHeight(SBMLDocument *document, const double height, int layoutIndex = 0, bool updateCurves = true)

Sets the values of the “height” attribute of the bounding box of all the Compartments of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • height – a double value to be set as “height” attribute of the bounding box of the Compartments object.

  • layoutIndex – the index number of the Layout to return.

  • updateCurves – a boolean value to indicate whether the function should update the curves after setting the value.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesHeight()

Returns the default value of the “height” attribute of the bounding box of the SpeciesGlyph objects.

Returns:

the default value of the “height” attribute of the bounding box of the SpeciesGlyph objects.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesHeight(SBMLDocument *document, const double height, int layoutIndex = 0, bool updateCurves = true)

Sets the values of the “height” attribute of the bounding box of all the Species of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • height – a double value to be set as “height” attribute of the bounding box of the Species object.

  • layoutIndex – the index number of the Layout to return.

  • updateCurves – a boolean value to indicate whether the function should update the curves after setting the value.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsHeight()

Returns the default value of the “height” attribute of the bounding box of the ReactionGlyph objects.

Returns:

the default value of the “height” attribute of the bounding box of the ReactionGlyph objects.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsHeight(SBMLDocument *document, const double height, int layoutIndex = 0, bool updateCurves = true)

Sets the values of the “height” attribute of the bounding box of all the Reactions of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • height – a double value to be set as “height” attribute of the bounding box of the Reactions object.

  • layoutIndex – the index number of the Layout to return.

  • updateCurves – a boolean value to indicate whether the function should update the curves after setting the value.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getTextX(SBMLDocument *document, const char *id, const int graphicalObjectIndex, const int textGlyphIndex, int layoutIndex)

Returns the value of the “x” attribute of the bounding box of the TextGlyph object with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the TextGlyph object associated with it to be returned.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “x” attribute of the bounding box of the TextGlyph object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setTextX(SBMLDocument *document, const char *id, const double x, const int graphicalObjectIndex, const int textGlyphIndex, int layoutIndex)

Sets the value of the “x” attribute of the bounding box of the TextGlyph object with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the TextGlyph object associated with it to be returned.

  • x – a double value to be set as “x” attribute of the bounding box of the TextGlyph object.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getTextY(SBMLDocument *document, const char *id, const int graphicalObjectIndex, const int textGlyphIndex, int layoutIndex)

Returns the value of the “y” attribute of the bounding box of the TextGlyph object with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the TextGlyph object associated with it to be returned.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “y” attribute of the bounding box of the TextGlyph object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setTextY(SBMLDocument *document, const char *id, const double y, const int graphicalObjectIndex, const int textGlyphIndex, int layoutIndex)

Sets the value of the “y” attribute of the bounding box of the TextGlyph object with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the TextGlyph object associated with it to be returned.

  • y – a double value to be set as “y” attribute of the bounding box of the TextGlyph object.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setTextPosition(SBMLDocument *document, const char *id, const double x, const double y, const int graphicalObjectIndex, const int textGlyphIndex, int layoutIndex)

brief Sets the value of “x” and “y” attribute of the bounding box of the TextGlyph object with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the TextGlyph object associated with it to be returned.

  • x – a double value to be set as “x” attribute of the bounding box of the TextGlyph object.

  • y – a double value to be set as “y” attribute of the bounding box of the TextGlyph object.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getTextWidth(SBMLDocument *document, const char *id, const int graphicalObjectIndex, const int textGlyphIndex, int layoutIndex)

Returns the value of the “width” attribute of the bounding box of the TextGlyph object with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the TextGlyph object associated with it to be returned.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “width” attribute of the bounding box of the TextGlyph object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setTextWidth(SBMLDocument *document, const char *id, const double width, const int graphicalObjectIndex, const int textGlyphIndex, int layoutIndex)

Sets the value of the “width” attribute of the bounding box of the TextGlyph object with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the TextGlyph object associated with it to be returned.

  • width – a double value to be set as “width” attribute of the bounding box of the TextGlyph object.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getTextHeight(SBMLDocument *document, const char *id, const int graphicalObjectIndex, const int textGlyphIndex, int layoutIndex)

Returns the value of the “height” attribute of the bounding box of the TextGlyph object with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the TextGlyph object associated with it to be returned.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “height” attribute of the bounding box of the TextGlyph object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setTextHeight(SBMLDocument *document, const char *id, const double height, const int graphicalObjectIndex, const int textGlyphIndex, int layoutIndex)

Sets the value of the “height” attribute of the bounding box of the TextGlyph object with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the TextGlyph object associated with it to be returned.

  • height – a double value to be set as “height” attribute of the bounding box of the TextGlyph object.

  • graphicalObjectIndex – the index number of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetCurve(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicate returning true if the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document has a Curve object and the curve consists of one or more segments.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the GraphicalObject has a Curve object and the curve consists of one or more segments, false otherwise

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumCurveSegments(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the number of curve segments of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

Returns:

the number of curve segments of the curve of the GraphicalObject object, or 0 if the object is NULL or does not have a curve

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_addLineCurveSegment(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Adds a LineSemgent to the Curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_addCubicBezierCurveSegment(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Adds a CubicBezier to the Curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_removeCurveSegment(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Removes the curve segment with the given index of the Curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment to remove.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isCurveSegmentCubicBezier(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Predicate returning true if the curve segment with the given index of the Curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document is of type CubicBezier.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if this curve segment is of type CubicBezier, false otherwise

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCurveSegmentStartPointX(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Returns the value of the “x” attribute of the start point of the curve segment with the given index of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment to retrieve.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “x” attribute of the start point of the the curve segment with the given index of the curve of this GraphicalObject object, or 0.0 if the object is NULL or does not have a curve

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCurveSegmentStartPointX(SBMLDocument *document, const char *id, const double x, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of the start point of the curve segment with the given index of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • x – a double value to be set as “x” attribute of the start point of the curve segment of the curve of the GraphicalObject object.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment to retrieve.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCurveSegmentStartPointY(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Returns the value of the “y” attribute of the start point of the curve segment with the given index of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment to retrieve.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “y” attribute of the start point of the the curve segment with the given index of the curve of this GraphicalObject object, or 0.0 if the object is NULL or does not have a curve

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCurveSegmentStartPointY(SBMLDocument *document, const char *id, const double y, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of the start point of the curve segment with the given index of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • y – a double value to be set as “y” attribute of the start point of the curve segment of the curve of the GraphicalObject object.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment to retrieve.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCurveSegmentEndPointX(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Returns the value of the “x” attribute of the end point of the curve segment with the given index of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment to retrieve.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “x” attribute of the end point of the the curve segment with the given index of the curve of this GraphicalObject object, or 0.0 if the object is NULL or does not have a curve

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCurveSegmentEndPointX(SBMLDocument *document, const char *id, const double x, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of the end point of the curve segment with the given index of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • x – a double value to be set as “x” attribute of the end point of the curve segment of the curve of the GraphicalObject object.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment to retrieve.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCurveSegmentEndPointY(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Returns the value of the “y” attribute of the end point of the curve segment with the given index of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment to retrieve.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “y” attribute of the end point of the the curve segment with the given index of the curve of this GraphicalObject object, or 0.0 if the object is NULL or does not have a curve

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCurveSegmentEndPointY(SBMLDocument *document, const char *id, const double y, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of the end point of the curve segment with the given index of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • y – a double value to be set as “y” attribute of the end point of the curve segment of the curve of the GraphicalObject object.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment to retrieve.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCurveSegmentBasePoint1X(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Returns the value of the “x” attribute of the base point 1 of the curve segment with the given index of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment to retrieve.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “x” attribute of the base point 1 of the the curve segment with the given index of the curve of this GraphicalObject object, or 0.0 if the object is NULL or does not have a curve

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCurveSegmentBasePoint1X(SBMLDocument *document, const char *id, const double x, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of the base point 1 of the curve segment with the given index of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • x – a double value to be set as “x” attribute of the base point 1 of the curve segment of the curve of the GraphicalObject object.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment to retrieve.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCurveSegmentBasePoint1Y(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Returns the value of the “y” attribute of the base point 1 of the curve segment with the given index of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment to retrieve.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “y” attribute of the base point 1 of the the curve segment with the given index of the curve of this GraphicalObject object, or 0.0 if the object is NULL or does not have a curve

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCurveSegmentBasePoint1Y(SBMLDocument *document, const char *id, const double y, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of the base point 1 of the curve segment with the given index of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • y – a double value to be set as “y” attribute of the base point 1 of the curve segment of the curve of the GraphicalObject object.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment to retrieve.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCurveSegmentBasePoint2X(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Returns the value of the “x” attribute of the base point 2 of the curve segment with the given index of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment to retrieve.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “x” attribute of the base point 2 of the the curve segment with the given index of the curve of this GraphicalObject object, or 0.0 if the object is NULL or does not have a curve

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCurveSegmentBasePoint2X(SBMLDocument *document, const char *id, const double x, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of the base point 2 of the curve segment with the given index of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • x – a double value to be set as “x” attribute of the base point 2 of the curve segment of the curve of the GraphicalObject object.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment to retrieve.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCurveSegmentBasePoint2Y(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Returns the value of the “y” attribute of the base point 2 of the curve segment with the given index of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment to retrieve.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “y” attribute of the base point 2 of the the curve segment with the given index of the curve of this GraphicalObject object, or 0.0 if the object is NULL or does not have a curve

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCurveSegmentBasePoint2Y(SBMLDocument *document, const char *id, const double y, int graphicalObjectIndex = 0, int curveSegmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of the base point 2 of the curve segment with the given index of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object with the given index in the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the model entity the GraphicalObject object associated with it to be returned.

  • y – a double value to be set as “y” attribute of the base point 2 of the curve segment of the curve of the GraphicalObject object.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • curveSegmentIndex – an int representing the index of the curve segment to retrieve.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumGlobalRenderInformation(SBMLDocument *document)

Returns the number of items in the ListOfGlobalRenderInformation of the SBML document.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the number of items in the ListOfGlobalRenderInformation of the SBML document, or 0 if the object is NULL

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumLocalRenderInformation(SBMLDocument *document, int layoutIndex = 0)

Returns the number of items in the ListOfGlobalRenderInformation of the Layout object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout object.

Returns:

the number of items in the ListOfGlobalRenderInformation of this Layout object, or 0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_removeRenderInformation(SBMLDocument *document)

Remove all the global and local render information objects from the list of global renders of the SBML document.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_removeGlobalRenderInformation(SBMLDocument *document)

Remove all the global render information objects from the list of global renders of the SBML document.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_removeLocalRenderInformation(SBMLDocument *document, int layoutIndex = 0)

Remove all the local render information objects from the list of local renders of the Layout with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout object.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_createDefaultGlobalRenderInformation(SBMLDocument *document)

Create a GlobalRenderInformation object, add it to list of global renders of the SBML document, and set all the necessary features for it.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_createDefaultLocalRenderInformation(SBMLDocument *document)

Create a LocalRenderInformation object, add it to list of local renders of the Layout of the SBML document, and set all the necessary features for it.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetBackgroundColor(SBMLDocument *document, int renderIndex = 0)

Predicates returning true if the “backgroundColor” attribute of the GlobalRenderInformation object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • renderIndex – the index number of the GlobalRenderInformation object.

Returns:

true if the “backgroundColor” attribute of this GlobalRenderInformation object is set, false if either the “backgroundColor” attribute is not set or the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getBackgroundColor(SBMLDocument *document, int renderIndex = 0)

Returns the value of the “backgroundColor” attribute of the GlobalRenderInformation object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • renderIndex – the index number of the GlobalRenderInformation object.

Returns:

the “backgroundColor” attribute of this RenderInformationBase object, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setBackgroundColor(SBMLDocument *document, const char *backgroundColor, int renderIndex = 0)

Sets the value of the “backgroundColor” attribute of the GlobalRenderInformation object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • backgroundColor – a string value to use as the value of the “backgroundColor” attribute of this RenderInformationBase object.

  • renderIndex – the index number of the GlobalRenderInformation object.

Returns:

integer value indicating success/failure of the function.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumColors(SBMLDocument *document, int renderIndex = 0)

Returns the number of ColorDefinitions of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the number of ColorDefinitions of this RenderInformationBase object, or 0 if the object is NULL

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumGlobalColors(SBMLDocument *document, int renderIndex)

Returns the number of ColorDefinitions of the GlobalRenderInformation object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • renderIndex – the index number of the GlobalRenderInformation object.

Returns:

the number of ColorDefinitions of this GlobalRenderInformation object, or 0 if the object is NULL

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumLocalColors(SBMLDocument *document, int renderIndex)

Returns the number of ColorDefinitions of the LocalRenderInformation object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • renderIndex – the index number of the LocalRenderInformation object.

Returns:

the number of ColorDefinitions of this LocalRenderInformation object, or 0 if the object is NULL

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGlobalColorId(SBMLDocument *document, int colorIndex, int renderIndex = 0)

Returns the id of the Global ColorDefinition object with the given index in the given SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • colorIndex – the index of the ColorDefinition to return.

  • renderIndex – the index number of the GlobalRenderInformation object.

Returns:

the id of the ColorDefinition object with the given index, or "" if the object is NULL

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLocalColorId(SBMLDocument *document, int colorIndex, int renderIndex = 0)

Returns the id of the Local ColorDefinition object with the given index in the given SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • colorIndex – the index of the ColorDefinition to return.

  • renderIndex – the index number of the LocalRenderInformation object.

Returns:

the id of the ColorDefinition object with the given index, or "" if the object is NULL

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetColorValue(SBMLDocument *document, const char *id, int renderIndex = 0)

Predicates returning true if the “value” attribute of the ColorDefinition with the given identifier in the RenderInformationBase with the given index is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the ColorDefinition to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “value” attribute of this ColorDefinition object is set, false if either the “value” attribute is not set or the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getColorValue(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “value” attribute of the ColorDefinition with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the ColorDefinition to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “value” attribute of the ColorDefinition object, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setColorValue(SBMLDocument *document, const char *id, const char *value, int renderIndex)

Sets the value of the “value” attribute of the ColorDefinition with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the ColorDefinition to retrieve.

  • value – a string value to use as the value of the “value” attribute of this ColorDefinition object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumGradients(SBMLDocument *document, int renderIndex = 0)

Returns the number of GradientDefinitions of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the number of GradientDefinitions of this RenderInformationBase object, or 0 if the object is NULL

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumGlobalGradients(SBMLDocument *document, int renderIndex = 0)

Returns the number of GradientDefinitions of the GlobalRenderInformation object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • renderIndex – the index number of the GlobalRenderInformation object.

Returns:

the number of GradientDefinitions of this GlobalRenderInformation object, or 0 if the object is NULL

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumLocalGradients(SBMLDocument *document, int renderIndex = 0)

Returns the number of GradientDefinitions of the LocalRenderInformation object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • renderIndex – the index number of the LocalRenderInformation object.

Returns:

the number of GradientDefinitions of this LocalRenderInformation object, or 0 if the object is NULL

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGlobalGradientId(SBMLDocument *document, int gradientIndex, int renderIndex = 0)

Returns the id of the GradientDefinition object with the given index in the given SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • gradientIndex – the index of the GradientDefinition to return.

  • renderIndex – the index number of the GlobalRenderInformation object.

Returns:

the id of the GradientDefinition object with the given index, or "" if the object is NULL

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLocalGradientId(SBMLDocument *document, int gradientIndex, int renderIndex = 0)

Returns the id of the GradientDefinition object with the given index in the given SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • gradientIndex – the index of the GradientDefinition to return.

  • renderIndex – the index number of the LocalRenderInformation object.

Returns:

the id of the GradientDefinition object with the given index, or "" if the object is NULL

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isLinearGradient(SBMLDocument *document, const char *id, int renderIndex = 0)

Predicate returning true if the GradientDefinition with the given identifier in the RenderInformationBase with the given index is of type LinearGradient.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the GradientDefinition to retrieve.

Returns:

true if this GradientBase is of type LinearGradient, false otherwise

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isRadialGradient(SBMLDocument *document, const char *id, int renderIndex = 0)

Predicate returning true if the GradientDefinition with the given identifier in the RenderInformationBase with the given index is of type RadialGradient.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the GradientDefinition to retrieve.

Returns:

true if this GradientBase is of type RadialGradient, false otherwise

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpreadMethod(SBMLDocument *document, const char *id, int renderIndex = 0)

Predicates returning true if the “spreadMethod” attribute of the GradientDefinition with the given identifier in the RenderInformationBase with the given index is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the GradientDefinition to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “spreadMethod” attribute of this GradientDefinition object is set, false if either the “spreadMethod”

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpreadMethod(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “spreadMethod” attribute of the GradientDefinition with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the GradientDefinition to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “spreadMethod” attribute of the GradientDefinition object, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpreadMethod(SBMLDocument *document, const char *id, const char *spreadMethod, int renderIndex = 0)

Sets the value of the “spreadMethod” attribute of the GradientDefinition with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the GradientDefinition to retrieve.

  • spreadMethod – a string value to use as the value of the “spreadMethod” attribute of this GradientDefinition object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumGradientStops(SBMLDocument *document, const char *id, int renderIndex)

@breif Returns the number of GradientStop objects of the GradientDefinition with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the GradientDefinition to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the number of GradientStop objects of this GradientDefinition object, or 0 if the object is NULL

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetOffset(SBMLDocument *document, const char *id, int gradientStopIndex = 0, int renderIndex = 0)

Predicates returning true if the “offset” attribute of the GradientStop with the given index of the GradientDefinition with the given identifier in the RenderInformationBase with the given index is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the GradientDefinition to retrieve.

  • gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “offset” attribute of the GradientStop with the given index of this GradientBase object is set, false if either the “offset” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getOffset(SBMLDocument *document, const char *id, int gradientStopIndex = 0, int renderIndex = 0)

Returns the value of the “offset” attribute of the GradientStop with the given index of the GradientDefinition with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the GradientDefinition to retrieve.

  • gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “offset” attribute of the GradientStop object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setOffset(SBMLDocument *document, const char *id, const double offset, int gradientStopIndex = 0, int renderIndex = 0)

Sets the value of the “offset” attribute of the GradientStop with the given index of the GradientDefinition with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the GradientDefinition to retrieve.

  • offset – a double value (between 0 to 100) to be set as “offset” attribute of the GradientStop object.

  • gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetStopColor(SBMLDocument *document, const char *id, int gradientStopIndex = 0, int renderIndex = 0)

Predicates returning true if the “stop-color” attribute of the GradientStop with the given index of the GradientDefinition with the given identifier in the RenderInformationBase with the given index is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the GradientDefinition to retrieve.

  • gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “stop-color” attribute of the GradientStop with the given index of this GradientBase object is set, false if either the “stop-color” attribute is not set or the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getStopColor(SBMLDocument *document, const char *id, int gradientStopIndex = 0, int renderIndex = 0)

Returns the value of the “stop-color” attribute of the GradientStop with the given index of the GradientDefinition with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the GradientDefinition to retrieve.

  • gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “stop-color” attribute of the GradientStop object, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setStopColor(SBMLDocument *document, const char *id, const char *stopColor, int gradientStopIndex = 0, int renderIndex = 0)

Sets the value of the “stop-color” attribute of the GradientStop with the given index of the GradientDefinition with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the GradientDefinition to retrieve.

  • stopColor – a string value to use as the value of the “stop-color” attribute of the GradientStop object.

  • gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLinearGradientX1(SBMLDocument *document, const char *id, int renderIndex = 0)

Predicates returning true if the “x1” attribute of the GradientDefinition with the given identifier in the RenderInformationBase with the given index is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the GradientDefinition to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “x1” attribute of this GradientBase object is set, false if either the “x1” attribute is not set , the object is NULL, or not of type LinearGradient.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLinearGradientX1(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “x1” attribute of the LinearGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the LinearGradient to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “x1” attribute of the LinearGradient object, or 0.0 if the object is NULL or not of type LinearGradient.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLinearGradientX1(SBMLDocument *document, const char *id, const double x1, int renderIndex = 0)

Sets the value of the “x1” attribute of the LinearGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the LinearGradient to retrieve.

  • x1 – a double value to be set as “x1” attribute of the LinearGradient object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLinearGradientY1(SBMLDocument *document, const char *id, int renderIndex = 0)

Predicates returning true if the “y1” attribute of the LinearGradient with the given identifier in the RenderInformationBase with the given index is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the LinearGradient to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “y1” attribute of this LinearGradient object is set, false if either the “y1” attribute is not set , the object is NULL, or not of type LinearGradient.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLinearGradientY1(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “y1” attribute of the LinearGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the LinearGradient to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “y1” attribute of the LinearGradient object, or 0.0 if the object is NULL or not of type LinearGradient.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLinearGradientY1(SBMLDocument *document, const char *id, const double y1, int renderIndex = 0)

Sets the value of the “y1” attribute of the LinearGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the LinearGradient to retrieve.

  • y1 – a double value to be set as “y1” attribute of the LinearGradient object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLinearGradientX2(SBMLDocument *document, const char *id, int renderIndex = 0)

Predicates returning true if the “x2” attribute of the LinearGradient with the given identifier in the RenderInformationBase with the given index is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the LinearGradient to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “x2” attribute of this LinearGradient object is set, false if either the “x2” attribute is not set , the object is NULL, or not of type LinearGradient.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLinearGradientX2(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “x2” attribute of the LinearGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the LinearGradient to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “x2” attribute of the LinearGradient object, or 0.0 if the object is NULL or not of type LinearGradient.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLinearGradientX2(SBMLDocument *document, const char *id, const double x2, int renderIndex = 0)

Sets the value of the “x2” attribute of the LinearGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the LinearGradient to retrieve.

  • x2 – a double value to be set as “x2” attribute of the LinearGradient object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLinearGradientY2(SBMLDocument *document, const char *id, int renderIndex = 0)

Predicates returning true if the “y2” attribute of the LinearGradient with the given identifier in the RenderInformationBase with the given index is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the LinearGradient to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “y2” attribute of this LinearGradient object is set, false if either the “y2” attribute is not set , the object is NULL, or not of type LinearGradient.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLinearGradientY2(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “y2” attribute of the LinearGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the LinearGradient to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “y2” attribute of the LinearGradient object, or 0.0 if the object is NULL or not of type LinearGradient.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLinearGradientY2(SBMLDocument *document, const char *id, const double y2, int renderIndex = 0)

Sets the value of the “y2” attribute of the LinearGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the LinearGradient to retrieve.

  • y2 – a double value to be set as “y2” attribute of the LinearGradient object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetRadialGradientCenterX(SBMLDocument *document, const char *id, int renderIndex = 0)

Predicates returning true if the “cx” attribute of the RadialGradient with the given identifier in the RenderInformationBase with the given index is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the RadialGradient to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “cx” attribute of this RadialGradient object is set, false if either the “cx” attribute is not set , the object is NULL, or not of type RadialGradient.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getRadialGradientCenterX(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “cx” attribute of the RadialGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the RadialGradient to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “cx” attribute of the RadialGradient object, or 0.0 if the object is NULL or not of type RadialGradient.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setRadialGradientCenterX(SBMLDocument *document, const char *id, const double cx, int renderIndex = 0)

Sets the value of the “cx” attribute of the RadialGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the RadialGradient to retrieve.

  • cx – a double value to be set as “cx” attribute of the RadialGradient object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetRadialGradientCenterY(SBMLDocument *document, const char *id, int renderIndex = 0)

Predicates returning true if the “cy” attribute of the RadialGradient with the given identifier in the RenderInformationBase with the given index is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the RadialGradient to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “cy” attribute of this RadialGradient object is set, false if either the “cy” attribute is not set , the object is NULL, or not of type RadialGradient.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getRadialGradientCenterY(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “cy” attribute of the RadialGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the RadialGradient to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “cy” attribute of the RadialGradient object, or 0.0 if the object is NULL or not of type RadialGradient.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setRadialGradientCenterY(SBMLDocument *document, const char *id, const double cy, int renderIndex = 0)

Sets the value of the “cy” attribute of the RadialGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the RadialGradient to retrieve.

  • cy – a double value to be set as “cy” attribute of the RadialGradient object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetRadialGradientFocalX(SBMLDocument *document, const char *id, int renderIndex = 0)

Predicates returning true if the “fx” attribute of the RadialGradient with the given identifier in the RenderInformationBase with the given index is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the RadialGradient to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “fx” attribute of this RadialGradient object is set, false if either the “fx” attribute is not set , the object is NULL, or not of type RadialGradient.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getRadialGradientFocalX(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “fx” attribute of the RadialGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the RadialGradient to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “fx” attribute of the RadialGradient object, or 0.0 if the object is NULL or not of type RadialGradient.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setRadialGradientFocalX(SBMLDocument *document, const char *id, const double fx, int renderIndex = 0)

Sets the value of the “fx” attribute of the RadialGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the RadialGradient to retrieve.

  • fx – a double value to be set as “fx” attribute of the RadialGradient object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetRadialGradientFocalY(SBMLDocument *document, const char *id, int renderIndex = 0)

Predicates returning true if the “fy” attribute of the RadialGradient with the given identifier in the RenderInformationBase with the given index is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the RadialGradient to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “fy” attribute of this RadialGradient object is set, false if either the “fy” attribute is not set , the object is NULL, or not of type RadialGradient.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getRadialGradientFocalY(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “fy” attribute of the RadialGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the RadialGradient to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “fy” attribute of the RadialGradient object, or 0.0 if the object is NULL or not of type RadialGradient.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setRadialGradientFocalY(SBMLDocument *document, const char *id, const double fy, int renderIndex = 0)

Sets the value of the “fy” attribute of the RadialGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the RadialGradient to retrieve.

  • fy – a double value to be set as “fy” attribute of the RadialGradient object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetRadialGradientRadius(SBMLDocument *document, const char *id, int renderIndex = 0)

Predicates returning true if the “r” attribute of the RadialGradient with the given identifier in the RenderInformationBase with the given index is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the RadialGradient to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “r” attribute of this RadialGradient object is set, false if either the “r” attribute is not set , the object is NULL, or not of type RadialGradient.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getRadialGradientRadius(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “r” attribute of the RadialGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the RadialGradient to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “r” attribute of the RadialGradient object, or 0.0 if the object is NULL or not of type RadialGradient.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setRadialGradientRadius(SBMLDocument *document, const char *id, const double r, int renderIndex = 0)

Sets the value of the “r” attribute of the RadialGradient with the given identifier in the RenderInformationBase with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – a string representing the identifier of the RadialGradient to retrieve.

  • r – a double value to be set as “r” attribute of the RadialGradient object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumLineEndings(SBMLDocument *document, int renderIndex = 0)

Returns the number of LineEnding objects of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the number of LineEnding objects of this RenderInformationBase object, or 0 if the object is NULL

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumGlobalLineEndings(SBMLDocument *document, int renderIndex = 0)

Returns the number of LineEnding objects of the GlobalRenderInformation object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • renderIndex – the index number of the GlobalRenderInformation object.

Returns:

the number of LineEnding objects of this GlobalRenderInformation object, or 0 if the object is NULL

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumLocalLineEndings(SBMLDocument *document, int renderIndex = 0)

Returns the number of LineEnding objects of the LocalRenderInformation object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • renderIndex – the index number of the LocalRenderInformation object.

Returns:

the number of LineEnding objects of this LocalRenderInformation object, or 0 if the object is NULL

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGlobalLineEndingId(SBMLDocument *document, int lineEndingIndex, int renderIndex = 0)

Returns the id of the LineEnding object with the given index in the given SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • lineEndingIndex – the index of the LineEnding to return.

  • renderIndex – the index number of the GlobalRenderInformation object.

Returns:

the id of the LineEnding object with the given index, or "" if the object is NULL

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLocalLineEndingId(SBMLDocument *document, int lineEndingIndex, int renderIndex = 0)

Returns the id of the LineEnding object with the given index in the given SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • lineEndingIndex – the index of the LineEnding to return.

  • renderIndex – the index number of the LocalRenderInformation object.

Returns:

the id of the LineEnding object with the given index, or "" if the object is NULL

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingEnableRotationalMapping(SBMLDocument *document, const char *id, int renderIndex = 0)

Predicate returning true if the enable rotational mapping attribute of the LineEnding object with the given id in the RenderInformationBase object with the given index is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the enable rotational mapping attribute of the LineEnding object with the given id is set, false if either the enable rotational mapping attribute is not set or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingEnableRotationalMapping(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the enable rotational mapping attribute of the LineEnding object with the given id in the RenderInformationBase object with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the value of the enable rotational mapping attribute of the LineEnding object, or false if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingEnableRotationalMapping(SBMLDocument *document, const char *id, bool enableRotationalMapping, int renderIndex = 0)

Sets the value of the enable rotational mapping attribute of the LineEnding object with the given id in the RenderInformationBase object with the given index.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • enableRotationalMapping – a boolean value to be set as the enable rotational mapping attribute of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingEnableRotationalMapping(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex, int speciesReferenceIndex, int layoutIndex)

Predicate returning true if the enable rotational mapping attribute of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

true if the enable rotational mapping attribute of the LineEnding object associated with the given species reference glyph is set, false if either the enable rotational mapping attribute is not set or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingEnableRotationalMapping(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex, int speciesReferenceIndex, int layoutIndex)

Returns the value of the enable rotational mapping attribute of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

the value of the enable rotational mapping attribute of the LineEnding object associated with the given species reference glyph is set, false if either the enable rotational mapping attribute is not set or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingEnableRotationalMapping(SBMLDocument *document, const char *reactionId, bool enableRotationalMapping, int reactionGlyphIndex, int speciesReferenceIndex, int layoutIndex)

Sets the value of the enable rotational mapping attribute of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • enableRotationalMapping – a boolean value to be set as the enable rotational mapping attribute of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingBoundingBoxX(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “x” attribute of the bounding box of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “x” attribute of the bounding box of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingBoundingBoxX(SBMLDocument *document, const char *id, const double x, int renderIndex = 0)

Sets the value of the “x” attribute of the bounding box of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • x – a double value to be set as “x” attribute of the bounding box of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingBoundingBoxX(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the value of the “y” attribute of the bounding box of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

the “y” attribute of the bounding box of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingBoundingBoxX(SBMLDocument *document, const char *reactionId, const double x, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of the bounding box of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • x – a double value to be set as “x” attribute of the bounding box of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingBoundingBoxX(SBMLDocument *document, const char *reactionId, const double x, int reactionGlyphIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of the bounding box of the all LineEnding objects associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • x – a double value to be set as “x” attribute of the bounding box of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingBoundingBoxY(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “y” attribute of the bounding box of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “y” attribute of the bounding box of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingBoundingBoxY(SBMLDocument *document, const char *id, const double y, int renderIndex = 0)

Sets the value of the “y” attribute of the bounding box of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • y – a double value to be set as “y” attribute of the bounding box of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingBoundingBoxY(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the value of the “y” attribute of the bounding box of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

the “y” attribute of the bounding box of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingBoundingBoxY(SBMLDocument *document, const char *reactionId, const double y, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of the bounding box of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • y – a double value to be set as “y” attribute of the bounding box of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingBoundingBoxY(SBMLDocument *document, const char *reactionId, const double y, int reactionGlyphIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of the bounding box of the all LineEnding objects associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • y – a double value to be set as “y” attribute of the bounding box of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingBoundingBoxWidth(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “width” attribute of the bounding box of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “width” attribute of the bounding box of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingBoundingBoxWidth(SBMLDocument *document, const char *id, const double width, int renderIndex = 0)

Sets the value of the “width” attribute of the bounding box of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • width – a double value to be set as “width” attribute of the bounding box of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingBoundingBoxWidth(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the value of the “width” attribute of the bounding box of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

the “width” attribute of the bounding box of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingBoundingBoxWidth(SBMLDocument *document, const char *reactionId, const double width, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Sets the value of the “width” attribute of the bounding box of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • width – a double value to be set as “width” attribute of the bounding box of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingBoundingBoxWidth(SBMLDocument *document, const char *reactionId, const double width, int reactionGlyphIndex = 0, int layoutIndex = 0)

Sets the value of the “width” attribute of the bounding box of all LineEnding objects associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • width – a double value to be set as “width” attribute of the bounding box of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingBoundingBoxHeight(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “height” attribute of the bounding box of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “height” attribute of the bounding box of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingBoundingBoxHeight(SBMLDocument *document, const char *id, const double height, int renderIndex = 0)

Sets the value of the “height” attribute of the bounding box of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • height – a double value to be set as “height” attribute of the bounding box of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingBoundingBoxHeight(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the value of the “height” attribute of the bounding box of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

the “height” attribute of the bounding box of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingBoundingBoxHeight(SBMLDocument *document, const char *reactionId, const double height, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Sets the value of the “height” attribute of the bounding box of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • height – a double value to be set as “height” attribute of the bounding box of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingBoundingBoxHeight(SBMLDocument *document, const char *reactionId, const double height, int reactionGlyphIndex = 0, int layoutIndex = 0)

Sets the value of the “height” attribute of the bounding box of all LineEnding objects associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • height – a double value to be set as “height” attribute of the bounding box of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingBorderColor(SBMLDocument *document, const char *id, int renderIndex = 0)

Predicates returning true if the “stroke” attribute of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “stroke” attribute of the RenderGroup of the LineEnding object is set, false if either the “stroke” attribute is not set or the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingBorderColor(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “stroke” attribute of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “stroke” attribute of the RenderGroup of the LineEnding object, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingBorderColor(SBMLDocument *document, const char *id, const char *borderColor, int renderIndex = 0)

Sets the value of the “stroke” attribute of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • borderColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingBorderColor(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Predicates returning true if the “stroke” attribute of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

true if the “stroke” attribute of the RenderGroup of the LineEnding object is set, false if either the “stroke” attribute is not set or the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingBorderColor(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the value of the “stroke” attribute of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

the “stroke” attribute of the RenderGroup of the LineEnding object, or "" if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingBorderColor(SBMLDocument *document, const char *reactionId, const char *borderColor, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Sets the value of the “stroke” attribute of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • borderColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingBorderColor(SBMLDocument *document, const char *reactionId, const char *borderColor, int reactionGlyphIndex = 0, int layoutIndex = 0)

Sets the value of the “stroke” attribute of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • borderColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingBorderWidth(SBMLDocument *document, const char *id, int renderIndex = 0)

Predicates returning true if the “stroke-width” attribute of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “stroke-width” attribute of the RenderGroup of the LineEnding object is set, false if either the “stroke-width” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingBorderWidth(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “stroke-width” attribute of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “stroke-width” attribute of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingBorderWidth(SBMLDocument *document, const char *id, const double borderWidth, int renderIndex = 0)

Sets the value of the “stroke-width” attribute of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • borderWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingBorderWidth(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Predicates returning true if the “stroke-width” attribute of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

true if the “stroke-width” attribute of the RenderGroup of the LineEnding object is set, false if either the “stroke-width” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingBorderWidth(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the value of the “stroke-width” attribute of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

the “stroke-width” attribute of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingBorderWidth(SBMLDocument *document, const char *reactionId, const double borderWidth, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Sets the value of the “stroke-width” attribute of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • borderWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingBorderWidth(SBMLDocument *document, const char *reactionId, const double borderWidth, int reactionGlyphIndex = 0, int layoutIndex = 0)

Sets the value of the “stroke-width” attribute of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • borderWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumLineEndingBorderDashes(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the size of the “stroke-dasharray” attribute of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • renderIndex – the index number of the RenderInformationBase object.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingBorderDash(SBMLDocument *document, const char *id, int borderDashIndex, int renderIndex = 0)

Returns the value of the dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • renderIndex – the index number of the RenderInformationBase object.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingBorderDash(SBMLDocument *document, const char *id, const int dash, int borderDashIndex, int renderIndex = 0)

Sets the dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • borderDashes – a double array to use as the value of the “stroke-dasharray” attribute of the RenderGroup of the LineEnding object.

  • numBorderDashes – the number of elements in the borderDashes array.

  • renderIndex – the index number of the RenderInformationBase object.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumSpeciesReferenceLineEndingBorderDashes(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the size of the “stroke-dasharray” attribute of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

the size of the “stroke-dasharray” attribute of the RenderGroup of the LineEnding object, or 0 if the object is NULL.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingBorderDash(SBMLDocument *document, const char *reactionId, int borderDashIndex, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the value of the dash at the given index of the “stroke-dasharray” attribute of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • borderDashIndex – the index of the border dash.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

the value of the dash at the given index of the “stroke-dasharray” attribute of the RenderGroup of the LineEnding object, or 0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingBorderDash(SBMLDocument *document, const char *reactionId, const int dash, int borderDashIndex, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Sets the dash at the given index of the “stroke-dasharray” attribute of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • dash – the value of the dash to set.

  • borderDashIndex – the index of the border dash.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingBorderDash(SBMLDocument *document, const char *reactionId, const int dash, int borderDashIndex, int reactionGlyphIndex = 0, int layoutIndex = 0)

Sets the dash at the given index of the “stroke-dasharray” attribute of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • dash – the value of the dash to set.

  • borderDashIndex – the index of the border dash.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingFillColor(SBMLDocument *document, const char *id, int renderIndex)

@breif Predicates returning true if the “fill” attribute of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “fill” attribute of the RenderGroup of the LineEnding object is set, false if either the “fill” attribute is not set or the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingFillColor(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “fill” attribute of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “fill” attribute of the RenderGroup of the LineEnding object, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingFillColor(SBMLDocument *document, const char *id, const char *fillColor, int renderIndex = 0)

Sets the value of the “fill” attribute of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • fillColor – a string value to use as the value of the “fill” attribute of the RenderGroup of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingFillColorAsGradient(SBMLDocument *document, const char *id, const char *gradientType = "linear", const char **stopColors = NULL, const double *stopOffsets = NULL, const int stopsSize = 0, int renderIndex = 0)

Sets the value of the “fill” attribute of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document in the form of a gradient.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • gradientType – the type of the gradient.

  • stopColors – an array of strings representing the colors of the gradient stops.

  • stopOffsets – an array of doubles representing the offsets of the gradient stops.

  • stopsSize – the size of the stopColors and stopOffsets arrays.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingFillColor(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Predicates returning true if the “fill” attribute of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

true if the “fill” attribute of the RenderGroup of the LineEnding object is set, false if either the “fill” attribute is not set or the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingFillColor(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the value of the “fill” attribute of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

the “fill” attribute of the RenderGroup of the LineEnding object, or "" if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingFillColor(SBMLDocument *document, const char *reactionId, const char *fillColor, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Sets the value of the “fill” attribute of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • fillColor – a string value to use as the value of the “fill” attribute of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingFillColorAsGradient(SBMLDocument *document, const char *reactionId, const char *gradientType = "linear", const char **stopColors = NULL, const double *stopOffsets = NULL, const int stopsSize = 0, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Sets the value of the “fill” attribute of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document in the form of a gradient.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • gradientType – the type of the gradient.

  • stopColors – an array of strings representing the colors of the gradient stops.

  • stopOffsets – an array of doubles representing the offsets of the gradient stops.

  • stopsSize – the size of the stopColors and stopOffsets arrays.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingFillColor(SBMLDocument *document, const char *reactionId, const char *fillColor, int reactionGlyphIndex = 0, int layoutIndex = 0)

Sets the value of the “fill” attribute of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • fillColor – a string value to use as the value of the “fill” attribute of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingFillColorAsGradient(SBMLDocument *document, const char *reactionId, const char *gradientType = "linear", const char **stopColors = NULL, const double *stopOffsets = NULL, const int stopsSize = 0, int reactionGlyphIndex = 0, int layoutIndex = 0)

Sets the value of the “fill” attribute of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document in the form of a gradient.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • gradientType – the type of the gradient.

  • stopColors – an array of strings representing the colors of the gradient stops.

  • stopOffsets – an array of doubles representing the offsets of the gradient stops.

  • stopsSize – the size of the stopColors and stopOffsets arrays.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingFillRule(SBMLDocument *document, const char *id, int renderIndex)

@breif Predicates returning true if the “fill-rule” attribute of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “fill-rule” attribute of the RenderGroup of the LineEnding object is set, false if either the “fill-rule” attribute is not set or the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingFillRule(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns the value of the “fill-rule” attribute of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “fill-rule” attribute of the RenderGroup of the LineEnding object, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingFillRule(SBMLDocument *document, const char *id, const char *fillRule, int renderIndex = 0)

Sets the value of the “fill-rule” attribute of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • fillRule – a string value to use as the value of the “fill-rule” attribute of the RenderGroup of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingFillRule(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Predicates returning true if the “fill-rule” attribute of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

true if the “fill-rule” attribute of the RenderGroup of the LineEnding object is set, false if either the “fill-rule” attribute is not set or the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingFillRule(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the value of the “fill-rule” attribute of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

the “fill-rule” attribute of the RenderGroup of the LineEnding object, or "" if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingFillRule(SBMLDocument *document, const char *reactionId, const char *fillRule, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Sets the value of the “fill-rule” attribute of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • fillRule – a string value to use as the value of the “fill-rule” attribute of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingFillRule(SBMLDocument *document, const char *reactionId, const char *fillRule, int reactionGlyphIndex = 0, int layoutIndex = 0)

Sets the value of the “fill-rule” attribute of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • fillRule – a string value to use as the value of the “fill-rule” attribute of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumLineEndingGeometricShapes(SBMLDocument *document, const char *id, int renderIndex = 0)

Returns number of Transformation2D objects in the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the number of Transformation2D objects in the RenderGroup of the LineEnding object, or 0 if the object is NULL

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumSpeciesReferenceLineEndingGeometricShapes(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns number of Transformation2D objects in the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

the number of Transformation2D objects in the RenderGroup of the LineEnding object, or 0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_addLineEndingGeometricShape(SBMLDocument *document, const char *id, const char *shape, int renderIndex = 0)

Adds a Transformation2D object to the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • shape – a string value to use as the value of the “shape” attribute of the Transformation2D object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to add.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_addSpeciesReferenceLineEndingGeometricShape(SBMLDocument *document, const char *reactionId, const char *shape, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Adds a Transformation2D object to the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • shape – a string value to use as the value of the “shape” attribute of the Transformation2D object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_removeLineEndingGeometricShape(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Removes the Transformation2D object at the given index from the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – the index of the Transformation2D object to remove.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_removeSpeciesReferenceLineEndingGeometricShape(SBMLDocument *document, const char *reactionId, int geometricShapeIndex = 0, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Removes the Transformation2D object at the given index from the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • geometricShapeIndex – the index of the Transformation2D object to remove.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeType(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the type of the Transformation2D object at the given index from the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – the index of the Transformation2D object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the type of the Transformation2D object, or "" if the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeType(SBMLDocument *document, const char *reactionId, int geometricShapeIndex = 0, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Returns the type of the Transformation2D object at the given index from the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • geometricShapeIndex – the index of the Transformation2D object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

the type of the Transformation2D object, or "" if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeType(SBMLDocument *document, const char *id, const char *shape, int renderIndex = 0)

Sets the type of the Transformation2D object at the given index in the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • shape – a string value to use as the type of the Transformation2D object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeType(SBMLDocument *document, const char *reactionId, const char *shape, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0)

Sets the type of the Transformation2D object at the given index in the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • shape – a string value to use as the type of the Transformation2D object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeId(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the id of the Transformation2D object at the given index from the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – the index of the Transformation2D object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the id of the Transformation2D object, or "" if the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeId(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Returns the id of the Transformation2D object at the given index from the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • geometricShapeIndex – the index of the Transformation2D object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

the id of the Transformation2D object, or "" if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeId(SBMLDocument *document, const char *id, const char *shapeId, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the id of the Transformation2D object at the given index in the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • shapeId – a string value to use as the id of the Transformation2D object.

  • geometricShapeIndex – the index of the Transformation2D object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeId(SBMLDocument *document, const char *reactionId, const char *id, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the id of the Transformation2D object at the given index in the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • id – a string value to use as the id of the Transformation2D object.

  • geometricShapeIndex – the index of the Transformation2D object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isLineEndingRectangle(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is of type Rectangle.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the LineEnding object is of type Rectangle, false if either the Transformation2D object is not of type Rectangle or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSpeciesReferenceLineEndingRectangle(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is of type Rectangle.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the LineEnding object is of type Rectangle, false if either the Transformation2D object is not of type Rectangle or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isLineEndingEllipse(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is of type Ellipse.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the LineEnding object is of type Ellipse, false if either the Transformation2D object is not of type Ellipse or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSpeciesReferenceLineEndingEllipse(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is of type Ellipse.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the LineEnding object is of type Ellipse, false if either the Transformation2D object is not of type Ellipse or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isLineEndingPolygon(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is of type Polygon.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the LineEnding object is of type Polygon, false if either the Transformation2D object is not of type Polygon or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSpeciesReferenceLineEndingPolygon(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is of type Polygon.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the LineEnding object is of type Polygon, false if either the Transformation2D object is not of type Polygon or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isLineEndingImage(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is of type Image.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the LineEnding object is of type Image, false if either the Transformation2D object is not of type Image or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSpeciesReferenceLineEndingImage(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is of type Image.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the LineEnding object is of type Image, false if either the Transformation2D object is not of type Image or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isLineEndingRenderCurve(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is of type RenderCurve.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the LineEnding object is of type RenderCurve, false if either the Transformation2D object is not of type RenderCurve or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSpeciesReferenceLineEndingRenderCurve(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is of type RenderCurve.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the LineEnding object is of type RenderCurve, false if either the Transformation2D object is not of type RenderCurve or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isLineEndingText(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is of type Text.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the LineEnding object is of type Text, false if either the Transformation2D object is not of type Text or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSpeciesReferenceLineEndingText(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is of type Text.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the LineEnding object is of type Text, false if either the Transformation2D object is not of type Text or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingGeometricShapeBorderColor(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “stroke” attribute is not set or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingGeometricShapeBorderColor(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – the index of the Transformation2D object.

Returns:

true if the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “stroke” attribute is not set or the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeBorderColor(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – the index of the Transformation2D object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or "" if the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeBorderColor(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – the index of the Transformation2D object.

Returns:

the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or "" if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeBorderColor(SBMLDocument *document, const char *id, const char *borderColor, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • borderColor – a string value to use as the value of the “stroke” attribute of the Transformation2D object.

  • geometricShapeIndex – the index of the Transformation2D object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeBorderColor(SBMLDocument *document, const char *reactionId, const char *borderColor, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • borderColor – a string value to use as the value of the “stroke” attribute of the Transformation2D object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – the index of the Transformation2D object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingGeometricShapeBorderWidth(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – the index of the Transformation2D object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “stroke-width” attribute is not set or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingGeometricShapeBorderWidth(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – the index of the Transformation2D object.

Returns:

true if the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “stroke-width” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeBorderWidth(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – the index of the Transformation2D object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0 if the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeBorderWidth(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – the index of the Transformation2D object.

Returns:

the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeBorderWidth(SBMLDocument *document, const char *id, const double borderWidth, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • borderWidth – a double value to use as the value of the “stroke-width” attribute of the Transformation2D object.

  • geometricShapeIndex – the index of the Transformation2D object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeBorderWidth(SBMLDocument *document, const char *reactionId, const double borderWidth, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • borderWidth – a double value to use as the value of the “stroke-width” attribute of the Transformation2D object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – the index of the Transformation2D object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingGeometricShapeFillColor(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – the index of the Transformation2D object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “fill” attribute is not set or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingGeometricShapeFillColor(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – the index of the Transformation2D object.

Returns:

true if the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “fill” attribute is not set or the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeFillColor(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – the index of the Transformation2D object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or "" if the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeFillColor(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – the index of the Transformation2D object.

Returns:

the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or "" if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeFillColor(SBMLDocument *document, const char *id, const char *fillColor, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • fillColor – a string value to use as the value of the “fill” attribute of the Transformation2D object.

  • geometricShapeIndex – the index of the Transformation2D object.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeFillColor(SBMLDocument *document, const char *reactionId, const char *fillColor, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • fillColor – a string value to use as the value of the “fill” attribute of the Transformation2D object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – the index of the Transformation2D object.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeFillColorAsGradient(SBMLDocument *document, const char *reactionId, const char *gradientType, const char **stopColors, const double *stopOffsets, const int stopsSize, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document as a gradient.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • gradientType – the type of the gradient.

  • stopColors – an array of strings representing the colors of the gradient stops.

  • stopOffsets – an array of doubles representing the offsets of the gradient stops.

  • stopsSize – the size of the stopColors and stopOffsets arrays.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – the index of the Transformation2D object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingGeometricShapeX(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the “x” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “x” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “x” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeX(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “x” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “x” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeX(SBMLDocument *document, const char *id, const double x, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “x” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • x – a double value to be set as “x” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingGeometricShapeX(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the “x” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the “x” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “x” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeX(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “x” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “x” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeX(SBMLDocument *document, const char *reactionId, const double x, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “x” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • x – a double value to be set as “x” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeX(SBMLDocument *document, const char *reactionId, const double x, int reactionGlyphIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “x” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • x – a double value to be set as “x” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingGeometricShapeY(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the “y” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “y” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “y” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeY(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “y” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “y” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeY(SBMLDocument *document, const char *id, const double y, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “y” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • y – a double value to be set as “y” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingGeometricShapeY(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the “y” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the “y” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “y” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeY(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “y” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “y” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeY(SBMLDocument *document, const char *reactionId, const double y, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “y” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • y – a double value to be set as “y” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeY(SBMLDocument *document, const char *reactionId, const double y, int reactionGlyphIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “y” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • y – a double value to be set as “y” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingGeometricShapeWidth(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the “width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “width” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeWidth(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeWidth(SBMLDocument *document, const char *id, const double width, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • width – a double value to be set as “width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingGeometricShapeWidth(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the “width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the “width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “width” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeWidth(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeWidth(SBMLDocument *document, const char *reactionId, const double width, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • width – a double value to be set as “width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeWidth(SBMLDocument *document, const char *reactionId, const double width, int reactionGlyphIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • width – a double value to be set as “width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingGeometricShapeHeight(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the “height” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “height” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “height” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeHeight(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “height” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeHeight(SBMLDocument *document, const char *id, const double height, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • height – a double value to be set as “height” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingGeometricShapeHeight(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the “height” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the “height” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “height” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeHeight(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “height” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeHeight(SBMLDocument *document, const char *reactionId, const double height, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • height – a double value to be set as “height” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeHeight(SBMLDocument *document, const char *reactionId, const double height, int reactionGlyphIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • height – a double value to be set as “height” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingGeometricShapeRatio(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “ratio” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeRatio(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeRatio(SBMLDocument *document, const char *id, const double ratio, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • ratio – a double value to be set as “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingGeometricShapeRatio(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “ratio” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeRatio(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeRatio(SBMLDocument *document, const char *reactionId, const double ratio, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • ratio – a double value to be set as “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeRatio(SBMLDocument *document, const char *reactionId, const double ratio, int reactionGlyphIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • ratio – a double value to be set as “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingGeometricShapeBorderRadiusX(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “rx” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeBorderRadiusX(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeBorderRadiusX(SBMLDocument *document, const char *id, const double rx, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • rx – a double value to be set as “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingGeometricShapeBorderRadiusX(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “rx” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeBorderRadiusX(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeBorderRadiusX(SBMLDocument *document, const char *reactionId, const double rx, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • rx – a double value to be set as “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeBorderRadiusX(SBMLDocument *document, const char *reactionId, const double rx, int reactionGlyphIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • rx – a double value to be set as “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingGeometricShapeBorderRadiusY(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “ry” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeBorderRadiusY(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeBorderRadiusY(SBMLDocument *document, const char *id, const double ry, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • ry – a double value to be set as “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingGeometricShapeBorderRadiusY(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “ry” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeBorderRadiusY(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeBorderRadiusY(SBMLDocument *document, const char *reactionId, const double ry, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • ry – a double value to be set as “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeBorderRadiusY(SBMLDocument *document, const char *reactionId, const double ry, int reactionGlyphIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • ry – a double value to be set as “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingGeometricShapeCenterX(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “cx” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeCenterX(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeCenterX(SBMLDocument *document, const char *id, const double cx, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • cx – a double value to be set as “cx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingGeometricShapeCenterX(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “cx” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeCenterX(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeCenterX(SBMLDocument *document, const char *reactionId, const double cx, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • cx – a double value to be set as “cx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeCenterX(SBMLDocument *document, const char *reactionId, const double cx, int reactionGlyphIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • cx – a double value to be set as “cx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingGeometricShapeCenterY(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “cy” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeCenterY(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeCenterY(SBMLDocument *document, const char *id, const double cy, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • cy – a double value to be set as “cy” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingGeometricShapeCenterY(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “cy” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeCenterY(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeCenterY(SBMLDocument *document, const char *reactionId, const double cy, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • cy – a double value to be set as “cy” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeCenterY(SBMLDocument *document, const char *reactionId, const double cy, int reactionGlyphIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • cy – a double value to be set as “cy” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingGeometricShapeRadiusX(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “rx” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeRadiusX(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeRadiusX(SBMLDocument *document, const char *id, const double rx, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object

  • id – the id of the LineEnding object

  • rx – a double value to be set as “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve

  • renderIndex – the index number of the RenderInformationBase object

Returns:

integer value indicating success/failure of the function

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingGeometricShapeRadiusX(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “rx” attribute is not set or the object is NULL.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeRadiusX(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeRadiusX(SBMLDocument *document, const char *reactionId, const double rx, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • rx – a double value to be set as “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeRadiusX(SBMLDocument *document, const char *reactionId, const double rx, int reactionGlyphIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • rx – a double value to be set as “rx” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingGeometricShapeRadiusY(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object

  • id – the id of the LineEnding object

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve

  • renderIndex – the index number of the RenderInformationBase object

Returns:

true if the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “ry” attribute is not set or the object is NULL

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeRadiusY(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object

  • id – the id of the LineEnding object

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve

  • renderIndex – the index number of the RenderInformationBase object

Returns:

the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeRadiusY(SBMLDocument *document, const char *id, const double ry, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object

  • id – the id of the LineEnding object

  • ry – a double value to be set as “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve

  • renderIndex – the index number of the RenderInformationBase object

Returns:

integer value indicating success/failure of the function

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingGeometricShapeRadiusY(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object

  • reactionId – the id of the reaction

  • reactionGlyphIndex – the index of the reaction glyph

  • speciesReferenceIndex – the index of the species reference glyph

  • layoutIndex – the index of the layout

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve

Returns:

true if the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “ry” attribute is not set or the object is NULL

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeRadiusY(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeRadiusY(SBMLDocument *document, const char *reactionId, const double ry, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • ry – a double value to be set as “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeRadiusY(SBMLDocument *document, const char *reactionId, const double ry, int reactionGlyphIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • ry – a double value to be set as “ry” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeNumSegments(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the number of elements of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the number of elements of the RenderGroup of the LineEnding object, or 0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeNumSegments(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Returns the number of segments of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the number of segments of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0 if the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isLineEndingGeometricShapeSegmentCubicBezier(SBMLDocument *document, const char *id, int segmentIndex = 0, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the “type” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document is set to “cubicBezier”.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “type” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set to “cubicBezier”, false otherwise.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSpeciesReferenceLineEndingGeometricShapeSegmentCubicBezier(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the “type” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set to “cubicBezier”.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the “type” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set to “cubicBezier”, false otherwise.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeSegmentX(SBMLDocument *document, const char *id, int segmentIndex = 0, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “x” attribute of element at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • segmentIndex – an int representing the index of the Transformation2D to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “x” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeSegmentX(SBMLDocument *document, const char *id, const double x, int segmentIndex = 0, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “x” attribute of element at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • x – a double value to be set as “x” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • segmentIndex – an int representing the index of the Transformation2D to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeSegmentX(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “x” attribute of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “x” attribute of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeSegmentX(SBMLDocument *document, const char *reactionId, const double x, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “x” attribute of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • x – a double value to be set as “x” attribute of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeSegmentX(SBMLDocument *document, const char *reactionId, const double x, int reactionGlyphIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “x” attribute of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • x – a double value to be set as “x” attribute of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeSegmentY(SBMLDocument *document, const char *id, int segmentIndex = 0, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “y” attribute of element at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • segmentIndex – an int representing the index of the Transformation2D to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “y” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeSegmentY(SBMLDocument *document, const char *id, const double y, int segmentIndex = 0, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “y” attribute of element at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • y – a double value to be set as “y” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • segmentIndex – an int representing the index of the Transformation2D to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeSegmentY(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “y” attribute of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “y” attribute of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeSegmentY(SBMLDocument *document, const char *reactionId, const double y, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “y” attribute of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • y – a double value to be set as “y” attribute of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeSegmentY(SBMLDocument *document, const char *reactionId, const double y, int reactionGlyphIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “y” attribute of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • y – a double value to be set as “y” attribute of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeBasePoint1X(SBMLDocument *document, const char *id, int segmentIndex = 0, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “x” attribute of the base point 1 of element at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • segmentIndex – an int representing the index of the Transformation2D to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “x” attribute of the base point 1 of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeBasePoint1X(SBMLDocument *document, const char *id, const double x, int segmentIndex = 0, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “x” attribute of the base point 1 of element at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • x – a double value to be set as “x” attribute of the base point 1 of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • segmentIndex – an int representing the index of the Transformation2D to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeBasePoint1X(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “x” attribute of the base point 1 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “x” attribute of the base point 1 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeBasePoint1X(SBMLDocument *document, const char *reactionId, const double x, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “x” attribute of the base point 1 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • x – a double value to be set as “x” attribute of the base point 1 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeBasePoint1X(SBMLDocument *document, const char *reactionId, const double x, int reactionGlyphIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “x” attribute of the base point 1 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • x – a double value to be set as “x” attribute of the base point 1 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeBasePoint1Y(SBMLDocument *document, const char *id, int segmentIndex = 0, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “y” attribute of the base point 1 of element at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • segmentIndex – an int representing the index of the Transformation2D to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “y” attribute of the base point 1 of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeBasePoint1Y(SBMLDocument *document, const char *id, const double y, int segmentIndex = 0, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “y” attribute of the base point 1 of element at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • y – a double value to be set as “y” attribute of the base point 1 of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • segmentIndex – an int representing the index of the Transformation2D to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeBasePoint1Y(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “y” attribute of the base point 1 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “y” attribute of the base point 1 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeBasePoint1Y(SBMLDocument *document, const char *reactionId, const double y, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “y” attribute of the base point 1 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • y – a double value to be set as “y” attribute of the base point 1 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeBasePoint1Y(SBMLDocument *document, const char *reactionId, const double y, int reactionGlyphIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “y” attribute of the base point 1 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • y – a double value to be set as “y” attribute of the base point 1 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeBasePoint2X(SBMLDocument *document, const char *id, int segmentIndex = 0, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “x” attribute of the base point 2 of element at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • segmentIndex – an int representing the index of the Transformation2D to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “x” attribute of the base point 2 of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeBasePoint2X(SBMLDocument *document, const char *id, const double x, int segmentIndex = 0, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “x” attribute of the base point 2 of element at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • x – a double value to be set as “x” attribute of the base point 2 of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • segmentIndex – an int representing the index of the Transformation2D to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeBasePoint2X(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “x” attribute of the base point 2 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “x” attribute of the base point 2 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeBasePoint2X(SBMLDocument *document, const char *reactionId, const double x, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “x” attribute of the base point 2 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • x – a double value to be set as “x” attribute of the base point 2 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeBasePoint2X(SBMLDocument *document, const char *reactionId, const double x, int reactionGlyphIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “x” attribute of the base point 2 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • x – a double value to be set as “x” attribute of the base point 2 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeBasePoint2Y(SBMLDocument *document, const char *id, int segmentIndex = 0, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “y” attribute of the base point 2 of element at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • segmentIndex – an int representing the index of the Transformation2D to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “y” attribute of the base point 2 of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeBasePoint2Y(SBMLDocument *document, const char *id, const double y, int segmentIndex = 0, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “y” attribute of the base point 2 of element at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • y – a double value to be set as “y” attribute of the base point 2 of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • segmentIndex – an int representing the index of the Transformation2D to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeBasePoint2Y(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “y” attribute of the base point 2 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “y” attribute of the base point 2 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeBasePoint2Y(SBMLDocument *document, const char *reactionId, const double y, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “y” attribute of the base point 2 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • y – a double value to be set as “y” attribute of the base point 2 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeBasePoint2Y(SBMLDocument *document, const char *reactionId, const double y, int reactionGlyphIndex = 0, int layoutIndex = 0, int segmentIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “y” attribute of the base point 2 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • y – a double value to be set as “y” attribute of the base point 2 of the segment at the given index of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • segmentIndex – the index of the segment.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineEndingGeometricShapeHref(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Predicates returning true if the “href” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

true if the “href” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false if either the “href” attribute is not set or the object is NULL.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingGeometricShapeHref(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int renderIndex = 0)

Returns the value of the “href” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

the “href” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingGeometricShapeHref(SBMLDocument *document, const char *id, const char *href, int geometricShapeIndex = 0, int renderIndex = 0)

Sets the value of the “href” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase object with the given index of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of the LineEnding object.

  • href – a string value to be set as “href” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve

  • renderIndex – the index number of the RenderInformationBase object.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetSpeciesReferenceLineEndingGeometricShapeHref(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Predicates returning true if the “href” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

true if the “href” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object is set, false otherwise.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesReferenceLineEndingGeometricShapeHref(SBMLDocument *document, const char *reactionId, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Returns the value of the “href” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

the “href” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object, or NULL if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesReferenceLineEndingGeometricShapeHref(SBMLDocument *document, const char *reactionId, const char *href, int reactionGlyphIndex = 0, int speciesReferenceIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “href” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given species reference glyph of the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • href – a string to be set as the “href” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • speciesReferenceIndex – the index of the species reference glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionLineEndingGeometricShapeHref(SBMLDocument *document, const char *reactionId, const char *href, int reactionGlyphIndex = 0, int layoutIndex = 0, int geometricShapeIndex = 0)

Sets the value of the “href” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object associated with the given reaction glyph of the given layout of the SBML document.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • reactionId – the id of the reaction.

  • href – a string to be set as the “href” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object.

  • reactionGlyphIndex – the index of the reaction glyph.

  • layoutIndex – the index of the layout.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetBorderColor(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the “stroke” attribute of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject is set, false if either the “stroke” attribute is not set or the object is NULL .

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineColor(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “stroke” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject (ReactionGlyph).

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getBorderColor(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “stroke” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject, or "" if the object is NULL

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineColor(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “stroke” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject (ReactionGlyph).

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject, or "" if the object is NULL or not a ReactoinGlyph.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setBorderColor(SBMLDocument *document, const char *id, const char *borderColor, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “stroke” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • borderColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineColor(SBMLDocument *document, const char *id, const char *lineColor, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “stroke” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject (ReactionGlyph).

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • lineColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsBorderColor(SBMLDocument *document)

Returns the value of the “stroke” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “stroke” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object, or "" if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsBorderColor(SBMLDocument *document, const char *borderColor, int layoutIndex = 0)

Sets the value of the “stroke” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • borderColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesBorderColor(SBMLDocument *document)

Returns the value of the “stroke” attribute of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “stroke” attribute of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object, or "" if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesBorderColor(SBMLDocument *document, const char *borderColor, int layoutIndex = 0)

Sets the value of the “stroke” attribute of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • borderColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsLineColor(SBMLDocument *document)

Returns the value of the “stroke” attribute of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “stroke” attribute of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object, or "" if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsLineColor(SBMLDocument *document, const char *lineColor, int layoutIndex = 0)

Sets the value of the “stroke” attribute of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • lineColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingsBorderColor(SBMLDocument *document, int layoutIndex = 0)

Returns the value of the “stroke” attribute of the RenderGroup of the Style of all LineEndings objects in this Layout object if they share the same color.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “stroke” attribute of the RenderGroup of the Style of all LineEndings objects in this Layout object, or "" if the object is NULL or the LineEndings objects do not share the same color.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingsBorderColor(SBMLDocument *document, const char *borderColor, int layoutIndex)

Sets the value of the “stroke” attribute of the RenderGroup of all LineEndings objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • borderColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setBorderColors(SBMLDocument *document, const char *borderColor, int layoutIndex = 0)

Sets the value of the “stroke” attribute of the RenderGroup of the Style of all GraphicalObjects objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • borderColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of the Style for these GraphicalObject.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineColors(SBMLDocument *document, const char *lineColor, int layoutIndex = 0)

Sets the value of the “stroke” attribute of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • lineColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getEmptySpeciesBorderColor(SBMLDocument *document)
int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setEmptySpeciesBorderColor(SBMLDocument *document, const char *borderColor, int layoutIndex)
bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetBorderWidth(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the “stroke-width” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the “stroke-width” attribute of the RenderGroup of the Style for this GraphicalObject is set, false if either the “stroke-width” attribute is not set or the object is NULL .

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetLineWidth(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “stroke-width” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “stroke-width” attribute of the RenderGroup of the Style for this GraphicalObject, or 0.0 if the object is NULL

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getBorderWidth(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “stroke-width” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “stroke-width” attribute of the RenderGroup of the Style for this GraphicalObject, or 0.0 if the object is NULL

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineWidth(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “stroke-width” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject (ReactionGlyph).

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “stroke-width” attribute of the RenderGroup of the Style for this GraphicalObject, or 0.0 if the object is NULL or not a ReactionGlyph.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setBorderWidth(SBMLDocument *document, const char *id, const double borderWidth, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “stroke-width” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

  • borderWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of the Style for this GraphicalObject.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineWidth(SBMLDocument *document, const char *id, const double lineWidth, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “stroke-width” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject (ReactionGlyph).

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

  • lineWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of the Style for this GraphicalObject.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsBorderWidth(SBMLDocument *document)

Returns the value of the “stroke-width” attribute of the RenderGroup of the Style of all CompartmentGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “stroke-width” attribute of the RenderGroup of the Style of all CompartmentGlyph object in this Layout object, or 0.0 if the object is NULL.

Returns:

the “stroke-width” attribute of the RenderGroup of the Style of all CompartmentGlyph object in this Layout object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsBorderWidth(SBMLDocument *document, const double borderWidth, int layoutIndex = 0)

Sets the value of the “stroke-width” attribute of the RenderGroup of the Style of all CompartmentGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • borderWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesBorderWidth(SBMLDocument *document)

Returns the value of the “stroke-width” attribute of the RenderGroup of the Style of all SpeciesGlyph object in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “stroke-width” attribute of the RenderGroup of the Style of all SpeciesGlyph object in this Layout object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesBorderWidth(SBMLDocument *document, const double borderWidth, int layoutIndex = 0)

Sets the value of the “stroke-width” attribute of the RenderGroup of the Style of all SpeciesGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • borderWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsLineWidth(SBMLDocument *document)

Returns the value of the “stroke-width” attribute of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “stroke-width” attribute of the RenderGroup of the Style of all ReactionGlyph object in this Layout object, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsLineWidth(SBMLDocument *document, const double lineWidth, int layoutIndex = 0)

Sets the value of the “stroke-width” attribute of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • lineWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingsBorderWidth(SBMLDocument *document, int layoutIndex = 0)

Returns the value of the “stroke-width” attribute of the RenderGroup of the Style of all LineEndings objects in this Layout object if they share the same width.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “stroke-width” attribute of the RenderGroup of the Style of all LineEndings objects in this Layout object, or nan if the object is NULL or the LineEndings objects do not share the same width.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingsBorderWidth(SBMLDocument *document, const double borderWidth, int layoutIndex)

Sets the value of the “stroke-width” attribute of the RenderGroup of all LineEndings objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • borderWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setBorderWidths(SBMLDocument *document, const double borderWidth, int layoutIndex = 0)

Sets the value of the “stroke-width” attribute of the RenderGroup of the Style of all GraphicalObjects objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • borderWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineWidths(SBMLDocument *document, const double lineWidth, int layoutIndex = 0)

Sets the value of the “stroke-width” attribute of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • lineWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getEmptySpeciesBorderWidth(SBMLDocument *document)
int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setEmptySpeciesBorderWidth(SBMLDocument *document, const double borderWidth, int layoutIndex)
int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumBorderDashes(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the size of the “stroke-dasharray” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the size of the “stroke-dasharray” attribute of the RenderGroup of the Style for this GraphicalObject object, or "" if the object is NULL

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getBorderDash(SBMLDocument *document, const char *id, int borderDashIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the stroke dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • borderDashIndex – an int representing the index of the stroke dash to retrieve.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the stroke dash at the given index of “stroke-dasharray” attribute of the RenderGroup of the Style for this GraphicalObject object, 0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setBorderDash(SBMLDocument *document, const char *id, const int dash, int borderDashIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • dash – a int value to use as the dash at the given index of the ‘stroke-dasharray’ attribute of of the RenderGroup of this Style object.

  • borderDashIndex – an int representing the index of the stroke dash to retrieve.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumLineDashes(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the size of the “stroke-dasharray” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the size of the “stroke-dasharray” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object, or 0 if the object is NULL.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineDash(SBMLDocument *document, const char *id, int lineDashIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the stroke dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • lineDashIndex – an int representing the index of the stroke dash to retrieve.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineDash(SBMLDocument *document, const char *id, const int dash, int lineDashIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • dash – a int value to use as the dash at the given index of the ‘stroke-dasharray’ attribute of of the RenderGroup of this Style object.

  • lineDashIndex – an int representing the index of the stroke dash to retrieve.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetFillColor(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the “fill” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the “fill” attribute of the RenderGroup of the Style for this GraphicalObject is set, false if either the “fill” attribute is not set or the object is NULL .

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setFillColorAsGradient(SBMLDocument *document, const char *id, const char *gradientType = "linear", const char **stopColors = NULL, const double *stopOffsets = NULL, const int stopsSize = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “fill” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “fill” attribute of the RenderGroup of the Style for this GraphicalObject, or "" if the object is NULL

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getFillColor(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “fill” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “fill” attribute of the RenderGroup of the Style for this GraphicalObject, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setFillColor(SBMLDocument *document, const char *id, const char *fillColor, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “fill” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • fillColor – a string value to use as the value of the “fill” attribute of the RenderGroup of the Style for this GraphicalObject.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsFillColor(SBMLDocument *document)

Returns the value of the “fill” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “fill” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object, or "" if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsFillColor(SBMLDocument *document, const char *fillColor, int layoutIndex = 0)

Sets the value of the “fill” attribute of the RenderGroup of the Style of all CompartmentGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fillColor – a string value to use as the value of the “fill” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsFillColorAsGradient(SBMLDocument *document, const char *gradientType = "linear", const char **stopColors = NULL, const double *stopOffsets = NULL, const int stopsSize = 0, int layoutIndex = 0)

Sets the value of the “fill” attribute of the RenderGroup of the Style of all CompartmentGlyph object in this Layout object as a gradient.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • gradientType – a string value representing the type of gradient (e.g., “linear”).

  • stopColors – an array of string values representing the colors at each stop of the gradient.

  • stopOffsets – an array of double values representing the offset at each stop of the gradient.

  • stopsSize – an int representing the number of stops in the gradient.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesFillColor(SBMLDocument *document)

Returns the value of the “fill” attribute of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “fill” attribute of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object, or "" if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesFillColor(SBMLDocument *document, const char *fillColor, int layoutIndex = 0)

Sets the value of the “fill” attribute of the RenderGroup of the Style of all SpeciesGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fillColor – a string value to use as the value of the “fill” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesFillColorAsGradient(SBMLDocument *document, const char *gradientType = "linear", const char **stopColors = NULL, const double *stopOffsets = NULL, const int stopsSize = 0, int layoutIndex = 0)

Sets the value of the “fill” attribute of the RenderGroup of the Style of all SpeciesGlyph object in this Layout object as a gradient.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • gradientType – a string value representing the type of gradient (e.g., “linear”).

  • stopColors – an array of string values representing the colors at each stop of the gradient.

  • stopOffsets – an array of double values representing the offset at each stop of the gradient.

  • stopsSize – an int representing the number of stops in the gradient.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsFillColor(SBMLDocument *document)

Returns the value of the “fill” attribute of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “fill” attribute of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object, or "" if the object is NULL.

Returns:

the “fill” attribute of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object, or "" if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsFillColor(SBMLDocument *document, const char *fillColor, int layoutIndex = 0)

Sets the value of the “fill” attribute of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fillColor – a string value to use as the value of the “fill” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsFillColorAsGradient(SBMLDocument *document, const char *gradientType = "linear", const char **stopColors = NULL, const double *stopOffsets = NULL, const int stopsSize = 0, int layoutIndex = 0)

Sets the value of the “fill” attribute of the RenderGroup of the Style of all ReactionGlyph object in this Layout object as a gradient.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • gradientType – a string value representing the type of gradient (e.g., “linear”).

  • stopColors – an array of string values representing the colors at each stop of the gradient.

  • stopOffsets – an array of double values representing the offset at each stop of the gradient.

  • stopsSize – an int representing the number of stops in the gradient.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingsFillColor(SBMLDocument *document, int layoutIndex = 0)

Returns the value of the “fill” attribute of the RenderGroup of the Style of all LineEndings objects in this Layout object if they share the same color.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “fill” attribute of the RenderGroup of the Style of all LineEndings objects in this Layout object, or "" if the object is NULL or the LineEndings objects do not share the same color.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingsFillColor(SBMLDocument *document, const char *fillColor, int layoutIndex)

Sets the value of the “fill” attribute of the RenderGroup of all LineEndings objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fillColor – a string value to use as the value of the “fill” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingsFillColorAsGradient(SBMLDocument *document, const char *gradientType = "linear", const char **stopColors = NULL, const double *stopOffsets = NULL, const int stopsSize = 0, int layoutIndex = 0)

Sets the value of the “fill” attribute of the RenderGroup of the Style of all GraphicalObjects objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fillColor – a string value to use as the value of the “fill” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setFillColors(SBMLDocument *document, const char *fillColor, int layoutIndex = 0)

Sets the value of the “fill” attribute of the RenderGroup of the Style of all GraphicalObjects objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fillColor – a string value to use as the value of the “fill” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setFillColorsAsGradient(SBMLDocument *document, const char *gradientType = "linear", const char **stopColors = NULL, const double *stopOffsets = NULL, const int stopsSize = 0, int layoutIndex = 0)

Sets the value of the “fill” attribute of the RenderGroup of the Style of all GraphicalObjects objects in this Layout object as a gradient.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • gradientType – a string value representing the type of gradient (e.g., “linear”).

  • stopColors – an array of string values representing the colors at each stop of the gradient.

  • stopOffsets – an array of double values representing the offset at each stop of the gradient.

  • stopsSize – an int representing the number of stops in the gradient.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getEmptySpeciesFillColor(SBMLDocument *document)
int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setEmptySpeciesFillColor(SBMLDocument *document, const char *fillColor, int layoutIndex)
int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setEmptySpeciesFillColorAsGradient(SBMLDocument *document, const char *gradientType, const char **stopColors, const double *stopOffsets, const int stopsSize, int layoutIndex)
bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetFillRule(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the “fill-rule” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the “fill-rule” attribute of the RenderGroup of the Style for this GraphicalObject is set, false if either the “fill-rule” attribute is not set or the object is NULL .

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getFillRule(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “fill-rule” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “fill-rule” attribute of the RenderGroup of the Style for this GraphicalObject, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setFillRule(SBMLDocument *document, const char *id, const char *fillRule, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “fill-rule” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • fillRule – a string value to use as the value of the “fill-rule” attribute of the RenderGroup of the Style for this GraphicalObject.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsFillRule(SBMLDocument *document)

Returns the default value of the “fill-rule” attribute of the RenderGroup of the Global Style of CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “fill-rule” attribute of the RenderGroup of the Style for the global CompartmentGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsFillRule(SBMLDocument *document, const char *fillRule, int layoutIndex = 0)

Sets the value of the “fill-rule” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fillRule – a string value to use as the value of the “fill-rule” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesFillRule(SBMLDocument *document)

Returns the value of the “fill-rule” attribute of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “fill-rule” attribute of the RenderGroup of the Style for all SpeciesGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesFillRule(SBMLDocument *document, const char *fillRule, int layoutIndex = 0)

Sets the value of the “fill-rule” attribute of the RenderGroup of the Style of all GraphicalObject objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fillRule – a string value to use as the value of the “fill-rule” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsFillRule(SBMLDocument *document)

Returns the value of the “fill-rule” attribute of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “fill-rule” attribute of the RenderGroup of the Style for all ReactionGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsFillRule(SBMLDocument *document, const char *fillRule, int layoutIndex = 0)

Sets the value of the “fill-rule” attribute of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fillRule – a string value to use as the value of the “fill-rule” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getLineEndingsFillRule(SBMLDocument *document, int layoutIndex = 0)

Returns the value of the “fill-rule” attribute of the RenderGroup of the Style of all LineEndings objects in this Layout object if they share the same fill rule.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “fill-rule” attribute of the RenderGroup of the Style of all LineEndings objects in this Layout object, or "" if the object is NULL or the LineEndings objects do not share the same fill rule.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setLineEndingsFillRule(SBMLDocument *document, const char *fillRule, int layoutIndex = 0)

Sets the value of the “fill-rule” attribute of the RenderGroup of all LineEndings objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fillRule – a string value to use as the value of the “fill-rule” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setFillRules(SBMLDocument *document, const char *fillRule, int layoutIndex = 0)

Sets the value of the “fill-rule” attribute of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fillRule – a string value to use as the value of the “fill-rule” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getEmptySpeciesFillRule(SBMLDocument *document)
int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setEmptySpeciesFillRule(SBMLDocument *document, const char *fillRule, int layoutIndex)
bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetFontColor(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Predicates returning true if the “stroke” attribute of the RenderGroup of the Style that belongs to the the TextGlyph with the given index associated with the GraphicalObject with the given index associated with the model entity with this id is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject is set, false if either the “stroke” attribute is not set or the object is NULL .

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getFontColor(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Returns the value of the “stroke” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setFontColor(SBMLDocument *document, const char *id, const char *fontColor, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Sets the value of the “stroke” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • fontColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsFontColor(SBMLDocument *document)

Returns the value of the “stroke” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “stroke” attribute of the RenderGroup of the Style for all CompartmentGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsFontColor(SBMLDocument *document, const char *fontColor, int layoutIndex = 0)

Sets the value of the “stroke” attribute of the RenderGroup of the Style of all CompartmentGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesFontColor(SBMLDocument *document)

Returns the value of the “stroke” attribute of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “stroke” attribute of the RenderGroup of the Style for all SpeciesGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesFontColor(SBMLDocument *document, const char *fontColor, int layoutIndex = 0)

Sets the value of the “stroke” attribute of the RenderGroup of the the Style of the TextGlyph objects associated with of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsFontColor(SBMLDocument *document)

Returns the value of the “stroke” attribute of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “stroke” attribute of the RenderGroup of the Style for all ReactionGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsFontColor(SBMLDocument *document, const char *fontColor, int layoutIndex = 0)

Sets the value of the “stroke” attribute of the RenderGroup of the the Style of the TextGlyph objects associated with of all ReactionGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setFontColors(SBMLDocument *document, const char *fontColor, int layoutIndex = 0)

Sets the value of the “stroke” attribute of the RenderGroup of the the Style of the TextGlyph objects associated with of all GraphicalObject objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getEmptySpeciesFontColor(SBMLDocument *document)
int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setEmptySpeciesFontColor(SBMLDocument *document, const char *fontColor, int layoutIndex)
bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetFontFamily(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Predicates returning true if the “font-family” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the “font-family” attribute of the RenderGroup of the Style for this GraphicalObject is set, false if either the “font-family” attribute is not set or the object is NULL .

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getFontFamily(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Returns the value of the “font-family” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “font-family” attribute of the RenderGroup of the Style for this GraphicalObject, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setFontFamily(SBMLDocument *document, const char *id, const char *fontFamily, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Sets the value of the “font-family” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • fontFamily – a string value to use as the value of the “font-family” attribute of the RenderGroup of the Style for this GraphicalObject.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsFontFamily(SBMLDocument *document)

Returns the value of the “font-family” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “font-family” attribute of the RenderGroup of the Style for all CompartmentGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsFontFamily(SBMLDocument *document, const char *fontFamily, int layoutIndex = 0)

Sets the value of the “font-family” attribute of the RenderGroup of the Style of all CompartmentGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontFamily – a string value to use as the value of the “font-family” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesFontFamily(SBMLDocument *document)

Returns the value of the “font-family” attribute of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “font-family” attribute of the RenderGroup of the Style for all SpeciesGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesFontFamily(SBMLDocument *document, const char *fontFamily, int layoutIndex = 0)

Sets the value of the “font-family” attribute of the RenderGroup of the Style of the TextGlyph objects associated with all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontFamily – a string value to use as the value of the “font-family” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsFontFamily(SBMLDocument *document)

Returns the value of the “font-family” attribute of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “font-family” attribute of the RenderGroup of the Style for all ReactionGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsFontFamily(SBMLDocument *document, const char *fontFamily, int layoutIndex)

@breif Sets the value of the “font-family” attribute of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontFamily – a string value to use as the value of the “font-family” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setFontFamilies(SBMLDocument *document, const char *fontFamily, int layoutIndex = 0)

Sets the value of the “font-family” attribute of the RenderGroup of the the Style of the TextGlyph objects associated with of all GraphicalObject objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontFamily – a string value to use as the value of the “font-family” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getEmptySpeciesFontFamily(SBMLDocument *document)
int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setEmptySpeciesFontFamily(SBMLDocument *document, const char *fontFamily, int layoutIndex)
bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetFontSize(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Predicates returning true if the “font-size” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the “font-size” attribute of the RenderGroup of the Style for this GraphicalObject is set, false if either the “font-size” attribute is not set

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getFontSize(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Returns the value of the “font-size” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “font-size” attribute of the RenderGroup of the Style for this GraphicalObject, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setFontSize(SBMLDocument *document, const char *id, const double fontSize, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Sets the value of the “font-size” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • fontSize – a double value to use as the value of the “font-size” attribute of the RenderGroup of the Style for this GraphicalObject.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsFontSize(SBMLDocument *document)

Returns the value of the “font-size” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “font-size” attribute of the RenderGroup of the Style for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsFontSize(SBMLDocument *document, const double fontSize, int layoutIndex = 0)

Sets the value of the “font-size” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontSize – a double value to use as the value of the “font-size” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesFontSize(SBMLDocument *document)

Returns the value of the “font-size” attribute of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “font-size” attribute of the RenderGroup of the Style for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesFontSize(SBMLDocument *document, const double fontSize, int layoutIndex = 0)

Sets the value of the “font-size” attribute of the RenderGroup of the Style of the TextGlyph objects associated with all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontSize – a double value to use as the value of the “font-size” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsFontSize(SBMLDocument *document)

Returns the value of the “font-size” attribute of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “font-size” attribute of the RenderGroup of the Style for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsFontSize(SBMLDocument *document, const double fontSize, int layoutIndex = 0)

Sets the value of the “font-size” attribute of the RenderGroup of the Style of the TextGlyph objects associated with all ReactionGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontSize – a double value to use as the value of the “font-size” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setFontSizes(SBMLDocument *document, const double fontSize, int layoutIndex = 0)

Sets the value of the “font-size” attribute of the RenderGroup of the Style of the TextGlyph objects associated with all GraphicalObject objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontSize – a double value to use as the value of the “font-size” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getEmptySpeciesFontSize(SBMLDocument *document)
int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setEmptySpeciesFontSize(SBMLDocument *document, const double fontSize, int layoutIndex)
bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetFontWeight(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Predicates returning true if the “font-weight” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject is set.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the “font-weight” attribute of the RenderGroup of the Style for this GraphicalObject is set, false if either the “font-weight” attribute is not set

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getFontWeight(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Returns the value of the “font-weight” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “font-weight” attribute of the RenderGroup of the Style for this GraphicalObject, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setFontWeight(SBMLDocument *document, const char *id, const char *fontWeight, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Sets the value of the “font-weight” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • fontWeight – a string value to use as the value of the “font-weight” attribute of the RenderGroup of the Style for this GraphicalObject.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsFontWeight(SBMLDocument *document)

Returns the value of the “font-weight” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “font-weight” attribute of the RenderGroup of the Style for all CompartmentGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsFontWeight(SBMLDocument *document, const char *fontWeight, int layoutIndex = 0)

Sets the value of the “font-weight” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontWeight – a string value to use as the value of the “font-weight” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesFontWeight(SBMLDocument *document)

Returns the value of the “font-weight” attribute of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “font-weight” attribute of the RenderGroup of the Style for all SpeciesGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesFontWeight(SBMLDocument *document, const char *fontWeight, int layoutIndex = 0)

Sets the value of the “font-weight” attribute of the RenderGroup of the Style of the TextGlyph objects associated with all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontWeight – a string value to use as the value of the “font-weight” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsFontWeight(SBMLDocument *document)

Returns the value of the “font-weight” attribute of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “font-weight” attribute of the RenderGroup of the Style for all ReactionGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsFontWeight(SBMLDocument *document, const char *fontWeight, int layoutIndex = 0)

Sets the value of the “font-weight” attribute of the RenderGroup of the Style of the TextGlyph objects associated with all ReactionGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontWeight – a string value to use as the value of the “font-weight” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setFontWeights(SBMLDocument *document, const char *fontWeight, int layoutIndex = 0)

Sets the value of the “font-weight” attribute of the RenderGroup of the Style of the TextGlyph objects associated with all GraphicalObject objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontWeight – a string value to use as the value of the “font-weight” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getEmptySpeciesFontWeight(SBMLDocument *document)
int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setEmptySpeciesFontWeight(SBMLDocument *document, const char *fontWeight, int layoutIndex)
bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetFontStyle(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Predicates returning true if the “font-style” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

  • textGlyphIndex – the index of the TextGlyph to return.

Returns:

true if the “font-style” attribute of the RenderGroup of the Style for this GraphicalObject is set, false if either the “font-style” attribute is not set

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getFontStyle(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Returns the value of the “font-style” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “font-style” attribute of the RenderGroup of the Style for this GraphicalObject, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setFontStyle(SBMLDocument *document, const char *id, const char *fontStyle, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Sets the value of the “font-style” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • fontStyle – a string value to use as the value of the “font-style” attribute of the RenderGroup of the Style for this GraphicalObject.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsFontStyle(SBMLDocument *document)

Returns the value of the “font-style” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “font-style” attribute of the RenderGroup of the Style for all CompartmentGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsFontStyle(SBMLDocument *document, const char *fontStyle, int layoutIndex = 0)

Sets the value of the “font-style” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontStyle – a string value to use as the value of the “font-style” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesFontStyle(SBMLDocument *document)

Returns the value of the “font-style” attribute of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “font-style” attribute of the RenderGroup of the Style for all SpeciesGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesFontStyle(SBMLDocument *document, const char *fontStyle, int layoutIndex = 0)

Sets the value of the “font-style” attribute of the RenderGroup of the Style of the TextGlyph objects associated with all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontStyle – a string value to use as the value of the “font-style” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsFontStyle(SBMLDocument *document)

Returns the value of the “font-style” attribute of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “font-style” attribute of the RenderGroup of the Style for all ReactionGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsFontStyle(SBMLDocument *document, const char *fontStyle, int layoutIndex = 0)

Sets the value of the “font-style” attribute of the RenderGroup of the the Style of the TextGlyph objects associated with of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontStyle – a string value to use as the value of the “font-style” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setFontStyles(SBMLDocument *document, const char *fontStyle, int layoutIndex = 0)

Sets the value of the “font-style” attribute of the RenderGroup of the the Style of the TextGlyph objects associated with of all GraphicalObject objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • fontStyle – a string value to use as the value of the “font-style” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getEmptySpeciesFontStyle(SBMLDocument *document)
int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setEmptySpeciesFontStyle(SBMLDocument *document, const char *fontStyle, int layoutIndex)
bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetTextHorizontalAlignment(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Predicates returning true if the “text-anchor” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the “text-anchor” attribute of the RenderGroup of the Style for this GraphicalObject is set, false if either the “text-anchor” attribute is not set

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getTextHorizontalAlignment(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Returns the value of the “text-anchor” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “text-anchor” attribute of the RenderGroup of the Style for this GraphicalObject, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setTextHorizontalAlignment(SBMLDocument *document, const char *id, const char *textHorizontalAlignment, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Sets the value of the “text-anchor” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • textHorizontalAlignment – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of the Style for this GraphicalObject.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsTextHorizontalAlignment(SBMLDocument *document)

Returns the value of the “text-anchor” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “text-anchor” attribute of the RenderGroup of the Style for all CompartmentGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsTextHorizontalAlignment(SBMLDocument *document, const char *textHorizontalAlignment, int layoutIndex = 0)

Sets the value of the “text-anchor” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • textHorizontalAlignment – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesTextHorizontalAlignment(SBMLDocument *document)

Returns the value of the “text-anchor” attribute of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “text-anchor” attribute of the RenderGroup of the Style for all SpeciesGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesTextHorizontalAlignment(SBMLDocument *document, const char *textHorizontalAlignment, int layoutIndex = 0)

Sets the value of the “text-anchor” attribute of the RenderGroup of the Style of the TextGlyph objects associated with all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • textHorizontalAlignment – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsTextHorizontalAlignment(SBMLDocument *document)

Returns the value of the “text-anchor” attribute of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “text-anchor” attribute of the RenderGroup of the Style for all ReactionGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsTextHorizontalAlignment(SBMLDocument *document, const char *textHorizontalAlignment, int layoutIndex = 0)

Sets the value of the “text-anchor” attribute of the RenderGroup of the the Style of the TextGlyph objects associated with of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • textHorizontalAlignment – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setTextHorizontalAlignments(SBMLDocument *document, const char *textHorizontalAlignment, int layoutIndex = 0)

Sets the value of the “text-anchor” attribute of the RenderGroup of the the Style of the TextGlyph objects associated with of all GraphicalObject objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • textHorizontalAlignment – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetTextVerticalAlignment(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Predicates returning true if the “text-anchor” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the “text-anchor” attribute of the RenderGroup of the Style for this GraphicalObject is set, false if either the “text-anchor” attribute is not set

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getEmptySpeciesTextVerticalAlignment(SBMLDocument *document)

Returns the valj.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setEmptySpeciesTextVerticalAlignment(SBMLDocument *document, const char *textVerticalAlignment, int layoutIndex)
const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getTextVerticalAlignment(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Returns the value of the “text-anchor” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “text-anchor” attribute of the RenderGroup of the Style for this GraphicalObject, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setTextVerticalAlignment(SBMLDocument *document, const char *id, const char *textVerticalAlignment, int graphicalObjectIndex = 0, int textGlyphIndex = 0, int layoutIndex = 0)

Sets the value of the “text-anchor” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • textVerticalAlignment – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of the Style for this GraphicalObject.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • textGlyphIndex – the index of the TextGlyph to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsTextVerticalAlignment(SBMLDocument *document)

Returns the value of the “text-anchor” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “text-anchor” attribute of the RenderGroup of the Style for all CompartmentGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsTextVerticalAlignment(SBMLDocument *document, const char *textVerticalAlignment, int layoutIndex = 0)

Sets the value of the “text-anchor” attribute of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • textVerticalAlignment – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesTextVerticalAlignment(SBMLDocument *document)

Returns the value of the “text-anchor” attribute of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “text-anchor” attribute of the RenderGroup of the Style for all SpeciesGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesTextVerticalAlignment(SBMLDocument *document, const char *textVerticalAlignment, int layoutIndex = 0)

Sets the value of the “text-anchor” attribute of the RenderGroup of the Style of the TextGlyph objects associated with all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • textVerticalAlignment – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsTextVerticalAlignment(SBMLDocument *document)

Returns the value of the “text-anchor” attribute of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “text-anchor” attribute of the RenderGroup of the Style for all ReactionGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsTextVerticalAlignment(SBMLDocument *document, const char *textVerticalAlignment, int layoutIndex = 0)

Sets the value of the “text-anchor” attribute of the RenderGroup of the the Style of the TextGlyph objects associated with of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • textVerticalAlignment – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setTextVerticalAlignments(SBMLDocument *document, const char *textVerticalAlignment, int layoutIndex = 0)

Sets the value of the “text-anchor” attribute of the RenderGroup of the the Style of the TextGlyph objects associated with of all GraphicalObject objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • textVerticalAlignment – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of the Style for these GraphicalObject objects.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getEmptySpeciesTextVerticalAlignment(SBMLDocument *document)

Returns the valj.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setEmptySpeciesTextVerticalAlignment(SBMLDocument *document, const char *textVerticalAlignment, int layoutIndex)
bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetStartHead(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the “startHead” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the “startHead” attribute of the RenderGroup of the Style for this GraphicalObject is set, false if either the “startHead” attribute is not set

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getStartHead(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “startHead” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “startHead” attribute of the RenderGroup of the Style for this GraphicalObject, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setStartHead(SBMLDocument *document, const char *id, const char *startHead, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “startHead” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • startHead – a string value to use as the value of the “startHead” attribute of the RenderGroup of the Style for this GraphicalObject.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetEndHead(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the “endHead” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

true if the “endHead” attribute of the RenderGroup of the Style for this GraphicalObject is set, false if either the “endHead” attribute is not set

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getEndHead(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “endHead” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the “endHead” attribute of the RenderGroup of the Style for this GraphicalObject, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setEndHead(SBMLDocument *document, const char *id, const char *endHead, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “endHead” attribute of the RenderGroup of the Style that matches this id of model entity associated with the GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • endHead – a string value to use as the value of the “endHead” attribute of the RenderGroup of the Style for this GraphicalObject.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumGeometricShapes(SBMLDocument *document, const char *id, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns number of Transformation2D objects in the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the number of Transformation2D objects in the RenderGroup of the Style for this GraphicalObject, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_addGeometricShape(SBMLDocument *document, const char *id, const char *shape, int graphicalObjectIndex = 0, int layoutIndex = 0)

Add a geometric shape to the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • shape – a string value indicating the shape of the geometric shape to be added.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_removeGeometricShape(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Remove a geometric shape from the RenderGroup of the that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeType(SBMLDocument *document, const char *id, int geometricShapeIndex, int graphicalObjectIndex, int layoutIndex)

@breif Returns the type of the geometric shape of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

the type of the geometric shape of the RenderGroup of the Style for this GraphicalObject, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeType(SBMLDocument *document, const char *id, const char *shape, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the geometric shape as the single geometric shape of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • shape – a string value indicating the shape of the geometric shape to be set.

  • graphicalObjectIndex – the index of the GraphicalObject to return.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

Warning

doxygenfunction: Cannot find function “LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapesId” in doxygen xml output for project “SBMLNetwork” from directory: doxygen/xml

Warning

doxygenfunction: Cannot find function “LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapesId” in doxygen xml output for project “SBMLNetwork” from directory: doxygen/xml

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeType(SBMLDocument *document)

Returns the type of the geometric shape of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the type of the geometric shape of the RenderGroup of the Style for all CompartmentGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeType(SBMLDocument *document, const char *shape, int layoutIndex = 0)

Sets the geometric shape as the single geometric shape of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • shape – a string value indicating the shape of the geometric shape to be set.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeType(SBMLDocument *document)

Returns the type of the geometric shape of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the type of the geometric shape of the RenderGroup of the Style for all SpeciesGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeType(SBMLDocument *document, const char *shape, int layoutIndex = 0)

Sets the geometric shape as the single geometric shape of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • shape – a string value indicating the shape of the geometric shape to be set.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeType(SBMLDocument *document)

Returns the type of the geometric shape of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the type of the geometric shape of the RenderGroup of the Style for all ReactionGlyph objects, or "" if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeType(SBMLDocument *document, const char *shape, int layoutIndex = 0)

Sets the geometric shape as the single geometric shape of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • shape – a string value indicating the shape of the geometric shape to be set.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapesType(SBMLDocument *document, const char *shape, int layoutIndex = 0)

Sets the geometric shape as the single geometric shape of the RenderGroup of the Style of all GraphicalObjects objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • shape – a string value indicating the shape of the geometric shape to be set.

  • layoutIndex – the index number of the Layout to return.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getEmptySpeciesGeometricShapeType(SBMLDocument *document)
int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setEmptySpeciesGeometricShapeType(SBMLDocument *document, const char *shape, int layoutIndex)
bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isRectangle(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject is of type Rectangle.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Rectangle, false if it is not of type Rectangle or is or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSquare(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject is of type Square.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Square, false if it is not of type Square or is or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isEllipse(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject is of type Ellipse.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Ellipse, false if it is not of type Ellipse or is or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isCircle(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject is of type Circle.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Circle, false if it is not of type Circle or is or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isPolygon(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject is of type Polygon.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Polygon, false if it is not of type Polygon or is or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isImage(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject is of type Image.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Image, false if it is not of type Image or is or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isRenderCurve(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject is of type RenderCurve.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type RenderCurve, false if it is not of type RenderCurve or is or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isText(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject is of type Text.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Text, false if it is not of type Text or is or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetGeometricShapeBorderColor(SBMLDocument *document, const char *id, int geometricShapeIndex, int graphicalObjectIndex, int layoutIndex)

Predicates returning true if the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the “stroke” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeBorderColor(SBMLDocument *document, const char *id, int geometricShapeIndex, int graphicalObjectIndex, int layoutIndex)

Returns the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “stroke” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or "" if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeBorderColor(SBMLDocument *document, const char *id, const char *borderColor, int geometricShapeIndex, int graphicalObjectIndex, int layoutIndex)

Sets the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • borderColor – a string value to use as the value of the “stroke” attribute of the Transformation2D object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetGeometricShapeBorderWidth(SBMLDocument *document, const char *id, int geometricShapeIndex, int graphicalObjectIndex, int layoutIndex)

Predicates returning true if the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the “stroke-width” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeBorderWidth(SBMLDocument *document, const char *id, int geometricShapeIndex, int graphicalObjectIndex, int layoutIndex)

Returns the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “stroke-width” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or 0.0 if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeBorderWidth(SBMLDocument *document, const char *id, const double borderWidth, int geometricShapeIndex, int graphicalObjectIndex, int layoutIndex)

Sets the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • borderWidth – a double value to use as the value of the “stroke-width” attribute of the Transformation2D object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetGeometricShapeFillColor(SBMLDocument *document, const char *id, int geometricShapeIndex, int graphicalObjectIndex, int layoutIndex)

Predicates returning true if the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the “fill” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeFillColor(SBMLDocument *document, const char *id, int geometricShapeIndex, int graphicalObjectIndex, int layoutIndex)

Returns the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “fill” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or "" if the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeFillColor(SBMLDocument *document, const char *id, const char *fillColor, int geometricShapeIndex, int graphicalObjectIndex, int layoutIndex)

Sets the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • fillColor – a string value to use as the value of the “fill” attribute of the Transformation2D object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeFillColorAsGradient(SBMLDocument *document, const char *id, const char *gradientType, const char **stopColors, const double *stopOffsets, const int stopsSize, int geometricShapeIndex, int graphicalObjectIndex, int layoutIndex)
bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetGeometricShapeX(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the “x” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the “x” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set, false if either the “x” attribute is not set or the object is NULL .

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeX(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “x” attribute of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “x” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or RelAbsVector() if either Transformation2D object does not exists, does not have “x” attribute, it is not set, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeX(SBMLDocument *document, const char *id, const double x, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

  • x – a double to use as the value of the “x” attribute of this Transformation2D object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeX(SBMLDocument *document)

Returns the value of the “x” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “x” attribute of the Transformation2D object for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeX(SBMLDocument *document, const double x, int layoutIndex = 0)

Sets the value of the “x” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • x – a double to use as the value of the “x” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeX(SBMLDocument *document)

Returns the value of the “x” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “x” attribute of the Transformation2D object for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeX(SBMLDocument *document, const double x, int layoutIndex = 0)

Sets the value of the “x” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • x – a double to use as the value of the “x” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeX(SBMLDocument *document)

Returns the value of the “x” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “x” attribute of the Transformation2D object for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeX(SBMLDocument *document, const double x, int layoutIndex = 0)

Sets the value of the “x” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • x – a double to use as the value of the “x” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeXs(SBMLDocument *document, const double x, int layoutIndex = 0)

Sets the value of the “x” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • x – a double to use as the value of the “x” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetGeometricShapeY(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the “y” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the “y” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set, false if either the “y” attribute is not set or the object is NULL .

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeY(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “y” attribute of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “y” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or 0.0 if either Transformation2D object does not exists, does not have “y” attribute, it is not set, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeY(SBMLDocument *document, const char *id, const double y, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

  • y – a double to use as the value of the “y” attribute of this Transformation2D object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeY(SBMLDocument *document)

Returns the value of the “y” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “y” attribute of the Transformation2D object for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeY(SBMLDocument *document, const double y, int layoutIndex = 0)

Sets the value of the “y” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • y – a double to use as the value of the “y” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeY(SBMLDocument *document)

Returns the value of the “y” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “y” attribute of the Transformation2D object for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeY(SBMLDocument *document, const double y, int layoutIndex = 0)

Sets the value of the “y” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • y – a double to use as the value of the “y” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeY(SBMLDocument *document)

Returns the value of the “y” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “y” attribute of the Transformation2D object for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeY(SBMLDocument *document, const double y, int layoutIndex = 0)

Sets the value of the “y” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • y – a double to use as the value of the “y” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeYs(SBMLDocument *document, const double y, int layoutIndex = 0)

Sets the value of the “y” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • y – a double to use as the value of the “y” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetGeometricShapeWidth(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the “width” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the “width” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set, false if either the “width” attribute is not set or the object is NULL .

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeWidth(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “width” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or 0.0 if either Transformation2D object does not exists, does not have “width” attribute, it is not set, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeWidth(SBMLDocument *document, const char *id, const double width, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

  • width – a double to use as the value of the “width” attribute of this Transformation2D object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeWidth(SBMLDocument *document)

Returns the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “width” attribute of the Transformation2D object for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeWidth(SBMLDocument *document, const double width, int layoutIndex = 0)

Returns the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • width – a double to use as the value of the “width” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeWidth(SBMLDocument *document)

Returns the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “width” attribute of the Transformation2D object for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeWidth(SBMLDocument *document, const double width, int layoutIndex = 0)

Returns the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • width – a double to use as the value of the “width” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeWidth(SBMLDocument *document)

Returns the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “width” attribute of the Transformation2D object for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeWidth(SBMLDocument *document, const double width, int layoutIndex = 0)

Sets the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • width – a double to use as the value of the “width” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeWidths(SBMLDocument *document, const double width, int layoutIndex = 0)

Sets the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • width – a double to use as the value of the “width” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetGeometricShapeHeight(SBMLDocument *document, const char *id, int geometricShapeIndex, int graphicalObjectIndex, int layoutIndex)

@breif Predicates returning true if the “height” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the “height” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set, false if either the “height” attribute is not set or the object is NULL .

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeHeight(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “height” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or 0.0 if either Transformation2D object does not exists, does not have “height” attribute, it is not set, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeHeight(SBMLDocument *document, const char *id, const double height, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

  • height – a double to use as the value of the “height” attribute of this Transformation2D object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeHeight(SBMLDocument *document)

Returns the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “height” attribute of the Transformation2D object for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeHeight(SBMLDocument *document, const double height, int layoutIndex = 0)

Returns the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • height – a double to use as the value of the “height” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeHeight(SBMLDocument *document)

Returns the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “height” attribute of the Transformation2D object for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeHeight(SBMLDocument *document, const double height, int layoutIndex = 0)

Returns the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • height – a double to use as the value of the “height” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeHeight(SBMLDocument *document)

Returns the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “height” attribute of the Transformation2D object for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeHeight(SBMLDocument *document, const double height, int layoutIndex = 0)

Sets the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • height – a double to use as the value of the “height” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeHeights(SBMLDocument *document, const double height, int layoutIndex = 0)

Sets the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • height – a double to use as the value of the “height” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetGeometricShapeRatio(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the “ratio” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set, false if either the “ratio” attribute is not set or the object is NULL .

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeRatio(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “ratio” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or 0.0 if either Transformation2D object does not exists, does not have “ratio” attribute, it is not set, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeRatio(SBMLDocument *document, const char *id, const double ratio, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • ratio – a double to use as the value of the “ratio” attribute of this Transformation2D object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeRatio(SBMLDocument *document)

Returns the value of the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “ratio” attribute of the Transformation2D object for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeRatio(SBMLDocument *document, const double ratio, int layoutIndex = 0)

Returns the value of the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • ratio – a double to use as the value of the “ratio” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeRatio(SBMLDocument *document)

Returns the value of the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “ratio” attribute of the Transformation2D object for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeRatio(SBMLDocument *document, const double ratio, int layoutIndex = 0)

Returns the value of the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • ratio – a double to use as the value of the “ratio” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeRatio(SBMLDocument *document)

Returns the value of the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “ratio” attribute of the Transformation2D object for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeRatio(SBMLDocument *document, const double ratio, int layoutIndex = 0)

Sets the value of the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • ratio – a double to use as the value of the “ratio” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeRatios(SBMLDocument *document, const double ratio, int layoutIndex = 0)

Sets the value of the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • ratio – a double to use as the value of the “ratio” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetGeometricShapeBorderRadiusX(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the “rx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set, false if either the “rx” attribute is not set or the object is NULL .

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeBorderRadiusX(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “rx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or 0.0 if either Transformation2D object does not exists, does not have “rx” attribute, it is not set, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeBorderRadiusX(SBMLDocument *document, const char *id, const double borderRadiusX, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • borderRadiusX – a double to use as the value of the “rx” attribute of this Transformation2D object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeBorderRadiusX(SBMLDocument *document)

Returns the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “rx” attribute of the Transformation2D object for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeBorderRadiusX(SBMLDocument *document, const double borderRadiusX, int layoutIndex = 0)

Returns the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • borderRadiusX – a double to use as the value of the “rx” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeBorderRadiusX(SBMLDocument *document)

Returns the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “rx” attribute of the Transformation2D object for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeBorderRadiusX(SBMLDocument *document, const double borderRadiusX, int layoutIndex = 0)

Returns the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • borderRadiusX – a double to use as the value of the “rx” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeBorderRadiusX(SBMLDocument *document)

Returns the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “rx” attribute of the Transformation2D object for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeBorderRadiusX(SBMLDocument *document, const double borderRadiusX, int layoutIndex = 0)

Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • borderRadiusX – a double to use as the value of the “rx” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeBorderRadiusXs(SBMLDocument *document, const double borderRadiusX, int layoutIndex = 0)

Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • borderRadiusX – a double to use as the value of the “rx” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetGeometricShapeBorderRadiusY(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the “ry” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set, false if either the “ry” attribute is not set or the object is NULL .

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeBorderRadiusY(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “ry” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or 0.0 if either Transformation2D object does not exists, does not have “ry” attribute, it is not set, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeBorderRadiusY(SBMLDocument *document, const char *id, const double borderRadiusY, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • borderRadiusY – a double to use as the value of the “ry” attribute of this Transformation2D object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeBorderRadiusY(SBMLDocument *document)

Returns the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “ry” attribute of the Transformation2D object for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeBorderRadiusY(SBMLDocument *document, const double borderRadiusY, int layoutIndex = 0)

Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • borderRadiusY – a double to use as the value of the “ry” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeBorderRadiusY(SBMLDocument *document)

Returns the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “ry” attribute of the Transformation2D object for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeBorderRadiusY(SBMLDocument *document, const double borderRadiusY, int layoutIndex = 0)

Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • borderRadiusY – a double to use as the value of the “ry” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeBorderRadiusY(SBMLDocument *document)

Returns the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “ry” attribute of the Transformation2D object for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeBorderRadiusY(SBMLDocument *document, const double borderRadiusY, int layoutIndex = 0)

Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • borderRadiusY – a double to use as the value of the “ry” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeBorderRadiusYs(SBMLDocument *document, const double borderRadiusY, int layoutIndex = 0)

Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • borderRadiusY – a double to use as the value of the “ry” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetGeometricShapeCenterX(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the “cx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set, false if either the “cx” attribute is not set or the object is NULL .

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeCenterX(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “cx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or 0.0 if either Transformation2D object does not exists, does not have “cx” attribute, it is not set, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeCenterX(SBMLDocument *document, const char *id, const double centerX, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • centerX – a double to use as the value of the “cx” attribute of this Transformation2D object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeCenterX(SBMLDocument *document)

Returns the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “cx” attribute of the Transformation2D object for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeCenterX(SBMLDocument *document, const double centerX, int layoutIndex = 0)

Sets the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • centerX – a double to use as the value of the “cx” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeCenterX(SBMLDocument *document)

Returns the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “cx” attribute of the Transformation2D object for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeCenterX(SBMLDocument *document, const double centerX, int layoutIndex = 0)

Sets the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • centerX – a double to use as the value of the “cx” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeCenterX(SBMLDocument *document)

Returns the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “cx” attribute of the Transformation2D object for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeCenterX(SBMLDocument *document, const double centerX, int layoutIndex = 0)

Sets the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • centerX – a double to use as the value of the “cx” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeCenterXs(SBMLDocument *document, const double centerX, int layoutIndex = 0)

Sets the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • centerX – a double to use as the value of the “cx” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetGeometricShapeCenterY(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the “cy” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set, false if either the “cy” attribute is not set or the object is NULL .

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeCenterY(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “cy” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or 0.0 if either Transformation2D object does not exists, does not have “cy” attribute, it is not set, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeCenterY(SBMLDocument *document, const char *id, const double centerY, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • centerY – a double to use as the value of the “cy” attribute of this Transformation2D object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeCenterY(SBMLDocument *document)

Returns the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “cy” attribute of the Transformation2D object for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeCenterY(SBMLDocument *document, const double centerY, int layoutIndex = 0)

Sets the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • centerY – a double to use as the value of the “cy” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeCenterY(SBMLDocument *document)

Returns the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “cy” attribute of the Transformation2D object for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeCenterY(SBMLDocument *document, const double centerY, int layoutIndex = 0)

Sets the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • centerY – a double to use as the value of the “cy” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeCenterY(SBMLDocument *document)

Returns the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “cy” attribute of the Transformation2D object for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeCenterY(SBMLDocument *document, const double centerY, int layoutIndex = 0)

Sets the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • centerY – a double to use as the value of the “cy” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeCenterYs(SBMLDocument *document, const double centerY, int layoutIndex = 0)

Sets the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • centerY – a double to use as the value of the “cy” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetGeometricShapeRadiusX(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the “rx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set, false if either the “rx” attribute is not set or the object is NULL .

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeRadiusX(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “rx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or 0.0 if either Transformation2D object does not exists, does not have “rx” attribute, it is not set, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeRadiusX(SBMLDocument *document, const char *id, const double radiusX, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • radiusX – a double to use as the value of the “rx” attribute of this Transformation2D object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeRadiusX(SBMLDocument *document)

Returns the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “rx” attribute of the Transformation2D object for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeRadiusX(SBMLDocument *document, const double radiusX, int layoutIndex = 0)

Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • radiusX – a double to use as the value of the “rx” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeRadiusX(SBMLDocument *document)

Returns the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “rx” attribute of the Transformation2D object for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeRadiusX(SBMLDocument *document, const double radiusX, int layoutIndex = 0)

Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • radiusX – a double to use as the value of the “rx” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeRadiusX(SBMLDocument *document)

Returns the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “rx” attribute of the Transformation2D object for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeRadiusX(SBMLDocument *document, const double radiusX, int layoutIndex = 0)

Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • radiusX – a double to use as the value of the “rx” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeRadiusXs(SBMLDocument *document, const double radiusX, int layoutIndex = 0)

Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • radiusX – a double to use as the value of the “rx” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetGeometricShapeRadiusY(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the “ry” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set, false if either the “ry” attribute is not set or the object is NULL .

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeRadiusY(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “ry” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or 0.0 if either Transformation2D object does not exists, does not have “ry” attribute, it is not set, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeRadiusY(SBMLDocument *document, const char *id, const double radiusY, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

  • radiusY – a double to use as the value of the “ry” attribute of this Transformation2D object.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeRadiusY(SBMLDocument *document)

Returns the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “ry” attribute of the Transformation2D object for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeRadiusY(SBMLDocument *document, const double radiusY, int layoutIndex = 0)

Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • radiusY – a double to use as the value of the “ry” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeRadiusY(SBMLDocument *document)

Returns the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “ry” attribute of the Transformation2D object for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeRadiusY(SBMLDocument *document, const double radiusY, int layoutIndex = 0)

Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • radiusY – a double to use as the value of the “ry” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeRadiusY(SBMLDocument *document)

Returns the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “ry” attribute of the Transformation2D object for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeRadiusY(SBMLDocument *document, const double radiusY, int layoutIndex = 0)

Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • radiusY – a double to use as the value of the “ry” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeRadiusYs(SBMLDocument *document, const double radiusY, int layoutIndex = 0)

Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • radiusY – a double to use as the value of the “ry” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeNumSegments(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the number of elements of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the number of elements of the Transformation2D object at the given index of the RenderGroup of this Style for this GraphicalObject, or 0 if either Transformation2D object does not exists, does not have any elements, or the object is NULL.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isGeometricShapeSegmentCubicBezier(SBMLDocument *document, const char *id, int segmentIndex = 0, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject is of type RenderCubicBezier.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • segmentIndex – an int representing the index of the element to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is of type RenderCubicBezier,

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeSegmentX(SBMLDocument *document, const char *id, int segmentIndex = 0, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “x” attribute of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • segmentIndex – an int representing the index of the element to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “x” attribute of the element with the given index of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or 0.0 if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeSegmentX(SBMLDocument *document, const char *id, const double x, int segmentIndex = 0, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • x – a double to use as the value of the “x” attribute of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeSegmentX(SBMLDocument *document)

Returns the value of the “x” attribute of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “x” attribute of the element for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeSegmentX(SBMLDocument *document, const double x, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • x – a double to use as the value of the “x” attribute of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeSegmentX(SBMLDocument *document)

Returns the value of the “x” attribute of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “x” attribute of the element for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeSegmentX(SBMLDocument *document, const double x, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • x – a double to use as the value of the “x” attribute of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeSegmentX(SBMLDocument *document)

Returns the value of the “x” attribute of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “x” attribute of the element for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeSegmentX(SBMLDocument *document, const double x, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • x – a double to use as the value of the “x” attribute of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeSegmentXs(SBMLDocument *document, const double x, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • x – a double to use as the value of the “x” attribute of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeSegmentY(SBMLDocument *document, const char *id, int segmentIndex = 0, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “y” attribute of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • segmentIndex – an int representing the index of the element to retrieve.

  • segmentIndex – an int representing the index of the element to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “y” attribute of the element with the given index of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or 0.0 if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeSegmentY(SBMLDocument *document, const char *id, const double y, int segmentIndex = 0, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • y – a double to use as the value of the “y” attribute of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeSegmentY(SBMLDocument *document)

Returns the value of the “y” attribute of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “y” attribute of the element for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeSegmentY(SBMLDocument *document, const double y, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • y – a double to use as the value of the “y” attribute of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeSegmentY(SBMLDocument *document)

Returns the value of the “y” attribute of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “y” attribute of the element for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeSegmentY(SBMLDocument *document, const double y, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • y – a double to use as the value of the “y” attribute of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeSegmentY(SBMLDocument *document)

Returns the value of the “y” attribute of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “y” attribute of the element for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeSegmentY(SBMLDocument *document, const double y, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • y – a double to use as the value of the “y” attribute of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeSegmentYs(SBMLDocument *document, const double y, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • y – a double to use as the value of the “y” attribute of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeSegmentBasePoint1X(SBMLDocument *document, const char *id, int segmentIndex = 0, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “x” attribute of base point 1 of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • segmentIndex – an int representing the index of the element to retrieve.

  • segmentIndex – an int representing the index of the element to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “x” attribute of the base point 1 of the element with the given index of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or 0.0 if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeSegmentBasePoint1X(SBMLDocument *document, const char *id, const double x, int segmentIndex = 0, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of base point 1 of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • x – a double to use as the value of the “x” attribute of base point 1 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeSegmentBasePoint1X(SBMLDocument *document)

Returns the value of the “x” attribute of base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “x” attribute of base point 1 of the element for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeSegmentBasePoint1X(SBMLDocument *document, const double x, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • x – a double to use as the value of the “x” attribute of base point 1 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeSegmentBasePoint1X(SBMLDocument *document)

Returns the value of the “x” attribute of base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “x” attribute of base point 1 of the element for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeSegmentBasePoint1X(SBMLDocument *document, const double x, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • x – a double to use as the value of the “x” attribute of base point 1 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeSegmentBasePoint1X(SBMLDocument *document)

Returns the value of the “x” attribute of base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “x” attribute of base point 1 of the element for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeSegmentBasePoint1X(SBMLDocument *document, const double x, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of base point 1 of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • x – a double to use as the value of the “x” attribute of base point 1 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeSegmentBasePoint1Xs(SBMLDocument *document, const double x, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of base point 1 of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • x – a double to use as the value of the “x” attribute of base point 1 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeSegmentBasePoint1Y(SBMLDocument *document, const char *id, int segmentIndex = 0, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “y” attribute of base point 1 of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • segmentIndex – an int representing the index of the element to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “y” attribute of the base point 1 of the element with the given index of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or 0.0 if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeSegmentBasePoint1Y(SBMLDocument *document, const char *id, const double y, int segmentIndex = 0, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of base point 1 of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • y – a double to use as the value of the “y” attribute of base point 1 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeSegmentBasePoint1Y(SBMLDocument *document)

Returns the value of the “y” attribute of base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “y” attribute of base point 1 of the element for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeSegmentBasePoint1Y(SBMLDocument *document, const double y, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • y – a double to use as the value of the “y” attribute of base point 1 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeSegmentBasePoint1Y(SBMLDocument *document)

Returns the value of the “y” attribute of base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “y” attribute of base point 1 of the element for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeSegmentBasePoint1Y(SBMLDocument *document, const double y, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • y – a double to use as the value of the “y” attribute of base point 1 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeSegmentBasePoint1Y(SBMLDocument *document)

Returns the value of the “y” attribute of base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “y” attribute of base point 1 of the element for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeSegmentBasePoint1Y(SBMLDocument *document, const double y, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of base point 1 of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • y – a double to use as the value of the “y” attribute of base point 1 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeSegmentBasePoint1Ys(SBMLDocument *document, const double y, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of base point 1 of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • y – a double to use as the value of the “y” attribute of base point 1 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeSegmentBasePoint2X(SBMLDocument *document, const char *id, int segmentIndex = 0, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “x” attribute of base point 2 of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • segmentIndex – an int representing the index of the element to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “x” attribute of the base point 2 of the element with the given index of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or 0.0 if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeSegmentBasePoint2X(SBMLDocument *document, const char *id, const double x, int segmentIndex = 0, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of base point 2 of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • x – a double to use as the value of the “x” attribute of base point 2 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeSegmentBasePoint2X(SBMLDocument *document)

Returns the value of the “x” attribute of base point 2 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “x” attribute of base point 2 of the element for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeSegmentBasePoint2X(SBMLDocument *document, const double x, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of base point 2 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • x – a double to use as the value of the “x” attribute of base point 2 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeSegmentBasePoint2X(SBMLDocument *document)

Returns the value of the “x” attribute of base point 2 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “x” attribute of base point 2 of the element for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeSegmentBasePoint2X(SBMLDocument *document, const double x, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of base point 2 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • x – a double to use as the value of the “x” attribute of base point 2 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeSegmentBasePoint2X(SBMLDocument *document)

Returns the value of the “x” attribute of base point 2 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “x” attribute of base point 2 of the element for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeSegmentBasePoint2X(SBMLDocument *document, const double x, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of base point 2 of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • x – a double to use as the value of the “x” attribute of base point 2 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeSegmentBasePoint2Xs(SBMLDocument *document, const double x, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “x” attribute of base point 2 of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • x – a double to use as the value of the “x” attribute of base point 2 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeSegmentBasePoint2Y(SBMLDocument *document, const char *id, int segmentIndex = 0, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “y” attribute of base point 2 of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • segmentIndex – an int representing the index of the element to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “y” attribute of the base point 2 of the element with the given index of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or 0.0 if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeSegmentBasePoint2Y(SBMLDocument *document, const char *id, const double y, int segmentIndex = 0, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of base point 2 of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • y – a double to use as the value of the “y” attribute of base point 2 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeSegmentBasePoint2Y(SBMLDocument *document)

Returns the value of the “y” attribute of base point 2 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “y” attribute of base point 2 of the element for all CompartmentGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeSegmentBasePoint2Y(SBMLDocument *document, const double y, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of base point 2 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • y – a double to use as the value of the “y” attribute of base point 2 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeSegmentBasePoint2Y(SBMLDocument *document)

Returns the value of the “y” attribute of base point 2 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “y” attribute of base point 2 of the element for all SpeciesGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeSegmentBasePoint2Y(SBMLDocument *document, const double y, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of base point 2 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • y – a double to use as the value of the “y” attribute of base point 2 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const double LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeSegmentBasePoint2Y(SBMLDocument *document)

Returns the value of the “y” attribute of base point 2 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “y” attribute of base point 2 of the element for all ReactionGlyph objects, or 0.0 if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeSegmentBasePoint2Y(SBMLDocument *document, const double y, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of base point 2 of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • y – a double to use as the value of the “y” attribute of base point 2 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeSegmentBasePoint2Ys(SBMLDocument *document, const double y, int segmentIndex = 0, int layoutIndex = 0)

Sets the value of the “y” attribute of base point 2 of element at the given index of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • y – a double to use as the value of the “y” attribute of base point 2 of this element.

  • segmentIndex – an int representing the index of the element to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_isSetGeometricShapeHref(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Predicates returning true if the “href” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

true if the “href” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set, false if either the “href” attribute is not set or the object is NULL .

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getGeometricShapeHref(SBMLDocument *document, const char *id, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Returns the value of the “href” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

the “href” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject, or NULL if either Transformation2D object does not exists, does not have “href” attribute, it is not set, or the object is NULL.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeHref(SBMLDocument *document, const char *id, const char *href, int geometricShapeIndex = 0, int graphicalObjectIndex = 0, int layoutIndex = 0)

Sets the value of the “href” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this id of model entity associated with GraphicalObject.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • id – the id of a model entity.

  • href – a string to use as the value of the “href” attribute of this Transformation2D object.

  • geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.

  • graphicalObjectIndex – an int representing the index of the GraphicalObject to retrieve.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getCompartmentsGeometricShapeHref(SBMLDocument *document)

Returns the value of the “href” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “href” attribute of the Transformation2D object for all CompartmentGlyph objects, or NULL if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setCompartmentsGeometricShapeHref(SBMLDocument *document, const char *href, int layoutIndex = 0)

Sets the value of the “href” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all CompartmentGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • href – a string to use as the value of the “href” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getSpeciesGeometricShapeHref(SBMLDocument *document)

Returns the value of the “href” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “href” attribute of the Transformation2D object for all SpeciesGlyph objects, or NULL if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setSpeciesGeometricShapeHref(SBMLDocument *document, const char *href, int layoutIndex = 0)

Sets the value of the “href” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all SpeciesGlyph objects in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • href – a string to use as the value of the “href” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getReactionsGeometricShapeHref(SBMLDocument *document)

Returns the value of the “href” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph objects in this Layout object.

Parameters:

document – a pointer to the SBMLDocument object.

Returns:

the “href” attribute of the Transformation2D object for all ReactionGlyph objects, or NULL if the object is NULL

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setReactionsGeometricShapeHref(SBMLDocument *document, const char *href, int layoutIndex = 0)

Sets the value of the “href” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all ReactionGlyph object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • href – a string to use as the value of the “href” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setGeometricShapeHrefs(SBMLDocument *document, const char *href, int layoutIndex = 0)

Sets the value of the “href” attribute of the Transformation2D at the given index of the RenderGroup of the Style of all GraphicalObject object in this Layout object.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • href – a string to use as the value of the “href” attribute of this Transformation2D object.

  • layoutIndex – an int representing the index of the Layout to retrieve.

Returns:

integer value indicating success/failure of the function.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getStyle(SBMLDocument *document, int renderIndex = 0)

Returns the name of the predefined style that is used for the render features.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • renderIndex – an int representing the index of the Render object to retrieve.

Returns:

the name of the predefined style that is used for the render features, or "" if the object is NULL or no predefined style is used.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_setStyle(SBMLDocument *document, const char *styleName, int renderIndex = 0)

Sets the render features using the predefined style with the given name.

Parameters:
  • document – a pointer to the SBMLDocument object.

  • styleName – a string representing the name of the predefined style to use.

  • renderIndex – an int representing the index of the Render object to retrieve.

Returns:

integer value indicating success/failure of the function.

bool LIBSBMLNETWORK_CPP_NAMESPACE::c_api_whetherDisplayReactionTextLabel(const char *styleName)

Sets the render features using the predefined style with the given name for all CompartmentGlyph object in this Layout object.

Parameters:

styleName – a string representing the name of the predefined style to use.

Returns:

integer value indicating success/failure of the function.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumPredefinedStyles()

Returns the number of predefined styles that can be used in for c_api_setStyle function.

Returns:

the number of predefined styles.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getPredefinedStyleName(int index)

Returns the predefined style name with the given index that can be used in for c_api_setStyle function.

Parameters:

index – an int representing the index of the predefined style name to retrieve.

Returns:

the predefined style name with the given index.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumValidRoleValues()

Returns the number of valid values for the “role” attribute that can be used in for c_api_SetSpeciesReferenceRole function.

Returns:

the number of valid values for the “role” attribute.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getValidRoleValue(int index)

Returns the valid value with the given index for the “role” attribute that can be used in for c_api_SetSpeciesReferenceRole function.

Parameters:

index – an int representing the index of the valid value to retrieve.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumValidAlignmentValues()

Returns the number of valid values for the “alignment” attribute that can be used in for c_api_align function.

Returns:

the number of valid values for the “alignment” attribute.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getValidAlignmentValue(int index)

Returns the valid value with the given index for the “alignment” attribute that can be used in for c_api_align function.

Parameters:

index – an int representing the index of the valid value to retrieve.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumValidDistributionDirectionValues()

Returns the number of valid values for the “distribution” direction attribute that can be used in for c_api_setDistribution function.

Returns:

the number of valid values for the “distribution” direction attribute.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getValidDistributionDirectionValue(int index)

Returns the valid value with the given index for the “distribution” direction attribute that can be used in for c_api_setDistribution function.

Parameters:

index – an int representing the index of the valid value to retrieve.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumValidSpreadMethodValues()

Returns the number of valid values for the “spread-method” attribute that can be used in for c_api_setGradientSpreadMethod function.

Returns:

the number of valid values for the “spread-method” attribute.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getValidSpreadMethodValue(int index)

Returns the valid value with the given index for the “spread-method” attribute that can be used in for c_api_setGradientSpreadMethod function.

Parameters:

index – an int representing the index of the valid value to retrieve.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumValidFontWeightValues()

Returns the number of valid values for the “font-weight” attribute that can be used in for all set font weight functions.

Returns:

the number of valid values for the “font-weight” attribute.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getValidFontWeightValue(int index)

Returns the valid value with the given index for the “font-weight” attribute that can be used in for all set font weight functions.

Parameters:

index – an int representing the index of the valid value to retrieve.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumValidFontStyleValues()

Returns the number of valid values for the “font-style” attribute that can be used in for all set font style functions.

Returns:

the number of valid values for the “font-style” attribute.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getValidFontStyleValue(int index)

Returns the valid value with the given index for the “font-style” attribute that can be used in for all set font style functions.

Parameters:

index – an int representing the index of the valid value to retrieve.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumValidHorizontalTextAlignmentValues()

Returns the number of valid values for the “text-anchor” attribute that can be used in for all set text anchor functions.

Returns:

the number of valid values for the “text-anchor” attribute.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getValidHorizontalTextAlignmentValue(int index)

Returns the valid value with the given index for the “text-anchor” attribute that can be used in for all set text anchor functions.

Parameters:

index – an int representing the index of the valid value to retrieve.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumValidVerticalTextAlignmentValues()

Returns the number of valid values for the “vtext-anchor” attribute that can be used in for all set vertical text alignment functions.

Returns:

the number of valid values for the “vtext-anchor” attribute.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getValidVerticalTextAlignmentValue(int index)

Returns the valid value with the given index for the “vtext-anchor” attribute that can be used in for all set vertical text alignment functions.

Parameters:

index – an int representing the index of the valid value to retrieve.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumValidFillRuleValues()

Returns the number of valid values for the “fill-rule” attribute that can be used in for c_api_setFillRule function.

Returns:

the number of valid values for the “fill-rule” attribute.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getValidFillRuleValue(int index)

Returns the valid value with the given index for the “fill-rule” attribute that can be used in for c_api_setFillRule function.

Parameters:

index – an int representing the index of the valid value to retrieve.

int LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getNumValidGeometricShapeValues()

Returns the number of valid values for the “shape” attribute that can be sued in for c_api_setGeometricShape function.

Returns:

the number of valid values for the “shape” attribute.

const char *LIBSBMLNETWORK_CPP_NAMESPACE::c_api_getValidGeometricShapeValue(int index)

Returns the valid value with the given index for the “shape” attribute that can be used in for c_api_setGeometricShape function.

Parameters:

index – an int representing the index of the valid value to retrieve.