C++ API Reference
This is the API reference for the C++ API of the SBMLNetwork library.
SBMLDocument Functions
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getVersion()
Returns the version of the library.
- Returns:
the version of the library.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getCurrentDirectoryOfLibrary()
Returns the current directory of the library.
- Returns:
the current directory of the library.
-
SBMLDocument *LIBSBMLNETWORK_CPP_NAMESPACE::readSBML(const std::string &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::writeSBML(SBMLDocument *document, const std::string &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 std::string LIBSBMLNETWORK_CPP_NAMESPACE::writeSBML(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.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getSBMLLevel(const 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.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getSBMLVersion(const 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.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getErrorLog(const SBMLDocument *document)
Returns the Error log containing the errors and warnings that occurred while working with the SBMLDocument object.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the Error log containing the errors and warnings that occurred while working with the SBMLDocument object.
-
void LIBSBMLNETWORK_CPP_NAMESPACE::clearErrorLog(SBMLDocument *document)
Clears the Error log containing the errors and warnings that occurred while working with the SBMLDocument object.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
boolean value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::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.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::freeUserData(SBMLDocument *document)
@breif Free the user data of the given SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
boolean value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::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::autolayout(SBMLDocument *document, const int maxNumConnectedEdges = 3, bool resetFixedPositionElements = false, std::set<std::pair<std::string, int>> fixedPositionNodesSet = {}, 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 node in the autolayout algorithm..
resetFixedPositionElements – a variable that determines whether to reset the fixed position elements in the autolayout algorithm.
fixedPositionNodesSet – a set of fixed position nodes and their graphical object indices to be used in the autolayout algorithm.
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::autorender(SBMLDocument *document, const int maxNumConnectedEdges = 3)
Create a Render object and add it to the the SBML document if it does not exist.
- Parameters:
document – a pointer to the SBMLDocument object.
maxNumConnectedEdges – the maximum number of connected edges before creating an alias SpeciesGlyph.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::align(SBMLDocument *document, std::set<std::pair<std::string, int>> nodesSet, const std::string &alignment, const 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 – a set of node ids and their graphical object indices to be aligned.
alignment – determines how to align the nodes.
ignoreFixedPositionNodes – a variable that determines whether to ignore the fixed position nodes in the alignment algorithm.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::distribute(SBMLDocument *document, std::set<std::pair<std::string, int>> nodesSet, const std::string &direction, const double spacing = -1)
Distribute the nodes position in the SBML document in the given distribution direction.
- Parameters:
document – a pointer to the SBMLDocument object.
nodes – a set of node ids and their graphical object indices to be distributed.
direction – determines how to distribute the nodes.
spacing – the spacing between the distributed nodes.
- Returns:
integer value indicating success/failure of the function.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumCompartments(const 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 std::string LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentId(SBMLDocument *document, unsigned int index)
Returns the id of the Compartment object with the given index in the given SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
index – 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.
-
Compartment *LIBSBMLNETWORK_CPP_NAMESPACE::getCompartment(SBMLDocument *document, const std::string &id)
Returns a pointer to the Compartment object with the given id.
- Parameters:
document – a pointer to the SBMLDocument object.
id – the id of the Compartment object
- Returns:
a pointer to the Compartment object with the given id, or
""if the object does not exists.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumSpecies(const 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 std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesId(SBMLDocument *document, unsigned int index)
Returns the id of the Species object with the given index in the given SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
index – the index of the Species object.
- Returns:
the id of the Species object with the given index in the given SBML document, or
""if the object does not exists.
-
Species *LIBSBMLNETWORK_CPP_NAMESPACE::getSpecies(SBMLDocument *document, const std::string &id)
Returns a pointer to the Species object with the given id.
- Parameters:
document – a pointer to the SBMLDocument object.
id – the id of the Species object.
- Returns:
a pointer to the Species object with the given id, or
""if the object does not exists.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumReactions(const 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 std::string LIBSBMLNETWORK_CPP_NAMESPACE::getReactionId(SBMLDocument *document, unsigned int index)
Returns the id of the Reaction object with the given index in the given SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
index – 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.
-
Reaction *LIBSBMLNETWORK_CPP_NAMESPACE::getReaction(SBMLDocument *document, const std::string &id)
Returns a pointer to the Reaction object with the given id.
- Parameters:
document – a pointer to the SBMLDocument object.
id – the id of the Reaction object.
- Returns:
a pointer to the Reaction object with the given id, or
""if the object does not exists.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isReversible(SBMLDocument *document, const std::string &reactionId)
Returns true if the Reaction object with the given id is reversible, otherwise returns false.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – the id of the Reaction object.
- Returns:
true if the Reaction object with the given id is reversible, otherwise returns false.
Warning
doxygenfunction: Unable to resolve function “LIBSBMLNETWORK_CPP_NAMESPACE::getNumSpeciesReferences” with arguments (SBMLDocument*, const std::string&) in doxygen xml output for project “SBMLNetwork” from directory: doxygen/xml. Potential matches:
- const unsigned int getNumSpeciesReferences(GraphicalObject *reactionGlyph)
- const unsigned int getNumSpeciesReferences(Layout *layout, const std::string &id, unsigned int reactionGlyphIndex = 0)
- const unsigned int getNumSpeciesReferences(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0)
- const unsigned int getNumSpeciesReferences(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0)
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumReactants(SBMLDocument *document, const std::string &reactionId)
Returns the number of Reactant objects in the Reaction object with the given id.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – the id of the Reaction object.
- Returns:
the number of Reactant objects in the Reaction object with the given id.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumProducts(SBMLDocument *document, const std::string &reactionId)
Returns the number of Product objects in the Reaction object with the given id.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – the id of the Reaction object.
- Returns:
the number of Product objects in the Reaction object with the given id.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumModifiers(SBMLDocument *document, const std::string &reactionId)
Returns the number of Modifier objects in the Reaction object with the given id.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – the id of the Reaction object.
- Returns:
the number of Modifier objects in the Reaction object with the given id.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getReactantId(SBMLDocument *document, const std::string &reactionId, unsigned int index)
Returns the id of the reactant species with the given index in the Reaction object with the given id.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – the id of the Reaction object.
index – the index of the reactant species.
- Returns:
the id of the reactant species with the given index in the Reaction object with the given id, or
""if the object does not exists.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getProductId(SBMLDocument *document, const std::string &reactionId, unsigned int index)
Returns the id of the product species with the given index in the Reaction object with the given id.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – the id of the Reaction object.
index – the index of the product species.
- Returns:
the id of the product species with the given index in the Reaction object with the given id, or
""if the object does not exists.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getModifierId(SBMLDocument *document, const std::string &reactionId, unsigned int index)
Returns the id of the modifier species with the given index in the Reaction object with the given id.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – the id of the Reaction object.
index – the index of the modifier species.
- Returns:
the id of the modifier species with the given index in the Reaction object with the given id, or
""if the object does not exists.
-
SpeciesReference *LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReference(SBMLDocument *document, const std::string &reactionId, const std::string &speciesId)
Returns a pointer to the SpeciesReference object associated with the given reactant/product species id in the Reaction object with the given id.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – the id of the Reaction object.
speciesId – the id of the Species object.
- Returns:
a pointer to the SpeciesReference object, or
NULLif the object does not exists or is not of type reactant/product.
-
ModifierSpeciesReference *LIBSBMLNETWORK_CPP_NAMESPACE::getModifierSpeciesReference(SBMLDocument *document, const std::string &reactionId, const std::string &speciesId)
Returns a pointer to the ModifierSpeciesReference object associated with the given modifier species id in the Reaction object with the given id.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – the id of the Reaction object.
speciesId – the id of the Species object.
- Returns:
a pointer to the ModifierSpeciesReference object, or
NULLif the object does not exists or is not of type modifier.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::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::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.q
stoichiometricSpeciesReference – the value of the option to generate stoichiometric species reference in the autolayout algorithm.
- Returns:
integer value indicating success/failure of the function.
Layout Functions
-
ListOfLayouts *LIBSBMLNETWORK_CPP_NAMESPACE::getListOfLayouts(SBMLDocument *document)
Get the Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
a pointer to the Layout object of the SBML document.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumLayouts(const 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
0if the object isNULL
-
Layout *LIBSBMLNETWORK_CPP_NAMESPACE::getLayout(SBMLDocument *document, unsigned int layoutIndex = 0)
Returns a pointer to the Layout 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
theLayout with the given index in the ListOfLayouts of the SBML document or NULL if no such Layout exists or the document isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addLayout(SBMLDocument *document, Layout *layout)
Add Layout to list of layouts of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
layout – a pointer to the Layout object.
- Returns:
integer value indicating success/failure of the function.
-
Layout *LIBSBMLNETWORK_CPP_NAMESPACE::createLayout(SBMLDocument *document)
Create a Layout object and add it to list of layouts of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
a pointer to the created Layout object.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeAllLayouts(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::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 before creating an alias SpeciesGlyph.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::updateLayoutCurves(SBMLDocument *document, Layout *layout)
fix the position of all the species and reaction nodes in the layout and apply autolayout
- Parameters:
document – a pointer to the SBMLDocument object.
layout – a pointer to the Layout object.
updatedGraphicalObject – a set of the ids of the GraphicalObject objects the position of which has been updated recently.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::getUseNameAsTextLabel(SBMLDocument *document, unsigned int layoutIndex = 0)
Get whether the name of the GraphicalObjects must be used as the label of TextGlyph objects associated with them 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:
boolean value indicating whether the name of the GraphicalObjects must be used as the label of TextGlyph objects associated with them.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setUseNameAsTextLabel(SBMLDocument *document, unsigned int layoutIndex, bool useNameAsTextLabel)
Set whether the name of the GraphicalObjects must be used as the label of TextGlyph objects associated with them 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.
useNameAsTextLabel – a boolean value indicating whether the name of the GraphicalObjects must be used as the label of TextGlyph objects associated with them.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::createAliasSpeciesGlyph(SBMLDocument *document, const std::string &speciesId, const std::string &reactionId, unsigned int reactionGlyphIndex, bool updateCurves = true)
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 first Layout object 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 to create an alias SpeciesGlyph for.
updateCurves – whether to run autolayout after adding the glyph.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::createAliasSpeciesGlyph(SBMLDocument *document, unsigned int layoutIndex, const std::string &speciesId, const std::string &reactionId, unsigned int reactionGlyphIndex, bool updateCurves = true)
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.
layoutIndex – the index number of the Layout to return.
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 to create an alias SpeciesGlyph for.
updateCurves – whether to run autolayout after adding the glyph.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::createAliasReactionGlyph(SBMLDocument *document, const std::string &reactionId)
Creates an alias ReactionGlyph object for the Reaction with the given id in the first Layout object in the ListOfLayouts of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – the id of the Reaction to create an alias ReactionGlyph for.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::createAliasReactionGlyph(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId)
Creates an alias ReactionGlyph object for the Reaction with the given id in 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.
reactionId – the id of the Reaction to create an alias ReactionGlyph for.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGlyphIndexInReactionGlyph(SBMLDocument *document, unsigned int layoutIndex, const std::string &speciesId, unsigned int speciesGlyphIndex, const std::string &reactionId, unsigned int reactionGlyphIndex)
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.
layoutIndex – the index number of the Layout to return.
speciesId – the id of the Species to assign to the ReactionGlyph.
speciesGlyphIndex – the index of the SpeciesGlyph object to assign to the ReactionGlyph.
reactionId – the id of the Reaction to assign the SpeciesGlyph to.
reactionGlyphIndex – the index of the ReactionGlyph object to assign the SpeciesGlyph to.
- Returns:
integer value indicating success/failure of the function.
-
Dimensions *LIBSBMLNETWORK_CPP_NAMESPACE::getDimensions(SBMLDocument *document, unsigned int layoutIndex = 0)
Returns 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:
a pointer to the Dimensions object of the Layout object.
-
double LIBSBMLNETWORK_CPP_NAMESPACE::getDimensionWidth(SBMLDocument *document, unsigned 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::setDimensionWidth(SBMLDocument *document, const double &width)
Sets the value of the “width” attribute of the Dimensions object of the first Layout object in the ListOfLayouts of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
width – a double value to use as the value of the “width” attribute of the Dimensions object of the first Layout object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setDimensionWidth(SBMLDocument *document, unsigned int layoutIndex, const double &width)
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::getDimensionHeight(SBMLDocument *document, unsigned 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::setDimensionHeight(SBMLDocument *document, const double &height)
Sets the value of the “height” attribute of the Dimensions object of the first Layout object in the ListOfLayouts of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
height – a double value to use as the value of the “height” attribute of the Dimensions object of the first Layout object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setDimensionHeight(SBMLDocument *document, unsigned int layoutIndex, const double &height)
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 unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumGraphicalObjects(SBMLDocument *document, unsigned 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
0if the object isNULL
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumGraphicalObjects(SBMLDocument *document, const std::string &id)
Returns the number of GraphicalObjects of the first Layout object 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.
- Returns:
the number of GraphicalObject objects associated with the entered model entity id, or
0if the object isNULLor has no associated GraphicalObject objects
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumGraphicalObjects(SBMLDocument *document, unsigned int layoutIndex, const std::string &id)
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.
layoutIndex – the index number of the Layout to return.
id – the id of the model entity the number of GraphicalObject objects associated with it is going to be returned.
- Returns:
the number of GraphicalObject objects associated with the entered model entity id, or
0if the object isNULLor has no associated GraphicalObject objects
-
std::vector<GraphicalObject*> LIBSBMLNETWORK_CPP_NAMESPACE::getGraphicalObjects(SBMLDocument *document, const std::string &id)
Returns a vector of GraphicalObject objects of the first Layout object 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 GraphicalObject objects of which are going to be returned.
- Returns:
a vector of GraphicalObject objects associated with the entered model entity id.
-
std::vector<GraphicalObject*> LIBSBMLNETWORK_CPP_NAMESPACE::getGraphicalObjects(SBMLDocument *document, unsigned int layoutIndex, const std::string &id)
Returns a vector of CompartmentGlyph objects 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.
id – the id of the model entity the GraphicalObject objects of which are going to be returned.
- Returns:
a vector of GraphicalObject objects associated with the entered model entity id.
-
GraphicalObject *LIBSBMLNETWORK_CPP_NAMESPACE::getGraphicalObject(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0)
Returns the GraphicalObject object with the given index of the first Layout object in the ListOfLayouts of the SBML document associated with the entered compartment id.
- Parameters:
document – a pointer to the SBMLDocument object.
id – the id of the model entity the GraphicalObject object associated with it is going to be returned.
graphicalObjectIndex – the index number of the GraphicalObject object to return.
- Returns:
a pointer the GraphicalObject object with the given index associated with the entered model entity id.
-
GraphicalObject *LIBSBMLNETWORK_CPP_NAMESPACE::getGraphicalObject(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0)
Returns the GraphicalObject object with the given index 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 GraphicalObject object associated with it is going to be returned.
graphicalObjectIndexIndex – the index number of the GraphicalObject object to return.
- Returns:
a pointer the GraphicalObject object with the given index associated with the entered model entity id.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeGraphicalObject(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex)
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeGraphicalObject(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex)
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetId(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex)
Predicates Returning
trueif the id of the GraphicalObject object with the given index in the Layout object with the given index in the ListOfLayouts of the SBML document associated with the entered model entity id is set.- Parameters:
document – a pointer to the SBMLDocument object.
id – the id of the model entity the GraphicalObject object associated with it is going to be checked.
graphicalObjectIndex – the index number of the GraphicalObject object to check.
- Returns:
trueif the id of the GraphicalObject object is set,falseotherwise.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getId(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex)
Returns the id of the GraphicalObject object with the given index in 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 GraphicalObject object associated with it is going to be returned.
graphicalObjectIndex – the index number of the GraphicalObject object to return.
- Returns:
the id of the GraphicalObject object, or
""if the object isNULLor the id is not set.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setId(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, const std::string &graphicalObjectId)
Sets the id of the GraphicalObject object with the given index in 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 GraphicalObject object associated with it is going to be set.
graphicalObjectIndex – the index number of the GraphicalObject object to set.
graphicalObjectId – the id to set for the GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getTextGlyphId(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex)
Returns the id of the TextGlyph object with the given index of the GraphicalObject object with the given index in 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 GraphicalObject object associated with it is going to be returned.
graphicalObjectIndex – the index number of the GraphicalObject object to return.
textGlyphIndex – the index number of the TextGlyph object to set.
- Returns:
the id of the GraphicalObject object, or
""if the object isNULLor the id is not set.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextGlyphId(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex, const std::string &graphicalObjectId)
Sets the id of the TextGlyph object with the given index of the GraphicalObject object with the given index in 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 GraphicalObject object associated with it is going to be set.
graphicalObjectIndex – the index number of the GraphicalObject object to set.
textGlyphIndex – the index number of the TextGlyph object to set.
graphicalObjectId – the id to set for the GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetMetaId(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex)
Predicates Returning
trueif the metaid of the GraphicalObject object with the given index in the Layout object with the given index in the ListOfLayouts of the SBML document associated with the entered model entity id is set.- Parameters:
document – a pointer to the SBMLDocument object.
id – the id of the model entity the GraphicalObject object associated with it is going to be checked.
graphicalObjectIndex – the index number of the GraphicalObject object to check.
- Returns:
trueif the metaid of the GraphicalObject object is set,falseotherwise.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getMetaId(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex)
Returns the metaid of the GraphicalObject object with the given index in 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 GraphicalObject object associated with it is going to be returned.
graphicalObjectIndex – the index number of the GraphicalObject object to return.
- Returns:
the metaid of the GraphicalObject object, or
""if the object isNULLor the metaid is not set.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setMetaId(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, const std::string &graphicalObjectMetaId)
Sets the metaid of the GraphicalObject object with the given index in 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 GraphicalObject object associated with it is going to be set.
graphicalObjectIndex – the index number of the GraphicalObject object to set.
graphicalObjectMetaId – the metaid to set for the GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetName(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex)
Predicates Returning
trueif the name of the GraphicalObject object with the given index in the Layout object with the given index in the ListOfLayouts of the SBML document associated with the entered model entity id is set.- Parameters:
document – a pointer to the SBMLDocument object.
id – the id of the model entity the GraphicalObject object associated with it is going to be checked.
graphicalObjectIndex – the index number of the GraphicalObject object to check.
- Returns:
trueif the name of the GraphicalObject object is set,falseotherwise.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getName(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex)
Returns the name of the GraphicalObject object with the given index in 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 GraphicalObject object associated with it is going to be returned.
graphicalObjectIndex – the index number of the GraphicalObject object to return.
- Returns:
the name of the GraphicalObject object, or
""if the object isNULLor the name is not set.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setName(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, const std::string &graphicalObjectName)
Sets the name of the GraphicalObject object with the given index in 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 GraphicalObject object associated with it is going to be set.
graphicalObjectIndex – the index number of the GraphicalObject object to set.
graphicalObjectName – the name to set for the GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumCompartmentGlyphs(SBMLDocument *document, unsigned 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
0if the object isNULL
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumCompartmentGlyphs(SBMLDocument *document, const std::string &compartmentId)
Returns the number of CompartmentGlyphs of the first Layout object in the ListOfLayouts of the SBML document associated with the entered compartment id.
- Parameters:
document – a pointer to the SBMLDocument object.
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
0if the object isNULLor has no associated CompartmentGlyph objects
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumCompartmentGlyphs(SBMLDocument *document, unsigned int layoutIndex, const std::string &compartmentId)
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
0if the object isNULLor has no associated CompartmentGlyph objects
-
std::vector<CompartmentGlyph*> LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGlyphs(SBMLDocument *document, const std::string &compartmentId)
Returns a vector of CompartmentGlyph objects of the first Layout object in the ListOfLayouts of the SBML document associated with the entered compartment id.
- Parameters:
document – a pointer to the SBMLDocument object.
compartmentId – the id of the compartment the CompartmentGlyph objects of which are going to be returned.
- Returns:
a vector of CompartmentGlyph objects associated with the entered compartment id.
-
std::vector<CompartmentGlyph*> LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGlyphs(SBMLDocument *document, unsigned int layoutIndex, const std::string &compartmentId)
Returns a vector of CompartmentGlyph objects 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 CompartmentGlyph objects of which are going to be returned.
- Returns:
a vector of CompartmentGlyph objects associated with the entered compartment id.
-
CompartmentGlyph *LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGlyph(SBMLDocument *document, const std::string &compartmentId, unsigned int compartmentGlyphIndex = 0)
Returns the CompartmentGlyph object with the given index of the first Layout object in the ListOfLayouts of the SBML document associated with the entered compartment id.
- Parameters:
document – a pointer to the SBMLDocument object.
compartmentId – the id of the compartment the CompartmentGlyph object associated with it is going to be returned.
compartmentGlyphIndex – the index number of the CompartmentGlyph object to return.
- Returns:
a pointer the CompartmentGlyph object with the given index associated with the entered compartment id.
-
CompartmentGlyph *LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGlyph(SBMLDocument *document, unsigned int layoutIndex, const std::string &compartmentId, unsigned int compartmentGlyphIndex = 0)
Returns the CompartmentGlyph object with the given index 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 CompartmentGlyph object associated with it is going to be returned.
compartmentGlyphIndex – the index number of the CompartmentGlyph object to return.
- Returns:
a pointer to the CompartmentGlyph object with the given index associated with the entered compartment id.
-
CompartmentGlyph *LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGlyph(SBMLDocument *document, unsigned int layoutIndex = 0, unsigned int compartmentGlyphIndex = 0)
Returns the CompartmentGlyph object with the given index in the 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.
compartmentGlyphIndex – the index number of the CompartmentGlyph object to return.
- Returns:
a pointer to the CompartmentGlyph object with the given index in the ListOfCompartmentGlyphs of the Layout object.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isCompartmentGlyph(SBMLDocument *document, const std::string &id)
Predicate returning true if the abstract GraphicalObject with the given id in the first Layout object of the SBML document is of type CompartmentGlyph.
- Parameters:
document – a pointer to the SBMLDocument object.
id – the id of the GraphicalObject.
- Returns:
trueif this abstract GraphicalObject is of type CompartmentGlyph, false otherwise
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isCompartmentGlyph(SBMLDocument *document, unsigned int layoutIndex, const std::string &id)
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:
trueif this abstract GraphicalObject is of type CompartmentGlyph, false otherwise
-
std::string LIBSBMLNETWORK_CPP_NAMESPACE::getGraphicalObjectCompartmentId(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex)
Returns the id of the compartment associated with the GraphicalObject with the given index associated with the model entity with the given id of the first Layout object 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.
- Returns:
the id of the compartment associated with the graphical object, or
""if the object does not have an associated compartment or isNULL
-
std::string LIBSBMLNETWORK_CPP_NAMESPACE::getGraphicalObjectCompartmentId(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex)
Returns the id of the compartment associated with 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 id of the compartment associated with the graphical object, or
""if the object does not have an associated compartment or isNULL
-
std::string LIBSBMLNETWORK_CPP_NAMESPACE::getGraphicalObjectCompartmentId(SBMLDocument *document, GraphicalObject *graphicalObject)
Returns the id of the compartment associated with the graphical object.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
the id of the compartment associated with the graphical object, or
""if the object does not have an associated compartment or isNULL
-
Compartment *LIBSBMLNETWORK_CPP_NAMESPACE::getAssociatedCompartment(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex)
Returns a pointer to the compartment associated with the GraphicalObject with the given index associated with the model entity with the given id of the first Layout object 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.
- Returns:
a pointer to the compartment associated with the graphical object, or
NULLif the object does not have an associated compartment or isNULL
-
Compartment *LIBSBMLNETWORK_CPP_NAMESPACE::getAssociatedCompartment(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex)
Returns a pointer to the compartment associated with 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:
a pointer to the compartment associated with the graphical object, or
NULLif the object does not have an associated compartment or isNULL
-
Compartment *LIBSBMLNETWORK_CPP_NAMESPACE::getAssociatedCompartment(SBMLDocument *document, GraphicalObject *graphicalObject)
Returns a pointer to the compartment associated with the GraphicalObject object.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
a pointer to the compartment associated with the graphical object, or
NULLif the object does not have an associated compartment or isNULL
-
std::vector<std::string> LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGlyphsIds(SBMLDocument *document, unsigned int layoutIndex = 0)
Returns the ids of the SpeciesGlyph objects of the Layout object with the given index in the ListOfLayouts of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the ids of the SpeciesGlyph objects of this Layout object
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumSpeciesGlyphs(SBMLDocument *document, unsigned 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
0if the object isNULL
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumSpeciesGlyphs(SBMLDocument *document, const std::string &speciesId)
Returns the number of SpeciesGlyphs of the first Layout object in the ListOfLayouts of the SBML document associated with the entered species id.
- Parameters:
document – a pointer to the SBMLDocument object.
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
0if the object isNULLor has no associated SpeciesGlyph objects
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumSpeciesGlyphs(SBMLDocument *document, unsigned int layoutIndex, const std::string &speciesId)
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 speices id, or
0if the object isNULLor has no associated SpeciesGlyph objects
-
std::vector<SpeciesGlyph*> LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGlyphs(SBMLDocument *document, const std::string &speciesId)
Returns a vector of SpeciesGlyph objects of the first Layout object in the ListOfLayouts of the SBML document associated with the entered species id.
- Parameters:
document – a pointer to the SBMLDocument object.
speciesId – the id of the species the SpeciesGlyph objects of which are going to be returned.
- Returns:
a vector of SpeciesGlyph objects associated with the entered species id.
-
std::vector<SpeciesGlyph*> LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGlyphs(SBMLDocument *document, unsigned int layoutIndex, const std::string &speciesId)
Returns a vector of SpeciesGlyph objects 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 SpeciesGlyph objects of which are going to be returned.
- Returns:
a vector of SpeciesGlyph objects associated with the entered species id.
-
SpeciesGlyph *LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGlyph(SBMLDocument *document, const std::string &speciesId, unsigned int speciesGlyphIndex = 0)
Returns the SpeciesGlyph object with the given index of the first Layout object in the ListOfLayouts of the SBML document associated with the entered species id.
- Parameters:
document – a pointer to the SBMLDocument object.
speciesId – the id of the species the SpeciesGlyph object associated with it is going to be returned.
speciesGlyphIndex – the index number of the SpeciesGlyph object to return.
- Returns:
a pointer the SpeciesGlyph object with the given index associated with the entered species id.
-
SpeciesGlyph *LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGlyph(SBMLDocument *document, unsigned int layoutIndex, const std::string &speciesId, unsigned int speciesGlyphIndex = 0)
Returns the SpeciesGlyph object with the given index 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 SpeciesGlyph object associated with it is going to be returned.
speciesGlyphIndex – the index number of the SpeciesGlyph object to return.
- Returns:
a pointer the SpeciesGlyph object with the given index associated with the entered species id.
-
SpeciesGlyph *LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGlyph(SBMLDocument *document, unsigned int layoutIndex = 0, unsigned int speciesGlyphIndex = 0)
Returns the SpeciesGlyph object with the given index in the 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.
speciesGlyphIndex – the index number of the SpeciesGlyph object to return.
- Returns:
a pointer to the SpeciesGlyph object with the given index with the given index in the ListOfSpeciesGlyphs of the Layout object.
-
const int LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGlyphIndex(SBMLDocument *document, const std::string &speciesId, const std::string &reactionId, unsigned int reactionGlyphIndex = 0)
Returns the index of the SpeciesGlyph object associated in the list of SpeciesGlyph objects 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 first Layout object 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 returned.
reactionId – the id of the reaction the SpeciesGlyph object associated with it is going to be returned.
reactionGlyphIndex – the index number of the ReactionGlyph object to return.
- Returns:
the index of the SpeciesGlyph object associated with the entered species id among the list of SpeciesGlyph objects associated with the entered reaction id, or
-1if the object isNULLor has no associated SpeciesGlyph objects
-
const int LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGlyphIndex(SBMLDocument *document, unsigned int layoutIndex, const std::string &speciesId, const std::string &reactionId, unsigned int reactionGlyphIndex = 0)
Returns the index of the SpeciesGlyph object associated in the list of SpeciesGlyph objects 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 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.
speciesId – the id of the species the SpeciesGlyph object associated with it is going to be returned.
reactionId – the id of the reaction the SpeciesGlyph object associated with it is going to be returned.
reactionGlyphIndex – the index number of the ReactionGlyph object to return.
- Returns:
the index of the SpeciesGlyph object associated with the entered species id among the list of SpeciesGlyph objects associated with the entered reaction id, or
-1if the object isNULLor has no associated SpeciesGlyph objects
-
std::vector<std::string> LIBSBMLNETWORK_CPP_NAMESPACE::getConnectedReactionsFor(SBMLDocument *document, unsigned int layoutIndex, const std::string &speciesId, int speciesGlyphIndex = 0)
Returns a vector of the ids of the Reactions which are connected to the SpeciesGlyph with the given id and index in 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 to return.
speciesId – the id of the Species.
speciesGlyphIndex – the index of the SpeciesGlyph.
- Returns:
a vector of the ids of the Reactions which are connected to the SpeciesGlyph with the given id and index.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesGlyph(SBMLDocument *document, const std::string &id)
Predicate returning true if the abstract GraphicalObject with the given id in the first Layout object of the SBML document is of type SpeciesGlyph.
- Parameters:
document – a pointer to the SBMLDocument object.
id – the id of the GraphicalObject.
- Returns:
trueif this abstract GraphicalObject is of type SpeciesGlyph, false otherwise
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesGlyph(SBMLDocument *document, unsigned int layoutIndex, const std::string &id)
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:
trueif this abstract GraphicalObject is of type SpeciesGlyph, false otherwise
-
std::vector<std::string> LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGlyphsIds(SBMLDocument *document, unsigned int layoutIndex = 0)
Returns the ids of the ReactionGlyph objects of the Layout object with the given index in the ListOfLayouts of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the ids of the ReactionGlyph objects of this Layout object
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumReactionGlyphs(SBMLDocument *document, unsigned int layoutIndex = 0)
Returns the number of ReactionGlyph 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
0if the object isNULL
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumReactionGlyphs(SBMLDocument *document, const std::string &reactionId)
Returns the number of ReactionGlyphs of the first Layout object in the ListOfLayouts of the SBML document associated with the entered reaction id.
- Parameters:
document – a pointer to the SBMLDocument object.
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
0if the object isNULLor has no associated ReactionGlyph objects
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumReactionGlyphs(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId)
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 speices id, or
0if the object isNULLor has no associated ReactionGlyph objects
-
std::vector<ReactionGlyph*> LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGlyphs(SBMLDocument *document, const std::string &reactionId)
Returns a vector of ReactionGlyph objects of the first Layout object in the ListOfLayouts of the SBML document associated with the entered reaction id.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – the id of the reaction the ReactionGlyph objects of which are going to be returned.
- Returns:
a vector of ReactionGlyph objects associated with the entered reaction id.
-
std::vector<ReactionGlyph*> LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGlyphs(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId)
Returns a vector of ReactionGlyph objects 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 ReactionGlyph objects of which are going to be returned.
- Returns:
a vector of ReactionGlyph objects associated with the entered reaction id.
-
ReactionGlyph *LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGlyph(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0)
Returns the ReactionGlyph object with the given index of the first Layout object in the ListOfLayouts of the SBML document associated with the entered reaction id.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – the id of the reaction the ReactionGlyph object associated with it is going to be returned.
reactionGlyphIndex – the index number of the ReactionGlyph object to return.
- Returns:
a pointer the ReactionGlyph object with the given index associated with the entered reaction id.
-
ReactionGlyph *LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGlyph(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0)
Returns the ReactionGlyph object with the given index 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 ReactionGlyph object associated with it is going to be returned.
reactionGlyphIndex – the index number of the ReactionGlyph object to return.
- Returns:
a pointer the ReactionGlyph object with the given index associated with the entered reaction id.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isReactionGlyph(SBMLDocument *document, const std::string &id)
Predicate returning true if the abstract GraphicalObject with the given id in the first Layout object of the SBML document is of type ReactionGlyph.
- Parameters:
document – a pointer to the SBMLDocument object.
id – the id of the GraphicalObject.
- Returns:
trueif this abstract GraphicalObject is of type ReactionGlyph, false otherwise
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isReactionGlyph(SBMLDocument *document, unsigned int layoutIndex, const std::string &id)
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 ReactionGlyph.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout to return.
id – the id of the GraphicalObject.
- Returns:
trueif this abstract GraphicalObject is of type ReactionGlyph, false otherwise
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumSpeciesReferences(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0)
Returns the number of SpeciesReference objects of the ReactionGlyph object with the given index associated with the entered reaction id of the first Layout object 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.
- Returns:
the number of SpeciesReference objects of the ReactionGlyph object with the given index associated with the entered reaction id, or
0if the object isNULLor has no associated SpeciesReference objects.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumSpeciesReferences(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
the number of SpeciesReference objects of the ReactionGlyph object with the given index associated with the entered reaction id, or
0if the object isNULLor has no associated SpeciesReference objects.
-
std::vector<SpeciesReferenceGlyph*> LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferences(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0)
Returns the SpeciesReferenceGlyph objects of the ReactionGlyph object with the given index associated with the entered reaction id of the first Layout object in the ListOfLayouts of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – the id of the reaction the SpeciesReference objects of its ReactionGlyph object with the given index associated with it is going to be returned.
reactionId – the id of the reaction the 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.
- Returns:
the SpeciesReference objects of the ReactionGlyph object with the given index associated with the entered reaction id, or an empty vector if the object is
NULLor has no associated SpeciesReference objects.
-
std::vector<SpeciesReferenceGlyph*> LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferences(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0)
Returns the SpeciesReferenceGlyph objects 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.
layoutIndex – the index number of the Layout to return.
reactionId – the id of the reaction the 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.
- Returns:
the SpeciesReference objects of the ReactionGlyph object with the given index associated with the entered reaction id, or an empty vector if the object is
NULLor has no associated SpeciesReference objects.
-
SpeciesReferenceGlyph *LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReference(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0)
Returns the SpeciesReferenceGlyph object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the first Layout object in the ListOfLayouts of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – the id of the reaction the SpeciesReferenceGlyph object 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.
speciesReferenceIndex – the index of the SpeciesReference.
- Returns:
the SpeciesReferenceGlyph object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id, or an empty vector if the object is
NULLor has no associated SpeciesReference objects.
-
SpeciesReferenceGlyph *LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReference(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0)
Returns the SpeciesReferenceGlyph 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.
layoutIndex – the index number of the Layout to return.
reactionId – the id of the reaction the SpeciesReferenceGlyph object 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.
speciesReferenceIndex – the index of the SpeciesReference.
- Returns:
the SpeciesReferenceGlyph object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id, or an empty vector if the object is
NULLor has no associated SpeciesReference objects.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceId(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0)
Returns the id of the species reference associated with SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the first Layout object 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.
speciesReferenceIndex – the index of the SpeciesReference to return.
- Returns:
the id of the SpeciesReference object with the given index, or
""if the ReactionGlyph does not exits or the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceId(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
@breif Returns the id of the species reference associated with 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.
layoutIndex – the index number of the Layout to return.
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 to return.
- Returns:
the id of the SpeciesReference object with the given index, or
""if the ReactionGlyph object does not exits or the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceSpeciesId(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
the “species” attribute of the SpeciesReference object with the given index, or
""if the SpeciesReference does not exits or the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceSpeciesGlyphId(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 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 first Layout object 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.
speciesReferenceIndex – the index of the SpeciesReference.
- Returns:
the value of the “speciesGlyph” attribute of the SpeciesReference object with the given index, or
""if the SpeciesReference object does not exits or the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceSpeciesGlyphId(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 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.
layoutIndex – the index number of the Layout to return.
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.
- 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 isNULL
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceEmptySpeciesGlyph(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
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 number of the ReactionGlyph object to return.
speciesReferenceIndex – the index of the SpeciesReference.
- Returns:
trueif the SpeciesGlyph associated with the SpeciesReferenceGlyph object with the given index is an empty SpeciesGlyph,falseif either the SpeciesGlyph is not empty or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceEmptySpeciesGlyph(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
trueif the SpeciesGlyph associated with the SpeciesReferenceGlyph object with the given index is an empty SpeciesGlyph,falseif either the SpeciesGlyph is not empty or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceEmptySpeciesGlyphId(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
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 first Layout object 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.
speciesReferenceIndex – the index of the SpeciesReference.
- 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 isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceEmptySpeciesGlyphId(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
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.
layoutIndex – the index number of the Layout to return.
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.
- 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 isNULL
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceRole(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0)
Predicates returning
trueif 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 first Layout object 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 number of the ReactionGlyph object to return.
speciesReferenceIndex – the index of the SpeciesReference.
- Returns:
trueif the “role” attribute of the SpeciesReference object with the given index is set,falseif either the “role” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceRole(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0)
Predicates returning
trueif 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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
trueif the “role” attribute of the SpeciesReference object with the given index is set,falseif either the “role” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceRole(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 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 first Layout object 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.
speciesReferenceIndex – the index of the SpeciesReference.
- 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 isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceRole(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 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.
layoutIndex – the index number of the Layout to return.
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.
- 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 isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceRole(SBMLDocument *document, const std::string &reactionId, const std::string &role)
Sets the value of the “role” attribute of the SpeciesReference object of the first ReactionGlyph object id of the first Layout object 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.
role – a string value to be set as “role” attribute of the SpeciesReference object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceRole(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, const std::string &role)
Sets the value of the “role” attribute of the SpeciesReference object of the first ReactionGlyph object id 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 to return.
reactionId – the id of the reaction the the ReactionGlyph objects of which to be returned.
role – a string value to be set as “role” attribute of the SpeciesReference object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceRole(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, const std::string &role)
Sets the value of the “role” attribute of the SpeciesReference object of the ReactionGlyph object with the given id of the first Layout object 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.
role – a string value to be set as “role” attribute of the SpeciesReference object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceRole(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, const std::string &role)
Sets the value of the “role” attribute of the first SpeciesReference object of the ReactionGlyph object with the given id of the Layout object with the given index of the SBML document.
- Parameters:
layoutIndex – the index number of the Layout to return.
reactionId – the id of the reaction the the ReactionGlyph objects of which to be returned.
reactionGlyphIndex – the index of the ReactionGlyph.
role – a string value to be set as “role” attribute of the SpeciesReference object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceRole(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const std::string &role)
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 first Layout object 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.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceRole(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const std::string &role)
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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
integer value indicating success/failure of the function.
-
const int LIBSBMLNETWORK_CPP_NAMESPACE::getNumSpeciesReferencesAssociatedWithSpecies(SBMLDocument *document, const std::string &speciesId, const std::string &reactionId, unsigned int reactionGlyphIndex = 0)
Returns the number of SpeciesReference objects of the ReactionGlyph with the given index associated with the entered species id in the first Layout object 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.
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.
- Returns:
the number of SpeciesReference objects of the ReactionGlyph object with the given index associated with the entered species id, or
0if the object isNULLor has no associated SpeciesReference objects.
-
const int LIBSBMLNETWORK_CPP_NAMESPACE::getNumSpeciesReferencesAssociatedWithSpecies(SBMLDocument *document, unsigned int layoutIndex, const std::string &speciesId, const std::string &reactionId, unsigned int reactionGlyphIndex = 0)
Returns the number of SpeciesReference objects of the ReactionGlyph with the given index associated with the entered species id in 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.
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.
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.
- Returns:
the number of SpeciesReference objects of the ReactionGlyph object with the given index associated with the entered species id, or
0if the object isNULLor has no associated SpeciesReference objects.
-
const int LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceIndexAssociatedWithSpecies(SBMLDocument *document, const std::string &speciesId, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int n = 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 number of SpeciesReference objects of its ReactionGlyph object with the given index associated with it is going to be returned.
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.
n – the index of the SpeciesReference object.
- 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, or
-1if the object isNULLor has no associated SpeciesReference objects.
-
const int LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceIndexAssociatedWithSpecies(SBMLDocument *document, unsigned int layoutIndex, const std::string &speciesId, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int n = 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.
layoutIndex – the index number of the Layout to return.
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.
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.
n – the index of the SpeciesReference object.
- 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, or
-1if the object isNULLor has no associated SpeciesReference objects.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceCurve(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0)
Predicate returning
trueif the SpeciesReference object with the given index of the ReactionGlyph object with the given index associated with the entered reaction id of the first Layout object in the the ListOfLayouts of the SBML document has a Curve object and the curve consists of one or more segments.- 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.
- Returns:
trueif the SpeciesReference object has a Curve object and the curve consists of one or more segments, false otherwise
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceCurve(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0)
Predicate returning
trueif 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 has a Curve object and the curve consists of one or more segments.- 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 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.
- Returns:
trueif the SpeciesReference object has a Curve object and the curve consists of one or more segments, false otherwise
-
Curve *LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurve(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0)
Returns 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 first Layout object 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.
- Returns:
a pointer to the Curve object of the SpeciesReference object with the given index, or
NULLif the SpeciesReference object does not exits or the object isNULL
-
Curve *LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurve(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0)
Returns 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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
a pointer to the Curve object of the SpeciesReference object with the given index, or
NULLif the SpeciesReference object does not exits or the object isNULL
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumSpeciesReferenceCurveSegments(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 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 first Layout object 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.
- Returns:
the number of curve segments of the Curve object of the SpeciesReference object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumSpeciesReferenceCurveSegments(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
the number of curve segments of the Curve object of the SpeciesReference object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
LineSegment *LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegment(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int curveSegmentIndex = 0)
Returns a pointer to the curve segment with the given index 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.
- 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.
curveSegmentIndex – the index of the CurveSegment.
- Returns:
a pointer to the LineSegment object with the given index, or
NULLif the SpeciesReference object does not exits or the object isNULL
-
LineSegment *LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegment(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int curveSegmentIndex = 0)
Returns a pointer to the curve segment with the given index 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.
layoutIndex – the index number of the Layout to return.
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.
curveSegmentIndex – the index of the CurveSegment.
- Returns:
a pointer to the LineSegment object with the given index, or
NULLif the SpeciesReference object does not exits or the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addSpeciesReferenceLineCurveSegment(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0)
Creates a new LineSegment and adds it 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 first Layout object 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.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addSpeciesReferenceLineCurveSegment(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0)
Creates a new LineSegment and adds it 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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addSpeciesReferenceCubicBezierCurveSegment(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0)
Creates a new CubicBezier object and adds it 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 first Layout object 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.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addSpeciesReferenceCubicBezierCurveSegment(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0)
Creates a new CubicBezier object and adds it 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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeSpeciesReferenceCurveSegment(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int curveSegmentIndex = 0)
Removes 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 first Layout object 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.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeSpeciesReferenceCurveSegment(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int curveSegmentIndex = 0)
Removes 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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesReferenceCurveSegmentCubicBezier(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex)
@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 first Layout object 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.
- Returns:
trueif the curve segment with the given index is of type CubicBezier,falseotherwise
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesReferenceCurveSegmentCubicBezier(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex)
@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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
trueif the curve segment with the given index is of type CubicBezier,falseotherwise
-
int LIBSBMLNETWORK_CPP_NAMESPACE::convertSpeciesReferenceCurveSegmentToLine(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int curveSegmentIndex = 0)
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 first Layout object in the ListOfLayouts to a LineSegment object.
- 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.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::convertSpeciesReferenceCurveSegmentToLine(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int curveSegmentIndex = 0)
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 object.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::convertSpeciesReferenceCurveSegmentToCubicBezier(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int curveSegmentIndex = 0)
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 first Layout object in the ListOfLayouts to a CubicBezier object.
- 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.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::convertSpeciesReferenceCurveSegmentToCubicBezier(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int curveSegmentIndex = 0)
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 object.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
integer value indicating success/failure of the function.
-
double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegmentStartPointX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int curveSegmentIndex = 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 first Layout object 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.
- Returns:
the value of the “x” attribute of the start point of the CubicBezier object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegmentStartPointX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int curveSegmentIndex = 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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
the value of the “x” attribute of the start point of the CubicBezier object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceCurveSegmentStartPointX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex, const double &x)
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 first Layout object 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.
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.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceCurveSegmentStartPointX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex, const double &x)
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.
layoutIndex – the index number of the Layout to return.
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.
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.
-
double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegmentStartPointY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int curveSegmentIndex = 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 first Layout object 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.
- Returns:
the value of the “y” attribute of the start point of the CubicBezier object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegmentStartPointY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int curveSegmentIndex = 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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
the value of the “y” attribute of the start point of the CubicBezier object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceCurveSegmentStartPointY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex, const double &y)
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 first Layout object 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.
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.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceCurveSegmentStartPointY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex, const double &y)
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.
layoutIndex – the index number of the Layout to return.
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.
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.
-
double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegmentEndPointX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex)
@breif 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 first Layout object 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.
- Returns:
the value of the “x” attribute of the end point of the CubicBezier object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegmentEndPointX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex)
@breif 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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
the value of the “x” attribute of the end point of the CubicBezier object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceCurveSegmentEndPointX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex, const double &x)
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 first Layout object 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.
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.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceCurveSegmentEndPointX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex, const double &x)
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.
layoutIndex – the index number of the Layout to return.
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.
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.
-
double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegmentEndPointY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex)
@breif 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 first Layout object 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.
- Returns:
the value of the “y” attribute of the end point of the CubicBezier object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegmentEndPointY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex)
@breif 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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
the value of the “y” attribute of the end point of the CubicBezier object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceCurveSegmentEndPointY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex, const double &y)
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 first Layout object 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.
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.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceCurveSegmentEndPointY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex, const double &y)
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.
layoutIndex – the index number of the Layout to return.
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.
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.
-
double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegmentBasePoint1X(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int curveSegmentIndex = 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 first Layout object 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.
- Returns:
the value of the “x” attribute of the base point 1 of the CubicBezier object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegmentBasePoint1X(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int curveSegmentIndex = 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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
the value of the “x” attribute of the base point 1 of the CubicBezier object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceCurveSegmentBasePoint1X(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex, const double &x)
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 first Layout object 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.
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.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceCurveSegmentBasePoint1X(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex, const double &x)
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.
layoutIndex – the index number of the Layout to return.
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.
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.
-
double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegmentBasePoint1Y(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex)
@breif 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 first Layout object 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.
- Returns:
the value of the “y” attribute of the base point 1 of the CubicBezier object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegmentBasePoint1Y(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex)
@breif 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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
the value of the “y” attribute of the base point 1 of the CubicBezier object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceCurveSegmentBasePoint1Y(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex, const double &y)
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 first Layout object 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.
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.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceCurveSegmentBasePoint1Y(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex, const double &y)
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.
layoutIndex – the index number of the Layout to return.
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.
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.
-
double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegmentBasePoint2X(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex)
@breif 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 first Layout object 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.
- Returns:
the value of the “x” attribute of the base point 2 of the CubicBezier object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegmentBasePoint2X(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex)
@breif 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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
the value of the “x” attribute of the base point 2 of the CubicBezier object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceCurveSegmentBasePoint2X(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex, const double &x)
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 first Layout object 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.
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.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceCurveSegmentBasePoint2X(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex, const double &x)
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.
layoutIndex – the index number of the Layout to return.
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.
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.
-
double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegmentBasePoint2Y(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex)
@breif 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 first Layout object 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.
- Returns:
the value of the “y” attribute of the base point 2 of the CubicBezier object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceCurveSegmentBasePoint2Y(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex)
@breif 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.
layoutIndex – the index number of the Layout to return.
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.
- Returns:
the value of the “y” attribute of the base point 2 of the CubicBezier object with the given index, or
0if the SpeciesReference object does not exits or the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceCurveSegmentBasePoint2Y(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex, const double &y)
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 first Layout object 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.
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::setSpeciesReferenceCurveSegmentBasePoint2Y(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int curveSegmentIndex, const double &y)
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.
layoutIndex – the index number of the Layout to return.
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.
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.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumTextGlyphs(SBMLDocument *document, unsigned int layoutIndex = 0)
Returns the number of TextGlyph objects 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.
- Returns:
the number of TextGlyph objects of the Layout object, or
0if the object isNULL
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumTextGlyphs(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0)
Returns the number of TextGlyph objects associated with entered id in the first Layout object 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 of the GraphicalObject.
- Returns:
the number of the TextGlyph objects associated with entered id of the Layout object, or
0if the object isNULL
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumTextGlyphs(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 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.
layoutIndex – the index number of the Layout to return.
id – the id of the model entity the TextGlyph objects associated with it to be returned.
graphicalObjectIndex – the index of the GraphicalObject.
- Returns:
the number of the TextGlyph objects associated with entered id of the Layout object, or
0if the object isNULL
-
std::vector<TextGlyph*> LIBSBMLNETWORK_CPP_NAMESPACE::getTextGlyphs(SBMLDocument *document, const std::string &id)
Returns the TextGlyph objects associated with the given id in the first Layout object 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.
- Returns:
the TextGlyph object with the given id, or an empty vector if TextGlyph objects does not exist or the object is
NULL
-
std::vector<TextGlyph*> LIBSBMLNETWORK_CPP_NAMESPACE::getTextGlyphs(SBMLDocument *document, unsigned int layoutIndex, const std::string &id)
Returns the TextGlyph objects associated with the given id 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 to return.
id – the id of the model entity the TextGlyph objects associated with it to be returned.
- Returns:
the TextGlyph object with the given id, or an empty vector if TextGlyph objects does not exist or the object is
NULL
-
TextGlyph *LIBSBMLNETWORK_CPP_NAMESPACE::getTextGlyph(SBMLDocument *document, const std::string &id, unsigned int textGlyphIndex = 0)
Returns a pointer to the TextGlyph object with the given index associated with the given id of the Layout object in the first Layout object 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.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
the TextGlyph object with the given index, or NULL if TextGlyph does not exist or the object is
NULL
-
TextGlyph *LIBSBMLNETWORK_CPP_NAMESPACE::getTextGlyph(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex = 0)
Returns a pointer to the TextGlyph object with the given index associated with the given id of the Layout object in the first Layout object of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
the TextGlyph object with the given index, or NULL if TextGlyph does not exist or the object is
NULL
-
TextGlyph *LIBSBMLNETWORK_CPP_NAMESPACE::getTextGlyph(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int textGlyphIndex = 0)
Returns a pointer to 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.
layoutIndex – the index number of the Layout to return.
id – the id of the model entity the TextGlyph objects associated with it to be returned.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
the TextGlyph object with the given index, or NULL if TextGlyph does not exist or the object is
NULL
-
TextGlyph *LIBSBMLNETWORK_CPP_NAMESPACE::getTextGlyph(SBMLDocument *document, unsigned int layoutIndex, GraphicalObject *graphicalObject, unsigned int textGlyphIndex = 0)
Returns a pointer to 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.
layoutIndex – the index number of the Layout to return.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
the TextGlyph object with the given index, or NULL if TextGlyph does not exist or the object is
NULL
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetText(SBMLDocument *document, const std::string &id)
Predicates returning
trueif the “text” attribute of TextGlyph object with the given index associated with the given id in the first Layout object of the SBML document is set.- Parameters:
document – a pointer to the SBMLDocument object.
id – the id of the model entity the TextGlyph objects associated with it to be returned.
- Returns:
trueif the “text” attribute of this TextGlyph object is set,falseif either the “text” attribute is not set, or TextGlyph does not exits or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetText(SBMLDocument *document, unsigned int layoutIndex, const std::string &id)
Predicates returning
trueif the “text” attribute of TextGlyph object with the given index associated with the given id in the Layout object with the given index of the SBML document is set.- 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 TextGlyph objects associated with it to be returned.
- Returns:
trueif the “text” attribute of this TextGlyph object is set,falseif either the “text” attribute is not set, or TextGlyph does not exits or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getText(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 0)
Returns the “text” attribute of the TextGlyph object with the given index associated with the given id in the first Layout object of the SBML document is set.
- 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 of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
the “text” attribute of this TextGlyph object or
emptystring if either the “text” attribute is not set , TextGlyph does not exits or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getText(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 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.
layoutIndex – the index number of the Layout to return.
id – the id of the model entity the TextGlyph objects associated with it to be returned.
graphicalObjectIndex – the index of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
the “text” attribute of this TextGlyph object or
emptystring if either the “text” attribute is not set , TextGlyph does not exits or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setText(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, const std::string &text)
Sets the value of the “text” attribute of the first TextGlyph object associated with the given id in the first Layout object 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 of the GraphicalObject.
text – a string value to be set as “text” attribute of the TextGlyph object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setText(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, const std::string &text)
Sets the value of the “text” attribute of the first TextGlyph object 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.
layoutIndex – the index number of the Layout to return.
id – the id of the model entity the TextGlyph objects associated with it to be returned.
graphicalObjectIndex – the index of the GraphicalObject.
text – a string value to be set as “text” attribute of the TextGlyph object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setText(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex, const std::string &text)
Sets the value of the “text” attribute of TextGlyph object with the given index associated with the given id in the first Layout object 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 of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
text – a string value to be set as “text” attribute of the TextGlyph object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setText(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex, const std::string &text)
Sets the value of the “text” attribute of 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.
layoutIndex – the index number of the Layout to return.
id – the id of the model entity the TextGlyph objects associated with it to be returned.
graphicalObjectIndex – the index of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
text – a string value to be set as “text” attribute of the TextGlyph object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addText(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, const std::string &text)
Adds a new TextGlyph object to the first Layout object of the SBML document and associates it with the given GraphicalObject object.
- 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 of the GraphicalObject.
text – a string value to be set as “text” attribute of the TextGlyph object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addText(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, const std::string &text)
Adds a new TextGlyph object to the Layout object with the given index of the SBML document and associates it with the given GraphicalObject object.
- 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 TextGlyph objects associated with it to be returned.
graphicalObjectIndex – the index of the GraphicalObject.
text – a string value to be set as “text” attribute of the TextGlyph object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeText(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex)
Removes the TextGlyph object with the given index associated with the given id in the first Layout object 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 of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeText(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex)
Removes 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.
layoutIndex – the index number of the Layout to return.
id – the id of the model entity the TextGlyph objects associated with it to be returned.
graphicalObjectIndex – the index of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetOriginOfTextId(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 0)
Predicates returning
trueif the origin of text of the TextGlyph object with the given index associated with the given id in the first Layout object of the SBML document is not the empty string.- 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 of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
trueif the origin of text of this TextGlyph object is not the empty string,falseif either the origin of text is empty, or TextGlyph does not exits or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetOriginOfTextId(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 0)
Predicates returning
trueif the origin of text 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 is not the empty string.- 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 TextGlyph objects associated with it to be returned.
graphicalObjectIndex – the index of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
trueif the origin of text of this TextGlyph object is not the empty string,falseif either the origin of text is empty, or TextGlyph does not exits or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getOriginOfTextId(const SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 0)
Returns the id of the origin of text of the TextGlyph object with the given index associated with the given id in the first Layout object 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 of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
the id of the origin of text of this TextGlyph object or
emptystring if either the “originOfTextId” attribute is not set , TextGlyph does not exits or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getOriginOfTextId(const SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 0)
Returns the id of the origin of text 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.
layoutIndex – the index number of the Layout to return.
id – the id of the model entity the TextGlyph objects associated with it to be returned.
graphicalObjectIndex – the index of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
the id of the origin of text of this TextGlyph object or
emptystring if either the “originOfTextId” attribute is not set , TextGlyph does not exits or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setOriginOfTextId(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, const std::string &orig)
Sets id of the origin of text of the first TextGlyph object with the given index associated with the given id in the first Layout object 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 of the GraphicalObject.
orig – a string value to be set as the if the origin of text attribute of the TextGlyph object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setOriginOfTextId(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, const std::string &orig)
Sets id of the origin of text of the first 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.
layoutIndex – the index number of the Layout to return.
id – the id of the model entity the TextGlyph objects associated with it to be returned.
graphicalObjectIndex – the index of the GraphicalObject.
orig – a string value to be set as the if the origin of text attribute of the TextGlyph object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setOriginOfTextId(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex, const std::string &orig)
Sets id of the origin of text of the TextGlyph object with the given index associated with the given id in the first Layout object 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 of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
orig – a string value to be set as the if the origin of text attribute of the TextGlyph object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setOriginOfTextId(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex, const std::string &orig)
Sets id of the origin of text 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.
layoutIndex – the index number of the Layout to return.
id – the id of the model entity the TextGlyph objects associated with it to be returned.
graphicalObjectIndex – the index of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
orig – a string value to be set as the if the origin of text attribute of the TextGlyph object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGraphicalObjectId(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 0)
Predicates returning
trueif id of the associated graphical object of the TextGlyph object with the given index associated with the given id in the first Layout object of the SBML document is not the empty string.- 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 of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
trueif the id of the associated graphical object of this TextGlyph object is not the empty string,falseif either the id of the associated graphical object is empty, or TextGlyph does not exits or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGraphicalObjectId(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 0)
Predicates returning
trueif id of the associated graphical object 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 is not the empty string.- 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 TextGlyph objects associated with it to be returned.
graphicalObjectIndex – the index of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
trueif the id of the associated graphical object of this TextGlyph object is not the empty string,falseif either the id of the associated graphical object is empty, or TextGlyph does not exits or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getGraphicalObjectId(const SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 0)
Returns the id of the associated graphical object of the TextGlyph object with the given index associated with the given id in the first Layout object 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 of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
the id of associated graphical object of this TextGlyph or
emptystring if either the “graphicalObjectId” attribute is not set , TextGlyph does not exits or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getGraphicalObjectId(const SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 0)
Returns the id of the associated graphical object 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.
layoutIndex – the index number of the Layout to return.
id – the id of the model entity the TextGlyph objects associated with it to be returned.
graphicalObjectIndex – the index of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
the id of associated graphical object of this TextGlyph or
emptystring if either the “graphicalObjectId” attribute is not set , TextGlyph does not exits or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGraphicalObjectId(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, const std::string &graphicalObjectId)
Sets the id of the associated graphical object of the first TextGlyph object associated with the given id in the first Layout object 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 of the GraphicalObject.
graphicalObjectId – a string value to be set as id of the associated graphical object of the TextGlyph object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGraphicalObjectId(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, const std::string &graphicalObjectId)
Sets the id of the associated graphical object of the first TextGlyph object 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.
layoutIndex – the index number of the Layout to return.
id – the id of the model entity the TextGlyph objects associated with it to be returned.
graphicalObjectIndex – the index of the GraphicalObject.
graphicalObjectId – a string value to be set as id of the associated graphical object of the TextGlyph object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGraphicalObjectId(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex, const std::string &graphicalObjectId)
Sets the id of the associated graphical object of the TextGlyph object with the given index associated with the given id in the first Layout object 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 of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
graphicalObjectId – a string value to be set as id of the associated graphical object of the TextGlyph object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGraphicalObjectId(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex, const std::string &graphicalObjectId)
Sets the id of the associated graphical object 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.
layoutIndex – the index number of the Layout to return.
id – the id of the model entity the TextGlyph objects associated with it to be returned.
graphicalObjectIndex – the index of the GraphicalObject.
textGlyphIndex – the index of the TextGlyph to return.
graphicalObjectId – a string value to be set as id of the associated graphical object of the TextGlyph object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isTextGlyph(SBMLDocument *document, const std::string &id, unsigned int textGlyphIndex = 0)
Predicate returning true if the abstract GraphicalObject with the given index associated with the given id in the first Layout object of the SBML document is of type TextGlyph.
- Parameters:
document – a pointer to the SBMLDocument object.
id – the id of the model entity the TextGlyph objects associated with it to be returned.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
trueif this abstract GraphicalObject is of type TextGlyph, false otherwise
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isTextGlyph(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int textGlyphIndex = 0)
Predicate returning true if the abstract GraphicalObject with the given index associated with the given id in the Layout object with the given index of the SBML document is of type TextGlyph.
- 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 TextGlyph objects associated with it to be returned.
textGlyphIndex – the index of the TextGlyph to return.
- Returns:
trueif this abstract GraphicalObject is of type TextGlyph, false otherwise
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumIndependentTextGlyphs(SBMLDocument *document, unsigned int layoutIndex)
Returns the number of independent TextGlyph objects associated with 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 to return.
- Returns:
the number of independent TextGlyph objects associated with the Layout object, or
0if the object isNULL
-
GraphicalObject *LIBSBMLNETWORK_CPP_NAMESPACE::getIndependentTextGlyph(SBMLDocument *document, unsigned int independentTextGlyphIndex)
Returns the independent TextGlyph object with the given index associated with the first Layout object of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
independentTextGlyphIndex – the index of the independent TextGlyph to return.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getIndependentTextGlyphId(SBMLDocument *document, unsigned int layoutIndex, unsigned int independentTextGlyphIndex)
Returns the id of the independent TextGlyph object with the given index associated with the first Layout object of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout to return.
independentTextGlyphIndex – the index of the independent TextGlyph to return.
- Returns:
the id of the independent TextGlyph object with the given index, or
emptystring if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addIndependentTextGlyph(SBMLDocument *document, unsigned int layoutIndex, const std::string &text, const double &x, const double &y, const double &width, const double &height)
Adds a new independent TextGlyph object to the first Layout object of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
text – the text of the independent TextGlyph object to be added.
x – the x position of the independent TextGlyph object to be added.
y – the y position of the independent TextGlyph object to be added.
width – the width dimension of the independent TextGlyph object to be added.
height – the height dimension of the independent TextGlyph object to be added.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeIndependentTextGlyph(SBMLDocument *document, unsigned int layoutIndex, unsigned int independentTextGlyphIndex)
Removes the independent TextGlyph object object with the given index associated with 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 to remove.
independentTextGlyphIndex – the index of the independent TextGlyph object to remove.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeIndependentTextGlyph(SBMLDocument *document, unsigned int layoutIndex, const std::string &id)
Removes the independent TextGlyph object with the given index associated with 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 to return.
id – the id of the independent TextGlyph to remove.
- Returns:
integer value indicating success/failure of the function.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumAdditionalGraphicalObjects(SBMLDocument *document, unsigned int layoutIndex = 0)
Returns the number of additional GraphicalObject objects associated with 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 to return.
- Returns:
the number of the additional GraphicalObject objects associated with the Layout object, or
0if the object isNULL
-
GraphicalObject *LIBSBMLNETWORK_CPP_NAMESPACE::getAdditionalGraphicalObject(SBMLDocument *document, unsigned int additionalGraphicalObjectIndex = 0)
Returns id of the additional GraphicalObject object with the given index associated with the first Layout object of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
additionalGraphicalObjectIndex – the index of the additional GraphicalObject to return.
- Returns:
the id of the additional GraphicalObject object with the given index, or
emptystring if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getAdditionalGraphicalObjectId(SBMLDocument *document, unsigned int layoutIndex = 0, unsigned int additionalGraphicalObjectIndex = 0)
Returns id of the additional GraphicalObject object with the given index associated with 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 to return.
additionalGraphicalObjectIndex – the index of the additional GraphicalObject to return.
- Returns:
the id of the additional GraphicalObject object with the given index, or
emptystring if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addAdditionalGraphicalObject(SBMLDocument *document, unsigned int layoutIndex, const std::string &id)
Adds a new GraphicalObject object to the first Layout object of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
id – the id of the additional GraphicalObject object to be added.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeAdditionalGraphicalObject(SBMLDocument *document, unsigned int layoutIndex, unsigned int additionalGraphicalObjectIndex = 0)
Removes the additional GraphicalObject object with the given index associated with 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 to return.
additionalGraphicalObjectIndex – the index of the additional GraphicalObject to return.
- Returns:
integer value indicating success/failure of the function.
-
BoundingBox *LIBSBMLNETWORK_CPP_NAMESPACE::getBoundingBox(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex)
Returns the BoundingBox object of the GraphicalObject with the given index associated with the model entity with the given id of the first Layout object 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.
- Returns:
a pointer to the BoundingBox object of the GraphicalObject object associated with the entered id, or
NULLif the GraphicalObject object does not exits or the object isNULL
-
BoundingBox *LIBSBMLNETWORK_CPP_NAMESPACE::getBoundingBox(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex)
Returns the BoundingBox object 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:
a pointer to the BoundingBox object of the GraphicalObject object associated with the entered id, or
NULLif the GraphicalObject object does not exits or the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getPositionX(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 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 first Layout object 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.
- Returns:
the “x” attribute of the bounding box of the GraphicalObject object, or
0.0if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getPositionX(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 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.
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.
- Returns:
the “x” attribute of the bounding box of the GraphicalObject object, or
0.0if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setPositionX(SBMLDocument *document, const std::string &id, const double &x, bool updateCurves = true)
Sets the value of the “x” attribute of the bounding box of the first GraphicalObject associated with the model entity with the given id of the first Layout object 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 use as the value of the “x” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setPositionX(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, const double &x, bool updateCurves = true)
Sets the value of the “x” attribute of the bounding box of the first GraphicalObject 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.
x – a double value to use as the value of the “x” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setPositionX(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, const double &x, 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 first Layout object 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.
x – a double value to use as the value of the “x” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setPositionX(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, const double &x, 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.
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.
x – a double value to use as the value of the “x” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getPositionY(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 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 first Layout object 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.
- Returns:
the “y” attribute of the bounding box of the GraphicalObject object, or
0.0if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getPositionY(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 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.
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 “y” attribute of the bounding box of the GraphicalObject object, or
0.0if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setPositionY(SBMLDocument *document, const std::string &id, const double &y, bool updateCurves = true)
Sets the value of the “y” attribute of the bounding box of the first GraphicalObject associated with the model entity with the given id of the first Layout object 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 use as the value of the “y” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setPositionY(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, const double &y, bool updateCurves = true)
Sets the value of the “y” attribute of the bounding box of the first GraphicalObject 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.
y – a double value to use as the value of the “y” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setPositionY(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, const double &y, 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 first Layout object 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.
y – a double value to use as the value of the “y” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setPositionY(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, const double &y, 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.
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.
y – a double value to use as the value of the “y” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setPosition(SBMLDocument *document, const std::string &id, const double &x, const double &y, bool updateCurves)
@breif Sets th value of the “x” and “y” attributes of the bounding box of the first GraphicalObject associated with the model entity with the given id of the first Layout object 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 use as the value of the “x” attribute of the bounding box of this GraphicalObject object.
y – a double value to use as the value of the “y” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setPosition(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, const double &x, const double &y, bool updateCurves)
@breif Sets th value of the “x” and “y” attributes of the bounding box of the first GraphicalObject 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.
x – a double value to use as the value of the “x” attribute of the bounding box of this GraphicalObject object.
y – a double value to use as the value of the “y” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setPosition(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, const double &x, const double &y, bool updateCurves)
@breif Sets th value 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 first Layout object 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.
x – a double value to use as the value of the “x” attribute of the bounding box of this GraphicalObject object.
y – a double value to use as the value of the “y” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setPosition(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, const double &x, const double &y, bool updateCurves)
@breif Sets th value 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.
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.
x – a double value to use as the value of the “x” attribute of the bounding box of this GraphicalObject object.
y – a double value to use as the value of the “y” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getDimensionWidth(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0)
Returns the value of the “width” attribute of the bounding box of the bounding box of the GraphicalObject with the given index associated with the model entity with the given id of the first Layout object 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.
- Returns:
the “width” attribute of the bounding box of the GraphicalObject object, or
0.0if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getDimensionWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0)
Returns the value of the “width” attribute of the bounding box 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.
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 “width” attribute of the bounding box of the GraphicalObject object, or
0.0if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setDimensionWidth(SBMLDocument *document, const std::string &id, const double &width, bool updateCurves = true)
Sets the value of the “width” attribute of the bounding box of the first GraphicalObject associated with the model entity with the given id of the first Layout object 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 use as the value of the “width” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setDimensionWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, const double &width, bool updateCurves = true)
Sets the value of the “width” attribute of the bounding box of the first GraphicalObject 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.
width – a double value to use as the value of the “width” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setDimensionWidth(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, const double &width, bool updateCurves = true)
Sets the value of the “width” attribute of the bounding box the GraphicalObject with the given index associated with the model entity with the given id of the first Layout object 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.
width – a double value to use as the value of the “width” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setDimensionWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, const double &width, bool updateCurves = true)
Sets the value of the “width” attribute of the bounding box 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.
width – a double value to use as the value of the “width” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentDimensionWidth(SBMLDocument *document, unsigned int layoutIndex, const double &width, bool updateCurves = true)
Sets the value of the “width” attribute the bounding box of all the CompartmentGlyph objects in 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.
width – a double value to use as the value of the “width” attribute of the bounding box of all the CompartmentGlyph objects.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesDimensionWidth()
Returns the default value of the “width” attribute of the bounding box of the SpeciesGlyph objects.
- Returns:
the default “width” attribute of the bounding box of the SpeciesGlyph objects.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesDimensionWidth(SBMLDocument *document, unsigned int layoutIndex, const double &width, bool updateCurves = true)
Sets the value of the “width” attribute the bounding box of all the SpeciesGlyph objects in 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.
width – a double value to use as the value of the “width” attribute of the bounding box of all the SpeciesGlyph objects.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionDimensionWidth()
Returns the default value of the “width” attribute of the bounding box of the ReactionGlyph objects.
- Returns:
the default “width” attribute of the bounding box of the ReactionGlyph objects.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getEmptySpeciesDefaultWidth()
Returns the default value of the “width” attribute of the bounding box of the SpeciesGlyph used to represent an empty Species.
- Returns:
the default “width” attribute of the bounding box of the SpeciesGlyph used to represent an empty Species
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionDimensionWidth(SBMLDocument *document, unsigned int layoutIndex, const double &width, bool updateCurves = true)
Sets the value of the “width” attribute the bounding box of all the ReactionGlyph objects in 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.
width – a double value to use as the value of the “width” attribute of the bounding box of all the ReactionGlyph objects.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getDimensionHeight(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0)
Returns the value of the “height” attribute of the bounding box of the bounding box of the GraphicalObject with the given index associated with the model entity with the given id of the first Layout object 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.
- Returns:
the “height” attribute of the bounding box of the GraphicalObject object, or
0.0if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getDimensionHeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0)
Returns the value of the “height” attribute of the bounding box 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.
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 “height” attribute of the bounding box of the GraphicalObject object, or
0.0if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setDimensionHeight(SBMLDocument *document, const std::string &id, const double &height, bool updateCurves = true)
Sets the value of the “height” attribute of the bounding box of the bounding box of the first GraphicalObject associated with the model entity with the given id of the first Layout object 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 use as the value of the “height” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setDimensionHeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, const double &height, bool updateCurves = true)
Sets the value of the “height” attribute of the bounding box of the bounding box of the first GraphicalObject 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.
height – a double value to use as the value of the “height” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setDimensionHeight(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, const double &height, bool updateCurves = true)
Sets the value of the “height” attribute of the bounding box of the GraphicalObject object with the given index of associated with the object with the given id of the first Layout object 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.
height – a double value to use as the value of the “height” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setDimensionHeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, const double &height, bool updateCurves = true)
Sets the value of the “height” attribute of the bounding box of the GraphicalObject object with the given index of associated with the object 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.
height – a double value to use as the value of the “height” attribute of the bounding box of this GraphicalObject object.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentDimensionHeight(SBMLDocument *document, unsigned int layoutIndex, const double &height, bool updateCurves = true)
Sets the value of the “height” attribute of the bounding box of all the CompartmentGlyph objects in 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.
height – a double value to use as the value of the “height” attribute of the bounding box of all the CompartmentGlyph objects.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesDimensionHeight()
Returns the default value of the “height” attribute of the bounding box of the SpeciesGlyph objects.
- Returns:
the default “height” attribute of the bounding box of the SpeciesGlyph objects.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesDimensionHeight(SBMLDocument *document, unsigned int layoutIndex, const double &height, bool updateCurves = true)
Sets the value of the “height” attribute of the bounding box of all the SpeciesGlyph objects in 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.
height – a double value to use as the value of the “height” attribute of the bounding box of all the SpeciesGlyph objects.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionDimensionHeight()
Returns the default value of the “height” attribute of the bounding box of the ReactionGlyph objects.
- Returns:
the default “height” attribute of the bounding box of the ReactionGlyph objects.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getEmptySpeciesDefaultHeight()
Returns the default value of the “height” attribute of the bounding box of the SpeciesGlyph used to represent an empty Species.
- Returns:
the default “height” attribute of the bounding box of the SpeciesGlyph used to represent an empty Species
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionDimensionHeight(SBMLDocument *document, unsigned int layoutIndex, const double &height, bool updateCurves = true)
Sets the value of the “height” attribute of the bounding box of all the ReactionGlyph objects in 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.
height – a double value to use as the value of the “height” attribute of the bounding box of all the ReactionGlyph objects.
updateCurves – a boolean value, indicating whether the rest of the layout curves (with fixed position nodes) should be adjusted. Default ‘true’.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getTextPositionX(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 0)
Retrieves the “x” position of a TextGlyph object within a specific layout. This function fetches the “x” coordinate of the bounding box of a TextGlyph object, identified by its associated model entity ID and within a specified layout of the SBML document. The layout is determined by its index. Defaults for graphicalObjectIndex and textGlyphIndex are 0. If the TextGlyph object or the layout does not exist, the function returns 0.0.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be retrieved.
graphicalObjectIndex – (Optional) The index of the GraphicalObject within the layout. Defaults to 0.
textGlyphIndex – (Optional) The index of the TextGlyph within the graphical object. Defaults to 0.
- Returns:
The “x” position of the bounding box of the specified TextGlyph object, or 0.0 if the object is NULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getTextPositionX(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 0)
Retrieves the “x” position of a TextGlyph object within a specific layout. This function fetches the “x” coordinate of the bounding box of a TextGlyph object, identified by its index and associated with a model entity identified by its ID, within a specified layout of the SBML document. The layout is determined by its index. Defaults for graphicalObjectIndex and textGlyphIndex are 0. If the TextGlyph object or the layout does not exist, the function returns 0.0.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document from which to retrieve the TextGlyph object.
id – The ID of the model entity associated with the TextGlyph object to be retrieved.
graphicalObjectIndex – (Optional) The index of the GraphicalObject within the layout. Defaults to 0.
textGlyphIndex – (Optional) The index of the TextGlyph within the graphical object. Defaults to 0.
- Returns:
The “x” position of the bounding box of the specified TextGlyph object, or 0.0 if the object is NULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPositionX(SBMLDocument *document, const std::string &id, const double &x)
Sets the “x” position of a TextGlyph object within the first layout of the SBML document. This function assigns a new “x” coordinate to the bounding box of a TextGlyph object, identified by its associated model entity ID. This operation is performed within the first layout of the SBML document.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be modified.
x – The new “x” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPositionX(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, const double &x)
Sets the “x” position of a TextGlyph object within a specific layout of the SBML document. This function assigns a new “x” coordinate to the bounding box of a TextGlyph object, identified by its associated model entity ID and within a specified layout of the SBML document. The layout is determined by its index.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document in which the TextGlyph object is located.
id – The ID of the model entity associated with the TextGlyph object to be modified.
x – The new “x” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPositionX(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, const double &x)
Sets the “x” position of a TextGlyph object, identified by graphical object index, within the first layout of the SBML document. This function assigns a new “x” coordinate to the bounding box of a TextGlyph object, identified by its associated model entity ID and graphical object index, within the first layout of the SBML document.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
x – The new “x” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPositionX(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, const double &x)
Sets the “x” position of a TextGlyph object, identified by graphical object index, within a specific layout of the SBML document. This function assigns a new “x” coordinate to the bounding box of a TextGlyph object, identified by its associated model entity ID and graphical object index, within a specified layout of the SBML document. The layout is determined by its index.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document in which the TextGlyph object is located.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
x – The new “x” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPositionX(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex, const double &x)
Sets the “x” position of a TextGlyph object, identified by both graphical and text glyph indices, within the first layout of the SBML document. This function assigns a new “x” coordinate to the bounding box of a TextGlyph object, identified by its associated model entity ID, graphical object index, and text glyph index, within the first layout of the SBML document.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
textGlyphIndex – The index of the TextGlyph within the graphical object.
x – The new “x” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPositionX(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex, const double &x)
Sets the “x” position of a TextGlyph object, identified by both graphical and text glyph indices, within a specific layout of the SBML document. This function assigns a new “x” coordinate to the bounding box of a TextGlyph object, identified by its associated model entity ID, graphical object index, and text glyph index, within a specified layout of the SBML document. The layout is determined by its index.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document in which the TextGlyph object is located.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
textGlyphIndex – The index of the TextGlyph within the graphical object.
x – The new “x” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getTextPositionY(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 0)
Retrieves the “y” position of a TextGlyph object within the first layout of the SBML document. This function fetches the “y” coordinate of the bounding box of a TextGlyph object, identified by its index and associated with a model entity identified by its ID, within the first layout of the SBML document. Defaults for graphicalObjectIndex and textGlyphIndex are 0. If the TextGlyph object does not exist, the function returns 0.0.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be retrieved.
graphicalObjectIndex – (Optional) The index of the GraphicalObject within the layout. Defaults to 0.
textGlyphIndex – (Optional) The index of the TextGlyph within the graphical object. Defaults to 0.
- Returns:
The “y” position of the bounding box of the specified TextGlyph object, or 0.0 if the object is NULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getTextPositionY(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 0)
Retrieves the “y” position of a TextGlyph object within a specific layout of the SBML document. This function fetches the “y” coordinate of the bounding box of a TextGlyph object, identified by its index and associated with a model entity identified by its ID, within a specified layout of the SBML document. The layout is determined by its index. Defaults for graphicalObjectIndex and textGlyphIndex are 0. If the TextGlyph object or the layout does not exist, the function returns 0.0.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document from which to retrieve the TextGlyph object.
id – The ID of the model entity associated with the TextGlyph object to be retrieved.
graphicalObjectIndex – (Optional) The index of the GraphicalObject within the layout. Defaults to 0.
textGlyphIndex – (Optional) The index of the TextGlyph within the graphical object. Defaults to 0.
- Returns:
The “y” position of the bounding box of the specified TextGlyph object, or 0.0 if the object is NULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPositionY(SBMLDocument *document, const std::string &id, const double &y)
Sets the “y” position of a TextGlyph object within the first layout of the SBML document. This function assigns a new “y” coordinate to the bounding box of a TextGlyph object, identified by its associated model entity ID. This operation is performed within the first layout of the SBML document.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be modified.
y – The new “y” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPositionY(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, const double &y)
Sets the “y” position of a TextGlyph object within a specific layout of the SBML document. This function assigns a new “y” coordinate to the bounding box of a TextGlyph object, identified by its associated model entity ID and within a specified layout of the SBML document. The layout is determined by its index.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document in which the TextGlyph object is located.
id – The ID of the model entity associated with the TextGlyph object to be modified.
y – The new “y” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPositionY(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, const double &y)
Sets the “y” position of a TextGlyph object, identified by graphical object index, within the first layout of the SBML document. This function assigns a new “y” coordinate to the bounding box of a TextGlyph object, identified by its associated model entity ID and graphical object index, within the first layout of the SBML document.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
y – The new “y” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPositionY(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, const double &y)
Sets the “y” position of a TextGlyph object, identified by graphical object index, within a specific layout of the SBML document. This function assigns a new “y” coordinate to the bounding box of a TextGlyph object, identified by its associated model entity ID and graphical object index, within a specified layout of the SBML document. The layout is determined by its index.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document in which the TextGlyph object is located.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
y – The new “y” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPositionY(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex, const double &y)
Sets the “y” position of a TextGlyph object, identified by both graphical and text glyph indices, within the first layout of the SBML document. This function assigns a new “y” coordinate to the bounding box of a TextGlyph object, identified by its associated model entity ID, graphical object index, and text glyph index, within the first layout of the SBML document.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
textGlyphIndex – The index of the TextGlyph within the graphical object.
y – The new “y” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPositionY(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex, const double &y)
Sets the “y” position of a TextGlyph object, identified by both graphical and text glyph indices, within a specific layout of the SBML document. This function assigns a new “y” coordinate to the bounding box of a TextGlyph object, identified by its associated model entity ID, graphical object index, and text glyph index, within a specified layout of the SBML document. The layout is determined by its index.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document in which the TextGlyph object is located.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
textGlyphIndex – The index of the TextGlyph within the graphical object.
y – The new “y” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPosition(SBMLDocument *document, const std::string &id, const double &x, const double &y)
Sets both the “x” and “y” positions of a TextGlyph object within the first layout of the SBML document. This function assigns new “x” and “y” coordinates to the bounding box of a TextGlyph object, identified by its associated model entity ID. This operation is performed within the first layout of the SBML document.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be modified.
x – The new “x” position to set for the bounding box of the TextGlyph object.
y – The new “y” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPosition(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, const double &x, const double &y)
Sets both the “x” and “y” positions of a TextGlyph object within a specific layout of the SBML document. This function assigns new “x” and “y” coordinates to the bounding box of a TextGlyph object, identified by its associated model entity ID and within a specified layout of the SBML document. The layout is determined by its index.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document in which the TextGlyph object is located.
id – The ID of the model entity associated with the TextGlyph object to be modified.
x – The new “x” position to set for the bounding box of the TextGlyph object.
y – The new “y” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPosition(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, const double &x, const double &y)
Sets both the “x” and “y” positions of a TextGlyph object, identified by graphical object index, within the first layout of the SBML document. This function assigns new “x” and “y” coordinates to the bounding box of a TextGlyph object, identified by its associated model entity ID and graphical object index, within the first layout of the SBML document.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
x – The new “x” position to set for the bounding box of the TextGlyph object.
y – The new “y” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPosition(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, const double &x, const double &y)
Sets both the “x” and “y” positions of a TextGlyph object, identified by graphical object index, within a specific layout of the SBML document. This function assigns new “x” and “y” coordinates to the bounding box of a TextGlyph object, identified by its associated model entity ID and graphical object index, within a specified layout of the SBML document. The layout is determined by its index.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document in which the TextGlyph object is located.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
x – The new “x” position to set for the bounding box of the TextGlyph object.
y – The new “y” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPosition(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex, const double &x, const double &y)
Sets both the “x” and “y” positions of a TextGlyph object within the first layout of the SBML document. This function assigns new “x” and “y” coordinates to the bounding box of a TextGlyph object, identified by its associated model entity ID, graphical object index, and text glyph index. This operation is performed within the first layout of the SBML document.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
textGlyphIndex – The index of the TextGlyph within the graphical object.
x – The new “x” position to set for the bounding box of the TextGlyph object.
y – The new “y” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextPosition(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex, const double &x, const double &y)
Sets both the “x” and “y” positions of a TextGlyph object within a specific layout of the SBML document. This function assigns new “x” and “y” coordinates to the bounding box of a TextGlyph object, identified by its associated model entity ID, graphical object index, and text glyph index, within a specified layout of the SBML document. The layout is determined by its index.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document in which the TextGlyph object is located.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
textGlyphIndex – The index of the TextGlyph within the graphical object.
x – The new “x” position to set for the bounding box of the TextGlyph object.
y – The new “y” position to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getTextDimensionWidth(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 0)
Retrieves the width of the bounding box of a TextGlyph object within the first layout of the SBML document. This function fetches the width of the bounding box of a TextGlyph object, identified by its associated model entity ID, graphical object index, and text glyph index, within the first layout of the SBML document. Defaults for graphicalObjectIndex and textGlyphIndex are 0. If the TextGlyph object does not exist, the function returns 0.0.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be retrieved.
graphicalObjectIndex – (Optional) The index of the GraphicalObject within the layout. Defaults to 0.
textGlyphIndex – (Optional) The index of the TextGlyph within the graphical object. Defaults to 0.
- Returns:
The width of the bounding box of the specified TextGlyph object, or 0.0 if the object is NULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getTextDimensionWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 0)
Retrieves the width of the bounding box of a TextGlyph object within a specific layout of the SBML document. This function fetches the width of the bounding box of a TextGlyph object, identified by its associated model entity ID, graphical object index, and text glyph index, within a specified layout of the SBML document. The layout is determined by its index. Defaults for graphicalObjectIndex and textGlyphIndex are 0. If the TextGlyph object or the layout does not exist, the function returns 0.0.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document from which to retrieve the TextGlyph object.
id – The ID of the model entity associated with the TextGlyph object to be retrieved.
graphicalObjectIndex – (Optional) The index of the GraphicalObject within the layout. Defaults to 0.
textGlyphIndex – (Optional) The index of the TextGlyph within the graphical object. Defaults to 0.
- Returns:
The width of the bounding box of the specified TextGlyph object, or 0.0 if the object is NULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextDimensionWidth(SBMLDocument *document, const std::string &id, const double &width)
Sets the width of the bounding box of a TextGlyph object within the first layout of the SBML document. This function assigns a new width to the bounding box of a TextGlyph object, identified by its associated model entity ID. This operation is performed within the first layout of the SBML document.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be modified.
width – The new width to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextDimensionWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, const double &width)
Sets the width of the bounding box of a TextGlyph object within a specific layout of the SBML document. This function assigns a new width to the bounding box of a TextGlyph object, identified by its associated model entity ID and within a specified layout of the SBML document. The layout is determined by its index.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document in which the TextGlyph object is located.
id – The ID of the model entity associated with the TextGlyph object to be modified.
width – The new width to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextDimensionWidth(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, const double &width)
Sets the width of the bounding box of a TextGlyph object, identified by graphical object index, within the first layout of the SBML document. This function assigns a new width to the bounding box of a TextGlyph object, identified by its associated model entity ID and graphical object index, within the first layout of the SBML document.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
width – The new width to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextDimensionWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, const double &width)
Sets the width of the bounding box of a TextGlyph object, identified by graphical object index, within a specific layout of the SBML document. This function assigns a new width to the bounding box of a TextGlyph object, identified by its associated model entity ID and graphical object index, within a specified layout of the SBML document. The layout is determined by its index.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document in which the TextGlyph object is located.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
width – The new width to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextDimensionWidth(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex, const double &width)
Sets the width of the bounding box of a TextGlyph object, identified by both graphical and text glyph indices, within the first layout of the SBML document. This function assigns a new width to the bounding box of a TextGlyph object, identified by its associated model entity ID, graphical object index, and text glyph index, within the first layout of the SBML document.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
textGlyphIndex – The index of the TextGlyph within the graphical object.
width – The new width to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextDimensionWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex, const double &width)
Sets the width of the bounding box of a TextGlyph object within a specific layout of the SBML document. This function assigns a new width to the bounding box of a TextGlyph object, identified by its associated model entity ID, graphical object index, and text glyph index, within a specified layout of the SBML document. The layout is determined by its index.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document in which the TextGlyph object is located.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
textGlyphIndex – The index of the TextGlyph within the graphical object.
width – The new width to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getTextDimensionHeight(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 0)
Retrieves the height of the bounding box of a TextGlyph object within the first layout of the SBML document. This function fetches the height of the bounding box of a TextGlyph object, identified by its index and associated with a model entity identified by its ID, within the first layout of the SBML document. Defaults for graphicalObjectIndex and textGlyphIndex are 0. If the TextGlyph object does not exist, the function returns 0.0.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be retrieved.
graphicalObjectIndex – (Optional) The index of the GraphicalObject within the layout. Defaults to 0.
textGlyphIndex – (Optional) The index of the TextGlyph within the graphical object. Defaults to 0.
- Returns:
The height of the bounding box of the specified TextGlyph object, or 0.0 if the object is NULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getTextDimensionHeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int textGlyphIndex = 0)
Retrieves the height of the bounding box of a TextGlyph object within a specific layout of the SBML document. This function fetches the height of the bounding box of a TextGlyph object, identified by its associated model entity ID, graphical object index, and text glyph index, within a specified layout of the SBML document. The layout is determined by its index. Defaults for graphicalObjectIndex and textGlyphIndex are 0. If the TextGlyph object or the layout does not exist, the function returns 0.0.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document from which to retrieve the TextGlyph object.
id – The ID of the model entity associated with the TextGlyph object to be retrieved.
graphicalObjectIndex – (Optional) The index of the GraphicalObject within the layout. Defaults to 0.
textGlyphIndex – (Optional) The index of the TextGlyph within the graphical object. Defaults to 0.
- Returns:
The height of the bounding box of the specified TextGlyph object, or 0.0 if the object is NULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextDimensionHeight(SBMLDocument *document, const std::string &id, const double &height)
Sets the height of the bounding box of a TextGlyph object within the first layout of the SBML document. This function assigns a new height to the bounding box of a TextGlyph object, identified by its associated model entity ID. This operation is performed within the first layout of the SBML document.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be modified.
height – The new height to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextDimensionHeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, const double &height)
Sets the height of the bounding box of a TextGlyph object within a specific layout of the SBML document. This function assigns a new height to the bounding box of a TextGlyph object, identified by its associated model entity ID and within a specified layout of the SBML document. The layout is determined by its index.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document in which the TextGlyph object is located.
id – The ID of the model entity associated with the TextGlyph object to be modified.
height – The new height to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextDimensionHeight(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, const double &height)
Sets the height of the bounding box of a TextGlyph object, identified by graphical object index, within the first layout of the SBML document. This function assigns a new height to the bounding box of a TextGlyph object, identified by its associated model entity ID and graphical object index, within the first layout of the SBML document.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
height – The new height to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextDimensionHeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, const double &height)
Sets the height of the bounding box of a TextGlyph object, identified by graphical object index, within a specific layout of the SBML document. This function assigns a new height to the bounding box of a TextGlyph object, identified by its associated model entity ID and graphical object index, within a specified layout of the SBML document. The layout is determined by its index.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document in which the TextGlyph object is located.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
height – The new height to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextDimensionHeight(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex, const double &height)
Sets the height of the bounding box of a TextGlyph object within the first layout of the SBML document. This function assigns a new height to the bounding box of a TextGlyph object, identified by its associated model entity ID, graphical object index, and text glyph index. This operation is performed within the first layout of the SBML document.
- Parameters:
document – A pointer to the SBMLDocument object.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
textGlyphIndex – The index of the TextGlyph within the graphical object.
height – The new height to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextDimensionHeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int textGlyphIndex, const double &height)
Sets the height of the bounding box of a TextGlyph object within a specific layout of the SBML document. This function assigns a new height to the bounding box of a TextGlyph object, identified by its associated model entity ID, graphical object index, and text glyph index, within a specified layout of the SBML document. The layout is determined by its index.
- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – The index of the layout within the SBML document in which the TextGlyph object is located.
id – The ID of the model entity associated with the TextGlyph object to be modified.
graphicalObjectIndex – The index of the GraphicalObject within the layout.
textGlyphIndex – The index of the TextGlyph within the graphical object.
height – The new height to set for the bounding box of the TextGlyph object.
- Returns:
An integer value indicating success (non-zero) or failure (zero).
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetCurve(const SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0)
Predicate returning true if the GraphicalObject with the given index associated with the model entity with the given id of the first Layout object 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.
- Returns:
trueif the GraphicalObject has a Curve object and the curve consists of one or more segments, false otherwise
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetCurve(const SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 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.
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:
trueif the GraphicalObject has a Curve object and the curve consists of one or more segments, false otherwise
-
Curve *LIBSBMLNETWORK_CPP_NAMESPACE::getCurve(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0)
Returns the Curve object of the GraphicalObject with the given index associated with the model entity with the given id of the first Layout object 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.
- Returns:
the Curve object of the GraphicalObject object, or
NULLif the object isNULLor does not have a Curve object
-
Curve *LIBSBMLNETWORK_CPP_NAMESPACE::getCurve(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0)
Returns the Curve object 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 Curve object of the GraphicalObject object, or
NULLif the object isNULLor does not have a Curve object
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumCurveSegments(const SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 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 first Layout object 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.
- Returns:
the number of curve segments of the curve of the GraphicalObject object, or
0if the object isNULLor does not have a curve
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumCurveSegments(const SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 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
0if the object isNULLor does not have a curve
-
LineSegment *LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegment(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 0)
Returns a pointer to the curve segment with the given index of the GraphicalObject with the given index associated with the model entity with the given id of the first Layout object 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 – the index value of the curve segment to return.
- Returns:
the
LineSegmentrepresenting the child “curveSegment” with the appropriate index, or NULL if no such LineSegment exists for this GraphicalObject object.
-
LineSegment *LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegment(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 0)
Returns a pointer to the curve segment with the given index 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.
curveSegmentIndex – the index value of the curve segment to return.
- Returns:
the
LineSegmentrepresenting the child “curveSegment” with the appropriate index, or NULL if no such LineSegment exists for this GraphicalObject object.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addLineCurveSegment(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0)
Creates a new LineSegment and adds it to the end of the list of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the first Layout object 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.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addLineCurveSegment(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0)
Creates a new LineSegment and adds it to the end of the list 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:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addCubicBezierCurveSegment(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0)
Creates a new CubicBezier and adds it to the end of the list of the curve of the GraphicalObject with the given index associated with the model entity with the given id of the first Layout object 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.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addCubicBezierCurveSegment(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0)
Creates a new CubicBezier and adds it to the end of the list 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:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeCurveSegment(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 0)
Removes and deletes the curve segment with the given index from the list of the Curve of the GraphicalObject with the given index associated with the model entity with the given id of the first Layout object 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 unsigned int representing the index of the curve segment to remove.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeCurveSegment(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 0)
Removes and deletes the curve segment with the given index from the list 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.
curveSegmentIndex – an unsigned int representing the index of the curve segment to remove.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isCubicBezier(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 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 first Layout object 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 unsigned int representing the index of the curve segment.
- Returns:
trueif this curve segment is of type CubicBezier, false otherwise
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isCubicBezier(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 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.
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.
curveSegmentIndex – an unsigned int representing the index of the curve segment.
- Returns:
trueif this curve segment is of type CubicBezier, false otherwise
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegmentStartPointX(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 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 first Layout object 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 unsigned int representing the index of the curve segment to retrieve.
- 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.0if the object isNULLor does not have a curve
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegmentStartPointX(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 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.
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.
curveSegmentIndex – an unsigned int representing the index of the curve segment to retrieve.
- 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.0if the object isNULLor does not have a curve
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentStartPointX(SBMLDocument *document, const std::string &id, unsigned int curveSegmentIndex, const double &x)
Sets the value of the “x” attribute of the start point of the curve segment with the given index of the curve of the first GraphicalObject associated with the model entity with the given id of the first Layout object 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.
curveSegmentIndex – an unsigned int representing the index of the curve segment to retrieve.
x – a double value to use as the value of the “x” attribute of the start point of the curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentStartPointX(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int curveSegmentIndex, const double &x)
Sets the value of the “x” attribute of the start point of the curve segment with the given index of the curve of the first GraphicalObject 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.
curveSegmentIndex – an unsigned int representing the index of the curve segment to retrieve.
x – a double value to use as the value of the “x” attribute of the start point of the curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentStartPointX(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, unsigned int curveSegmentIndex, const double &x)
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 first Layout object 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 unsigned int representing the index of the curve segment to retrieve.
x – a double value to use as the value of the “x” attribute of the start point of the curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentStartPointX(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int curveSegmentIndex, const double &x)
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.
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.
curveSegmentIndex – an unsigned int representing the index of the curve segment to retrieve.
x – a double value to use as the value of the “x” attribute of the start point of the curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegmentStartPointY(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 0)
Returns the value of the “y” attribute of the start point of the curve segment with the given index of the curve the GraphicalObject with the given index associated with the model entity with the given id of the first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
- Returns:
the “y” attribute of the start point of the curve segment with the given index of the curve of this GraphicalObject object, or
0.0if the object isNULLor does not have a curve
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegmentStartPointY(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 0)
Returns the value of the “y” attribute of the start point of the curve segment with the given index of the curve 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.
n – an unsigned int representing the index of the curve segment to retrieve.
- Returns:
the “y” attribute of the start point of the curve segment with the given index of the curve of this GraphicalObject object, or
0.0if the object isNULLor does not have a curve
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentStartPointY(SBMLDocument *document, const std::string &id, unsigned int curveSegmentIndex, const double &y)
Sets the value of the “y” attribute of the start point of curve segment with the given index of the curve of the first GraphicalObject associated with the model entity with the given id of the first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
y – a double value to use as the value of the “y” attribute of the start point of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentStartPointY(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int curveSegmentIndex, const double &y)
Sets the value of the “y” attribute of the start point of curve segment with the given index of the curve of the first GraphicalObject 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.
n – an unsigned int representing the index of the curve segment to retrieve.
y – a double value to use as the value of the “y” attribute of the start point of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentStartPointY(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, unsigned int curveSegmentIndex, const double &y)
Sets the value of the “y” attribute of the start point of 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 first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
y – a double value to use as the value of the “y” attribute of the start point of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentStartPointY(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int curveSegmentIndex, const double &y)
Sets the value of the “y” attribute of the start point of 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.
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.
n – an unsigned int representing the index of the curve segment to retrieve.
y – a double value to use as the value of the “y” attribute of the start point of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegmentEndPointX(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 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 first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
- Returns:
the “x” attribute of the end point of the curve segment with the given index of the curve of this GraphicalObject object, or
0.0if the object isNULLor does not have a curve
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegmentEndPointX(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 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.
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.
n – an unsigned int representing the index of the curve segment to retrieve.
- Returns:
the “x” attribute of the end point of the curve segment with the given index of the curve of this GraphicalObject object, or
0.0if the object isNULLor does not have a curve
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentEndPointX(SBMLDocument *document, const std::string &id, unsigned int curveSegmentIndex, const double &x)
Sets the value of the “x” attribute of the end point of curve segment with the given index of the curve of the first GraphicalObject associated with the model entity with the given id of the first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
x – a double value to use as the value of the “x” attribute of the end point of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentEndPointX(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int curveSegmentIndex, const double &x)
Sets the value of the “x” attribute of the end point of curve segment with the given index of the curve of the first GraphicalObject 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.
n – an unsigned int representing the index of the curve segment to retrieve.
x – a double value to use as the value of the “x” attribute of the end point of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentEndPointX(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, unsigned int curveSegmentIndex, const double &x)
Sets the value of the “x” attribute of the end point of 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 first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
x – a double value to use as the value of the “x” attribute of the end point of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentEndPointX(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int curveSegmentIndex, const double &x)
Sets the value of the “x” attribute of the end point of 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.
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.
n – an unsigned int representing the index of the curve segment to retrieve.
x – a double value to use as the value of the “x” attribute of the end point of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegmentEndPointY(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 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 first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
- Returns:
the “y” attribute of the end point of the curve segment with the given index of the curve of this GraphicalObject object, or
0.0if the object isNULLor does not have a curve
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegmentEndPointY(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 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.
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.
n – an unsigned int representing the index of the curve segment to retrieve.
- Returns:
the “y” attribute of the end point of the curve segment with the given index of the curve of this GraphicalObject object, or
0.0if the object isNULLor does not have a curve
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentEndPointY(SBMLDocument *document, const std::string &id, unsigned int curveSegmentIndex, const double &y)
Sets the value of the “y” attribute of the end point of curve segment with the given index of the curve of the first GraphicalObject associated with the model entity with the given id of the first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
y – a double value to use as the value of the “y” attribute of the end point of curve segment with the given index of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentEndPointY(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int curveSegmentIndex, const double &y)
Sets the value of the “y” attribute of the end point of curve segment with the given index of the curve of the first GraphicalObject 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.
n – an unsigned int representing the index of the curve segment to retrieve.
y – a double value to use as the value of the “y” attribute of the end point of curve segment with the given index of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentEndPointY(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, unsigned int curveSegmentIndex, const double &y)
Sets the value of the “y” attribute of the end point of 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 first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
y – a double value to use as the value of the “y” attribute of the end point of curve segment with the given index of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentEndPointY(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int curveSegmentIndex, const double &y)
Sets the value of the “y” attribute of the end point of 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.
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.
n – an unsigned int representing the index of the curve segment to retrieve.
y – a double value to use as the value of the “y” attribute of the end point of curve segment with the given index of the GraphicalObject with the given index associated with the model entity with the given id of the Layout object.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegmentBasePoint1X(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 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 the GraphicalObject with the given index associated with the model entity with the given id of the first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
- Returns:
the “x” attribute of the base point 1 of the curve segment with the given index of the curve of this GraphicalObject object, or
0.0if the object isNULLor does not have a curve
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegmentBasePoint1X(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 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 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.
n – an unsigned int representing the index of the curve segment to retrieve.
- Returns:
the “x” attribute of the base point 1 of the curve segment with the given index of the curve of this GraphicalObject object, or
0.0if the object isNULLor does not have a curve
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentBasePoint1X(SBMLDocument *document, const std::string &id, unsigned int curveSegmentIndex, const double &x)
Sets the value of the “x” attribute of the base point 1 of curve segment with the given index of the curve of the of the first GraphicalObject associated with the model entity with the given id of the first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 1 of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentBasePoint1X(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int curveSegmentIndex, const double &x)
Sets the value of the “x” attribute of the base point 1 of curve segment with the given index of the curve of the of the first GraphicalObject 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.
n – an unsigned int representing the index of the curve segment to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 1 of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentBasePoint1X(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, unsigned int curveSegmentIndex, const double &x)
Sets the value of the “x” attribute of the base point 1 of curve segment with the given index of the curve of the of the GraphicalObject with the given index associated with the model entity with the given id of the first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 1 of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentBasePoint1X(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int curveSegmentIndex, const double &x)
Sets the value of the “x” attribute of the base point 1 of curve segment with the given index of the curve of the 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.
n – an unsigned int representing the index of the curve segment to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 1 of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegmentBasePoint1Y(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 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 first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
- Returns:
the “y” attribute of the base point 1 of the curve segment with the given index of the curve of this GraphicalObject object, or
0.0if the object isNULLor does not have a curve
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegmentBasePoint1Y(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 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.
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.
n – an unsigned int representing the index of the curve segment to retrieve.
- Returns:
the “y” attribute of the base point 1 of the curve segment with the given index of the curve of this GraphicalObject object, or
0.0if the object isNULLor does not have a curve
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentBasePoint1Y(SBMLDocument *document, const std::string &id, unsigned int curveSegmentIndex, const double &y)
Sets the value of the “y” attribute of the base point 1 of curve segment with the given index of the curve of the first GraphicalObject associated with the model entity with the given id of the first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 1 of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentBasePoint1Y(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int curveSegmentIndex, const double &y)
Sets the value of the “y” attribute of the base point 1 of curve segment with the given index of the curve of the first GraphicalObject 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.
n – an unsigned int representing the index of the curve segment to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 1 of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentBasePoint1Y(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, unsigned int curveSegmentIndex, const double &y)
Sets the value of the “y” attribute of the base point 1 of 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 first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 1 of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentBasePoint1Y(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int curveSegmentIndex, const double &y)
Sets the value of the “y” attribute of the base point 1 of 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.
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.
n – an unsigned int representing the index of the curve segment to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 1 of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegmentBasePoint2X(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 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 first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
- Returns:
the “x” attribute of the base point 2 of the curve segment with the given index of the curve of this GraphicalObject object, or
0.0if the object isNULLor does not have a curve
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegmentBasePoint2X(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 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.
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.
n – an unsigned int representing the index of the curve segment to retrieve.
- Returns:
the “x” attribute of the base point 2 of the curve segment with the given index of the curve of this GraphicalObject object, or
0.0if the object isNULLor does not have a curve
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentBasePoint2X(SBMLDocument *document, const std::string &id, unsigned int curveSegmentIndex, const double &x)
Sets the value of the “x” attribute of the base point 2 of curve segment with the given index of the curve of the first GraphicalObject associated with the model entity with the given id of the first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 2 of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentBasePoint2X(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int curveSegmentIndex, const double &x)
Sets the value of the “x” attribute of the base point 2 of curve segment with the given index of the curve of the first GraphicalObject 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.
n – an unsigned int representing the index of the curve segment to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 2 of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentBasePoint2X(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, unsigned int curveSegmentIndex, const double &x)
Sets the value of the “x” attribute of the base point 2 of 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 first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 2 of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentBasePoint2X(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int curveSegmentIndex, const double &x)
Sets the value of the “x” attribute of the base point 2 of 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.
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.
n – an unsigned int representing the index of the curve segment to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 2 of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegmentBasePoint2Y(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 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 first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
- Returns:
the “y” attribute of the base point 2 of the curve segment with the given index of the curve of this GraphicalObject object, or
0.0if the object isNULLor does not have a curve.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCurveSegmentBasePoint2Y(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex = 0, unsigned int curveSegmentIndex = 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.
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.
n – an unsigned int representing the index of the curve segment to retrieve.
- Returns:
the “y” attribute of the base point 2 of the curve segment with the given index of the curve of this GraphicalObject object, or
0.0if the object isNULLor does not have a curve.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentBasePoint2Y(SBMLDocument *document, const std::string &id, unsigned int curveSegmentIndex, const double &y)
Sets the value of the “y” attribute of the base point 2 of curve segment with the given index of the curve of the first GraphicalObject associated with the model entity with the given id of the first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 2 of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentBasePoint2Y(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int curveSegmentIndex, const double &y)
Sets the value of the “y” attribute of the base point 2 of curve segment with the given index of the curve of the first GraphicalObject 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.
n – an unsigned int representing the index of the curve segment to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 2 of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentBasePoint2Y(SBMLDocument *document, const std::string &id, unsigned int graphicalObjectIndex, unsigned int curveSegmentIndex, const double &y)
Sets the value of the “y” attribute of the base point 2 of 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 first Layout object 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.
n – an unsigned int representing the index of the curve segment to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 2 of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCurveSegmentBasePoint2Y(SBMLDocument *document, unsigned int layoutIndex, const std::string &id, unsigned int graphicalObjectIndex, unsigned int curveSegmentIndex, const double &y)
Sets the value of the “y” attribute of the base point 2 of 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.
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.
n – an unsigned int representing the index of the curve segment to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 2 of curve segment with the given index of the curve of this GraphicalObject object.
- Returns:
integer value indicating success/failure of the function.
Render Functions
-
ListOfGlobalRenderInformation *LIBSBMLNETWORK_CPP_NAMESPACE::getListOfGlobalRenderInformation(SBMLDocument *document)
Get the List of global render Information of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
a pointer to the ListOfRenderInformationBase object of the SBML document.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumGlobalRenderInformation(const 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
0if the object isNULL
-
GlobalRenderInformation *LIBSBMLNETWORK_CPP_NAMESPACE::getGlobalRenderInformation(SBMLDocument *document, unsigned int renderIndex = 0)
Returns a pointer to the GlobalRenderInformation with the given index in the ListOfGlobalRenderInformation of the SBML document.
- Parameters:
renderIndex – the index number of the GlobalRenderInformation to return.
- Returns:
the
theGlobalRenderInformation with the given index in the ListOfGlobalRenderInformation of the SBML document or NULL if no such GlobalRenderInformation exists or the document isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addGlobalRenderInformation(SBMLDocument *document, GlobalRenderInformation *globalRenderInformation)
Add GlobalRenderInformation to list of global renders of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
globalRenderInformation – a pointer to the GlobalRenderInformation object.
- Returns:
integer value indicating success/failure of the function.
-
GlobalRenderInformation *LIBSBMLNETWORK_CPP_NAMESPACE::createGlobalRenderInformation(SBMLDocument *document)
Create a GlobalRenderInformation object and add it to list of global renders of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
a pointer to the created GlobalRenderInformation object.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeAllGlobalRenderInformation(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::setDefaultGlobalRenderInformationFeatures(SBMLDocument *document, GlobalRenderInformation *globalRenderInformation)
Set all the necessary features for the global render information object.
- Parameters:
document – a pointer to the SBMLDocument object.
globalRenderInformation – a pointer to the GlobalRenderInformation object.
- Returns:
integer value indicating success/failure of the function.
-
ListOfLocalRenderInformation *LIBSBMLNETWORK_CPP_NAMESPACE::getListOfLocalRenderInformation(SBMLDocument *document, unsigned int layoutIndex = 0)
Get the List of local render Information 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:
a pointer to the ListOfGlobalInformationBase object of this Layout object.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumLocalRenderInformation(SBMLDocument *document, unsigned 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
0if the object isNULL
-
LocalRenderInformation *LIBSBMLNETWORK_CPP_NAMESPACE::getLocalRenderInformation(SBMLDocument *document, unsigned int layoutIndex = 0, unsigned int renderIndex = 0)
Returns a pointer to the LocalRenderInformation object with the given index in the ListOfLocalRenderInformation 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.
renderIndex – the index number of the GlobalRenderInformation to return.
- Returns:
the
theLocalRenderInformation with the given index in the ListOfLocalRenderInformation of this Layout object or NULL if no such LocalRenderInformation exists or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addLocalRenderInformation(SBMLDocument *document, LocalRenderInformation *localRenderInformation)
Add LocalRenderInformation to the list of local renders of the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
localRenderInformation – a pointer to the LocalRenderInformation object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addLocalRenderInformation(SBMLDocument *document, unsigned int layoutIndex, LocalRenderInformation *localRenderInformation)
Add LocalRenderInformation to 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.
localRenderInformation – a pointer to the LocalRenderInformation object.
- Returns:
integer value indicating success/failure of the function.
-
LocalRenderInformation *LIBSBMLNETWORK_CPP_NAMESPACE::createLocalRenderInformation(SBMLDocument *document, unsigned int layoutIndex = 0)
Create a LocalRenderInformation object and add it to 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:
a pointer to the created LocalRenderInformation object.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeAllLocalRenderInformation(SBMLDocument *document, unsigned 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::setDefaultLocalRenderInformationFeatures(SBMLDocument *document, LocalRenderInformation *localRenderInformation)
Set all the necessary features for the local render information object in the first Layout object of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
localRenderInformation – a pointer to the LocalRenderInformation object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setDefaultLocalRenderInformationFeatures(SBMLDocument *document, unsigned int layoutIndex, LocalRenderInformation *localRenderInformation)
Set all the necessary features for the local render information object in 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.
localRenderInformation – a pointer to the LocalRenderInformation object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::createDefaultRenderInformation(SBMLDocument *document)
Create a GlobalRenderInformation object and add it to list of global renders of the SBML document, and 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 them.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::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::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.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeRenderInformation(SBMLDocument *document)
Remove all the render information objects from the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetBackgroundColor(SBMLDocument *document, unsigned int renderIndex = 0)
Predicates returning
trueif 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:
trueif the “backgroundColor” attribute of this GlobalRenderInformation object is set,falseif either the “backgroundColor” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getBackgroundColor(SBMLDocument *document, unsigned 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 isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setBackgroundColor(SBMLDocument *document, const std::string &backgroundColor)
Sets the value of the “backgroundColor” attribute of the first GlobalRenderInformation object.
- 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.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setBackgroundColor(SBMLDocument *document, unsigned int renderIndex, const std::string &backgroundColor)
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.
renderIndex – the index number of the GlobalRenderInformation object.
backgroundColor – a string value to use as the value of the “backgroundColor” attribute of this RenderInformationBase object.
- Returns:
integer value indicating success/failure of the function.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumGlobalColorDefinitions(SBMLDocument *document, unsigned int renderIndex = 0)
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
0if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getGlobalColorDefinitionId(SBMLDocument *document, unsigned int renderIndex = 0, unsigned int colorIndex = 0)
Returns the id of the ColorDefinition object with the given index 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.
colorIndex – the of the ColorDefinition.
- Returns:
the id of the ColorDefinition object with the given index in the ListOfColorDefinitions within this GlobalRenderInformation, or
""if the object isNULL
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumLocalColorDefinitions(SBMLDocument *document, unsigned int renderIndex = 0)
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
0if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLocalColorDefinitionId(SBMLDocument *document, unsigned int renderIndex = 0, unsigned int colorIndex = 0)
Returns the id of the ColorDefinition object with the given index 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.
colorIndex – the of the ColorDefinition.
- Returns:
the id of the ColorDefinition object with the given index in the ListOfColorDefinitions within this LocalRenderInformation, or
""if the object isNULL
-
ColorDefinition *LIBSBMLNETWORK_CPP_NAMESPACE::getColorDefinition(SBMLDocument *document, const std::string &sid)
Returns a ColorDefinition from all RenderInformationBase objects of the SBML document based on its identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the ColorDefinition to retrieve.
- Returns:
the
ColorDefinitionin the ListOfColorDefinitions within this RenderInformationBase with the given sid orNULLif no such ColorDefinition exists.
-
ColorDefinition *LIBSBMLNETWORK_CPP_NAMESPACE::getColorDefinition(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns a ColorDefinition from the RenderInformationBase object with the given index of the SBML document based on its identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the ColorDefinition to retrieve.
- Returns:
the
ColorDefinitionin the ListOfColorDefinitions within this RenderInformationBase with the given sid orNULLif no such ColorDefinition exists.
-
ColorDefinition *LIBSBMLNETWORK_CPP_NAMESPACE::getColorDefinition(SBMLDocument *document, unsigned int renderIndex = 0, unsigned int colorIndex = 0)
Returns a pointer to the ColorDefinition with the given index 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.
colorIndex – the index value of the ColorDefinition to return.
- Returns:
the
ColorDefinitionwith the given index, or NULL if ColorDefinition does not exist or the object isNULL
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetValue(SBMLDocument *document, const std::string &sid)
Predicates returning
trueif the “value” attribute of the ColorDefinition with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the ColorDefinition to retrieve.
- Returns:
trueif the “value” attribute of this ColorDefinition object is set,falseif either the “value” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetValue(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Predicates returning
trueif 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.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the ColorDefinition to retrieve.
- Returns:
trueif the “value” attribute of this ColorDefinition object is set,falseif either the “value” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getValue(SBMLDocument *document, const std::string &sid)
Returns the value of the “value” attribute of the ColorDefinition with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the ColorDefinition to retrieve.
- Returns:
the “value” attribute of the ColorDefinition object, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getValue(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
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.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the ColorDefinition to retrieve.
- Returns:
the “value” attribute of the ColorDefinition object, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setValue(SBMLDocument *document, const std::string &sid, const std::string &value)
Sets the value of the “value” attribute of the ColorDefinition with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – 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.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setValue(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const std::string &value)
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.
renderIndex – the index number of the RenderInformationBase object.
sid – 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.
- Returns:
integer value indicating success/failure of the function.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumGlobalGradientDefinitions(SBMLDocument *document, unsigned 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
0if the object isNULL
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumLocalGradientDefinitions(SBMLDocument *document, unsigned int renderIndex)
@breif 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
0if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getGlobalGradientDefinitionId(SBMLDocument *document, unsigned int renderIndex = 0, unsigned int gradientIndex = 0)
Returns the id of the GradientDefinition object with the given index 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.
gradientIndex – the of the GlobalRenderInformation.
- Returns:
the id of the GradientDefinition object with the given index in the ListOfGradientDefinitions within this GlobalRenderInformation, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLocalGradientDefinitionId(SBMLDocument *document, unsigned int renderIndex, unsigned int gradientIndex)
@breif Returns the id of the GradientDefinition object with the given index 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.
gradientIndex – the of the LocalRenderInformation.
- Returns:
the id of the GradientDefinition object with the given index in the ListOfGradientDefinitions within this LocalRenderInformation, or
""if the object isNULL
-
GradientBase *LIBSBMLNETWORK_CPP_NAMESPACE::getGradientDefinition(SBMLDocument *document, const std::string &sid)
Returns a GradientBase from all the RenderInformationBase objects of the SBML document based on its identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the
GradientBasein the ListOfGradientDefinitions within all RenderInformationBase objects with the given sid orNULLif no such GradientBase exists.
-
GradientBase *LIBSBMLNETWORK_CPP_NAMESPACE::getGradientDefinition(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns a GradientBase from the RenderInformationBase object with the given index of the SBML document based on its identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the
GradientBasein the ListOfGradientDefinitions within this RenderInformationBase with the given sid orNULLif no such GradientBase exists.
-
GradientBase *LIBSBMLNETWORK_CPP_NAMESPACE::getGradientDefinition(SBMLDocument *document, unsigned int renderIndex = 0, unsigned int gradientIndex = 0)
Returns a pointer to the GradientBase with the given index 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.
gradientIndex – the index value of the GradientBase to return.
- Returns:
the
GradientBasewith the given index, or NULL if GradientBase does not exist or the object isNULL
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isLinearGradient(SBMLDocument *document, const std::string &sid)
Predicate returning true if the abstract GradientBase with the given identifier in all RenderInformationBase objects of SBML document is of type LinearGradient.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif this abstract GradientBase is of type LinearGradient, false otherwise
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isLinearGradient(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Predicate returning true if the abstract GradientBase with the given identifier in the RenderInformationBase object with the given index of the SBML document is of type LinearGradient.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif this abstract GradientBase is of type LinearGradient, false otherwise
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isRadialGradient(SBMLDocument *document, const std::string &sid)
Predicate returning true if the abstract GradientBase with the given identifier in all RenderInformationBase objects of SBML document with the given identifier is of type RadialGradient.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif this abstract GradientBase is of type RadialGradient, false otherwise
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isRadialGradient(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Predicate returning true if the abstract GradientBase with the given identifier in the RenderInformationBase object with the given index of SBML document is of type RadialGradient.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif this abstract GradientBase is of type RadialGradient, false otherwise
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpreadMethod(SBMLDocument *document, const std::string &sid)
Predicates returning
trueif the “spreadMethod” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “spreadMethod” attribute of this GradientBase object is set,falseif either the “spreadMethod” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpreadMethod(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Predicates returning
trueif the “spreadMethod” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “spreadMethod” attribute of this GradientBase object is set,falseif either the “spreadMethod” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpreadMethod(SBMLDocument *document, const std::string &sid)
Returns the value of the “spreadMethod” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “spreadMethod” attribute of the GradientBase object, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpreadMethod(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “spreadMethod” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “spreadMethod” attribute of the GradientBase object, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpreadMethod(SBMLDocument *document, const std::string &sid, const std::string &spreadMethod)
Sets the value of the “spreadMethod” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
spreadMethod – a string value to use as the value of the “spreadMethod” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpreadMethod(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const std::string &spreadMethod)
Sets the value of the “spreadMethod” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
spreadMethod – a string value to use as the value of the “spreadMethod” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumGradientStops(SBMLDocument *document, const std::string &sid)
Returns Get the number of GradientStop objects in the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the number of GradientStop objects in this GradientBase, or 0 if the object is
NULL
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumGradientStops(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns Get the number of GradientStop objects in the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the number of GradientStop objects in this GradientBase, or 0 if the object is
NULL
-
GradientStop *LIBSBMLNETWORK_CPP_NAMESPACE::getGradientStop(SBMLDocument *document, const std::string &sid, unsigned int gradientStopIndex = 0)
Returns the GradientStop object with the given index of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
gradientStopIndex – an unsigned int representing the index of the GradientStop to retrieve.
- Returns:
the GradientStop at the given index of the GradientBase object, or NULL if the object is
NULL
-
GradientStop *LIBSBMLNETWORK_CPP_NAMESPACE::getGradientStop(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, unsigned int gradientStopIndex = 0)
Returns the GradientStop object with the given index of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
gradientStopIndex – an unsigned int representing the index of the GradientStop to retrieve.
- Returns:
the GradientStop at the given index of the GradientBase object, or NULL if the object is
NULL
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetOffset(SBMLDocument *document, const std::string &sid, unsigned int gradientStopIndex = 0)
Predicates returning
trueif the “offset” attribute of the GradientStop with the given index of this the GradientBase in all RenderInformationBase objects of SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.
- Returns:
trueif the “offset” attribute of the GradientStop with the given index of this GradientBase object is set,falseif either the “offset” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetOffset(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, unsigned int gradientStopIndex = 0)
Predicates returning
trueif the “offset” attribute of the GradientStop with the given index of this the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.
- Returns:
trueif the “offset” attribute of the GradientStop with the given index of this GradientBase object is set,falseif either the “offset” attribute is not set or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getOffset(SBMLDocument *document, const std::string &sid, unsigned int gradientStopIndex = 0)
Returns the value of the “offset” attribute of the GradientStop with the given index of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.
- Returns:
the “offset” attribute of the GradientStop with the given index of the GradientBase object, or
RelAbsVector()if the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getOffset(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, unsigned int gradientStopIndex = 0)
Returns the value of the “offset” attribute of the GradientStop with the given index of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.
- Returns:
the “offset” attribute of the GradientStop with the given index of the GradientBase object, or
RelAbsVector()if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getOffsetAsDouble(SBMLDocument *document, const std::string &sid, unsigned int gradientStopIndex = 0)
Returns the value of the “offset” attribute of the GradientStop with the given index of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.
- Returns:
the “offset” attribute of the GradientStop with the given index of the GradientBase object as a double, or
0if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getOffsetAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, unsigned int gradientStopIndex = 0)
Returns the value of the “offset” attribute of the GradientStop with the given index of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.
- Returns:
the “offset” attribute of the GradientStop with the given index of the GradientBase object as a double, or
0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setOffset(SBMLDocument *document, const std::string &sid, const RelAbsVector &offset)
Sets the value of the “offset” attribute of the first GradientStop of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
offset – a RelAbsVector to use as the value of the “offset” attribute of the first GradientStop of this GradientStop object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setOffset(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const RelAbsVector &offset)
Sets the value of the “offset” attribute of the first GradientStop of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
offset – a RelAbsVector to use as the value of the “offset” attribute of the first GradientStop of this GradientStop object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setOffset(SBMLDocument *document, const std::string &sid, unsigned int gradientStopIndex, const RelAbsVector &offset)
Sets the value of the “offset” attribute of the GradientStop with the given index of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.
offset – a RelAbsVector to use as the value of the “offset” attribute of the GradientStop with the given index of this GradientStop object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setOffset(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, unsigned int gradientStopIndex, const RelAbsVector &offset)
Sets the value of the “offset” attribute of the GradientStop with the given index of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.
offset – a RelAbsVector to use as the value of the “offset” attribute of the GradientStop with the given index of this GradientStop object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setOffsetAsDouble(SBMLDocument *document, const std::string &sid, const double &offset)
Sets the value of the “offset” attribute of the GradientStop with the given index of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
offset – a double to use as the value of the “offset” attribute of the GradientStop with the given index of this GradientStop object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setOffsetAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const double &offset)
Sets the value of the “offset” attribute of the GradientStop with the given index of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
offset – a double to use as the value of the “offset” attribute of the GradientStop with the given index of this GradientStop object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setOffsetAsDouble(SBMLDocument *document, const std::string &sid, unsigned int gradientStopIndex, const double &offset)
Sets the value of the “offset” attribute of the GradientStop with the given index of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.
offset – a double to use as the value of the “offset” attribute of the GradientStop with the given index of this GradientStop object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setOffsetAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, unsigned int gradientStopIndex, const double &offset)
Sets the value of the “offset” attribute of the GradientStop with the given index of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.
offset – a double to use as the value of the “offset” attribute of the GradientStop with the given index of this GradientStop object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetStopColor(SBMLDocument *document, const std::string &sid, unsigned int gradientStopIndex = 0)
Predicates returning
trueif the “stop-color” attribute of the GradientStop with the given index of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “stop-color” attribute of GradientStop with the given index of this GradientBase object is set,falseif either the “stop-color” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetStopColor(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, unsigned int gradientStopIndex = 0)
Predicates returning
trueif the “stop-color” attribute of the GradientStop with the given index of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “stop-color” attribute of GradientStop with the given index of this GradientBase object is set,falseif either the “stop-color” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getStopColor(SBMLDocument *document, const std::string &sid, unsigned int gradientStopIndex = 0)
Returns the value of the “stop-color” attribute of the GradientStop with the given index of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.
- Returns:
the “stop-color” attribute of the GradientStop with the given index of this GradientStop object, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getStopColor(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, unsigned int gradientStopIndex = 0)
Returns the value of the “stop-color” attribute of the GradientStop with the given index of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.
- Returns:
the “stop-color” attribute of the GradientStop with the given index of this GradientStop object, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setStopColor(SBMLDocument *document, const std::string &sid, const std::string &stopColor)
Sets the value of the “stop-color” attribute of the first GradientStop of this the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
stopColor – a string value to use as the value of the “stop-color” attribute of the first GradientStop of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setStopColor(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const std::string &stopColor)
Sets the value of the “stop-color” attribute of the first GradientStop of this the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
stopColor – a string value to use as the value of the “stop-color” attribute of the first GradientStop of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setStopColor(SBMLDocument *document, const std::string &sid, unsigned int gradientStopIndex, const std::string &stopColor)
Sets the value of the “stop-color” attribute of the GradientStop with the given index of this the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.
stopColor – a string value to use as the value of the “stop-color” attribute of the GradientStop with the given index of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setStopColor(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, unsigned int gradientStopIndex, const std::string &stopColor)
Sets the value of the “stop-color” attribute of the GradientStop with the given index of this the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
gradientStopIndex – an unsigned int representing the index of the GradientStop of this GradientBase object.
stopColor – a string value to use as the value of the “stop-color” attribute of the GradientStop with the given index of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLinearGradientX1(SBMLDocument *document, const std::string &sid)
Predicates returning
trueif the “x1” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “x1” attribute of this GradientBase object is set,falseif either the “x1” attribute is not set , the object isNULL, or not of type LinearGradient.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLinearGradientX1(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Predicates returning
trueif the “x1” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “x1” attribute of this GradientBase object is set,falseif either the “x1” attribute is not set , the object isNULL, or not of type LinearGradient.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLinearGradientX1(SBMLDocument *document, const std::string &sid)
Returns the value of the “x1” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “x1” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type LinearGradient.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLinearGradientX1(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “x1” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “x1” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type LinearGradient.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLinearGradientX1(SBMLDocument *document, const std::string &sid, const RelAbsVector &x1)
Sets the value of the “x1” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
x1 – a RelAbsVector to use as the value of the “x1” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLinearGradientX1(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const RelAbsVector &x1)
Sets the value of the “x1” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
x1 – a RelAbsVector to use as the value of the “x1” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLinearGradientX1AsDouble(SBMLDocument *document, const std::string &sid, const double &x1)
Sets the value of the “x1” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
x1 – a double to use as the value of the “x1” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLinearGradientX1AsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const double &x1)
Sets the value of the “x1” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
x1 – a double to use as the value of the “x1” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLinearGradientX2(SBMLDocument *document, const std::string &sid)
Predicates returning
trueif the “x2” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “x2” attribute of this GradientBase object is set,falseif either the “x2” attribute is not set , the object isNULL, or not of type LinearGradient.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLinearGradientX2(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Predicates returning
trueif the “x2” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “x2” attribute of this GradientBase object is set,falseif either the “x2” attribute is not set , the object isNULL, or not of type LinearGradient.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLinearGradientX2(SBMLDocument *document, const std::string &sid)
Returns the value of the “x2” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “x2” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type LinearGradient.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLinearGradientX2(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “x2” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “x2” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type LinearGradient.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLinearGradientX2AsDouble(SBMLDocument *document, const std::string &sid)
Returns the value of the “x2” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “x2” attribute of the GradientBase object as a double, or
0if the object isNULLor not of type LinearGradient.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLinearGradientX2AsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “x2” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “x2” attribute of the GradientBase object as a double, or
0if the object isNULLor not of type LinearGradient.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLinearGradientX2(SBMLDocument *document, const std::string &sid, const RelAbsVector &x2)
Sets the value of the “x2” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
x2 – a RelAbsVector to use as the value of the “x2” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLinearGradientX2(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const RelAbsVector &x2)
Sets the value of the “x2” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
x2 – a RelAbsVector to use as the value of the “x2” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLinearGradientX2AsDouble(SBMLDocument *document, const std::string &sid, const double &x2)
Sets the value of the “x2” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
x2 – a double to use as the value of the “x2” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLinearGradientX2AsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const double &x2)
Sets the value of the “x2” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
x2 – a double to use as the value of the “x2” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLinearGradientY1(SBMLDocument *document, const std::string &sid)
Predicates returning
trueif the “y1” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “y1” attribute of this GradientBase object is set,falseif either the “y1” attribute is not set , the object isNULL, or not of type LinearGradient.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLinearGradientY1(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Predicates returning
trueif the “y1” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “y1” attribute of this GradientBase object is set,falseif either the “y1” attribute is not set , the object isNULL, or not of type LinearGradient.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLinearGradientY1(SBMLDocument *document, const std::string &sid)
Returns the value of the “y1” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “y1” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type LinearGradient.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLinearGradientY1(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “y1” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “y1” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type LinearGradient.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLinearGradientY1AsDouble(SBMLDocument *document, const std::string &sid)
Returns the value of the “y1” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “y1” attribute of the GradientBase object as a double, or
0if the object isNULLor not of type LinearGradient.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLinearGradientY1AsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “y1” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “y1” attribute of the GradientBase object as a double, or
0if the object isNULLor not of type LinearGradient.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLinearGradientY1(SBMLDocument *document, const std::string &sid, const RelAbsVector &y1)
Sets the value of the “y1” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
y1 – a RelAbsVector to use as the value of the “y1” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLinearGradientY1(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const RelAbsVector &y1)
Sets the value of the “y1” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
y1 – a RelAbsVector to use as the value of the “y1” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLinearGradientY1AsDouble(SBMLDocument *document, const std::string &sid, const double &y1)
Sets the value of the “y1” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
y1 – a double to use as the value of the “y1” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLinearGradientY1AsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const double &y1)
Sets the value of the “y1” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
y1 – a double to use as the value of the “y1” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLinearGradientY2(SBMLDocument *document, const std::string &sid)
Predicates returning
trueif the “y2” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “y2” attribute of this GradientBase object is set,falseif either the “y2” attribute is not set , the object isNULL, or not of type LinearGradient.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLinearGradientY2(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Predicates returning
trueif the “y2” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “y2” attribute of this GradientBase object is set,falseif either the “y2” attribute is not set , the object isNULL, or not of type LinearGradient.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLinearGradientY2(SBMLDocument *document, const std::string &sid)
Returns the value of the “y2” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “y2” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type LinearGradient.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLinearGradientY2(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “y2” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “y2” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type LinearGradient.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLinearGradientY2AsDouble(SBMLDocument *document, const std::string &sid)
Returns the value of the “y2” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “y2” attribute of the GradientBase object as a double, or
0if the object isNULLor not of type LinearGradient.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLinearGradientY2AsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “y2” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “y2” attribute of the GradientBase object as a double, or
0if the object isNULLor not of type LinearGradient.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLinearGradientY2(SBMLDocument *document, const std::string &sid, const RelAbsVector &y2)
Sets the value of the “y2” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
y2 – a RelAbsVector to use as the value of the “y2” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLinearGradientY2(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const RelAbsVector &y2)
Sets the value of the “y2” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
y2 – a RelAbsVector to use as the value of the “y2” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLinearGradientY2AsDouble(SBMLDocument *document, const std::string &sid, const double &y2)
Sets the value of the “y2” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
y2 – a double to use as the value of the “y2” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLinearGradientY2AsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const double &y2)
Sets the value of the “y2” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
y2 – a double to use as the value of the “y2” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetRadialGradientCx(SBMLDocument *document, const std::string &sid)
Predicates returning
trueif the “cx” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “cx” attribute of this GradientBase object is set,falseif either the “cx” attribute is not set , the object isNULL, or not of type RadialGradient.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetRadialGradientCx(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Predicates returning
trueif the “cx” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “cx” attribute of this GradientBase object is set,falseif either the “cx” attribute is not set , the object isNULL, or not of type RadialGradient.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientCx(SBMLDocument *document, const std::string &sid)
Returns the value of the “cx” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “cx” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type RadialGradient.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientCx(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “cx” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “cx” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type RadialGradient.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientCxAsDouble(SBMLDocument *document, const std::string &sid)
Returns the value of the “cx” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “cx” attribute of the GradientBase object as a double, or
0if the object isNULLor not of type RadialGradient.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientCxAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “cx” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “cx” attribute of the GradientBase object as a double, or
0if the object isNULLor not of type RadialGradient.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientCx(SBMLDocument *document, const std::string &sid, const RelAbsVector &cx)
Sets the value of the “cx” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
cx – a RelAbsVector to use as the value of the “cx” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientCx(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const RelAbsVector &cx)
Sets the value of the “cx” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
cx – a RelAbsVector to use as the value of the “cx” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientCxAsDouble(SBMLDocument *document, const std::string &sid, const double &cx)
Sets the value of the “cx” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
cx – a double to use as the value of the “cx” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientCxAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const double &cx)
Sets the value of the “cx” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
cx – a double to use as the value of the “cx” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetRadialGradientCy(SBMLDocument *document, const std::string &sid)
Predicates returning
trueif the “cy” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “cy” attribute of this GradientBase object is set,falseif either the “cy” attribute is not set , the object isNULL, or not of type RadialGradient.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetRadialGradientCy(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Predicates returning
trueif the “cy” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “cy” attribute of this GradientBase object is set,falseif either the “cy” attribute is not set , the object isNULL, or not of type RadialGradient.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientCy(SBMLDocument *document, const std::string &sid)
Returns the value of the “cy” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “cy” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type RadialGradient.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientCy(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “cy” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “cy” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type RadialGradient.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientCyAsDouble(SBMLDocument *document, const std::string &sid)
Returns the value of the “cy” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “cy” attribute of the GradientBase object as a double, or
0if the object isNULLor not of type RadialGradient.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientCyAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “cy” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “cy” attribute of the GradientBase object as a double, or
0if the object isNULLor not of type RadialGradient.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientCy(SBMLDocument *document, const std::string &sid, const RelAbsVector &cy)
Sets the value of the “cy” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
cy – a RelAbsVector to use as the value of the “cy” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientCy(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const RelAbsVector &cy)
Sets the value of the “cy” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
cy – a RelAbsVector to use as the value of the “cy” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientCyAsDouble(SBMLDocument *document, const std::string &sid, const double &cy)
Sets the value of the “cy” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
cy – a double to use as the value of the “cy” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientCyAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const double &cy)
Sets the value of the “cy” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
cy – a double to use as the value of the “cy” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetRadialGradientFx(SBMLDocument *document, const std::string &sid)
Predicates returning
trueif the “fx” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “fx” attribute of this GradientBase object is set,falseif either the “fx” attribute is not set , the object isNULL, or not of type RadialGradient.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetRadialGradientFx(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Predicates returning
trueif the “fx” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “fx” attribute of this GradientBase object is set,falseif either the “fx” attribute is not set , the object isNULL, or not of type RadialGradient.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientFx(SBMLDocument *document, const std::string &sid)
Returns the value of the “fx” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “fx” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type RadialGradient.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientFx(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “fx” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “fx” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type RadialGradient.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientFxAsDouble(SBMLDocument *document, const std::string &sid)
Returns the value of the “fx” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “fx” attribute of the GradientBase object as a double, or
0if the object isNULLor not of type RadialGradient.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientFxAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “fx” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “fx” attribute of the GradientBase object as a double, or
0if the object isNULLor not of type RadialGradient.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientFx(SBMLDocument *document, const std::string &sid, const RelAbsVector &fx)
Sets the value of the “fx” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
fx – a RelAbsVector to use as the value of the “fx” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientFx(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const RelAbsVector &fx)
Sets the value of the “fx” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
fx – a RelAbsVector to use as the value of the “fx” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientFxAsDouble(SBMLDocument *document, const std::string &sid, const double &fx)
Sets the value of the “fx” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
fx – a double to use as the value of the “fx” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientFxAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const double &fx)
Sets the value of the “fx” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
fx – a double to use as the value of the “fx” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetRadialGradientFy(SBMLDocument *document, const std::string &sid)
Predicates returning
trueif the “fy” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “fy” attribute of this GradientBase object is set,falseif either the “fy” attribute is not set , the object isNULL, or not of type RadialGradient.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetRadialGradientFy(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Predicates returning
trueif the “fy” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “fy” attribute of this GradientBase object is set,falseif either the “fy” attribute is not set , the object isNULL, or not of type RadialGradient.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientFy(SBMLDocument *document, const std::string &sid)
Returns the value of the “fy” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “fy” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type RadialGradient.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientFy(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “fy” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “fy” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type RadialGradient.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientFyAsDouble(SBMLDocument *document, const std::string &sid)
Returns the value of the “fy” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “fy” attribute of the GradientBase object as a double, or
0if the object isNULLor not of type RadialGradient.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientFyAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “fy” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “fy” attribute of the GradientBase object as a double, or
0if the object isNULLor not of type RadialGradient.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientFy(SBMLDocument *document, const std::string &sid, const RelAbsVector &fy)
Sets the value of the “fy” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
fy – a RelAbsVector to use as the value of the “fy” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientFy(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const RelAbsVector &fy)
Sets the value of the “fy” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
fy – a RelAbsVector to use as the value of the “fy” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientFyAsDouble(SBMLDocument *document, const std::string &sid, const double &fy)
Sets the value of the “fy” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
fy – a double to use as the value of the “fy” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientFyAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const double &fy)
Sets the value of the “fy” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
fy – a double to use as the value of the “fy” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetRadialGradientR(SBMLDocument *document, const std::string &sid)
Predicates returning
trueif the “r” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “r” attribute of this GradientBase object is set,falseif either the “r” attribute is not set
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetRadialGradientR(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Predicates returning
trueif the “r” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier is set.- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
trueif the “r” attribute of this GradientBase object is set,falseif either the “r” attribute is not set
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientR(SBMLDocument *document, const std::string &sid)
Returns the value of the “r” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “r” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type RadialGradient.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientR(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “r” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “r” attribute of the GradientBase object, or
RelAbsVector()if the object isNULLor not of type RadialGradient.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientRAsDouble(SBMLDocument *document, const std::string &sid)
Returns the value of the “r” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “r” attribute of the GradientBase object as a double, or
0if the object isNULLor not of type RadialGradient.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getRadialGradientRAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “r” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
- Returns:
the “r” attribute of the GradientBase object as a double, or
0if the object isNULLor not of type RadialGradient.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientR(SBMLDocument *document, const std::string &sid, const RelAbsVector &r)
Sets the value of the “r” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
r – a RelAbsVector to use as the value of the “r” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientR(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const RelAbsVector &r)
Sets the value of the “r” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
r – a RelAbsVector to use as the value of the “r” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientRAsDouble(SBMLDocument *document, const std::string &sid, const double &r)
Sets the value of the “r” attribute of the GradientBase in all RenderInformationBase objects of SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the GradientBase to retrieve.
r – a double to use as the value of the “r” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setRadialGradientRAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, const double &r)
Sets the value of the “r” attribute of the GradientBase in the RenderInformationBase with the given index of the SBML document with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the GradientBase to retrieve.
r – a double to use as the value of the “r” attribute of this GradientBase object.
- Returns:
integer value indicating success/failure of the function.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumGlobalLineEndings(SBMLDocument *document, unsigned int renderIndex = 0)
Returns the number of LineEndings 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 LineEndings of this GlobalRenderInformation object, or
0if the object isNULL
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumLocalLineEndings(SBMLDocument *document, unsigned int renderIndex = 0)
Returns the number of LineEndings 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 LineEndings of this LocalRenderInformation object, or
0if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getGlobalLineEndingId(SBMLDocument *document, unsigned int renderIndex = 0, unsigned int lineEndingIndex = 0)
Returns the id of the LineEnding with the given index 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.
lineEndingIndex – the index number of the LineEnding to return.
- Returns:
the id of the LineEnding with the given index of this GlobalRenderInformation object, or
NULLif the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLocalLineEndingId(SBMLDocument *document, unsigned int renderIndex = 0, unsigned int lineEndingIndex = 0)
Returns the id of the LineEnding with the given index 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.
lineEndingIndex – the index number of the LineEnding to return.
- Returns:
the id of the LineEnding with the given index of this LocalRenderInformation object, or
NULLif the object isNULL
-
LineEnding *LIBSBMLNETWORK_CPP_NAMESPACE::getLineEnding(SBMLDocument *document, const std::string &sid)
Returns a LineEnding from all the RenderInformationBase objects of the SBML document based on its identifier.
- Parameters:
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the
LineEndingin the ListOfLineEndings within this RenderInformationBase with the given sid orNULLif no such LineEnding exists.
-
LineEnding *LIBSBMLNETWORK_CPP_NAMESPACE::getLineEnding(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns a LineEnding from the RenderInformationBase object with the given index of the SBML document based on its identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the
LineEndingin the ListOfLineEndings within this RenderInformationBase with the given sid orNULLif no such LineEnding exists.
-
LineEnding *LIBSBMLNETWORK_CPP_NAMESPACE::getLineEnding(SBMLDocument *document, unsigned int renderIndex = 0, unsigned int lineEndingIndex = 0)
Returns a pointer to the LineEnding with the given index of the RenderInformationBase object with given index of the SBML document the given index.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
lineEndingIndex – the index value of the LineEnding to return.
- Returns:
the
LineEndingwithf the given index, or NULL if LineEnding does not exist or the object isNULL
-
LineEnding *LIBSBMLNETWORK_CPP_NAMESPACE::createLocalLineEnding(SBMLDocument *document, LineEnding *globalLineEnding, SpeciesReferenceGlyph *speciesReferenceGlyph)
Clone the LineEnding with the given identifier from the RenderInformationBase object with the given index of the SBML document to create a new LineEnding that can be used locally by a SpeciesReferenceGlyph.
- Parameters:
document – a pointer to the SBMLDocument object.
globalLineEnding – the LineEnding to be cloned.
speciesReferenceGlyph – the SpeciesReferenceGlyph that will use the new LineEnding.
- Returns:
the new LineEnding object, or
NULLif the object isNULL
-
LineEnding *LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEnding(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the LineEnding associated with the SpeciesReferenceGlyph with the given index, or
NULLif the object isNULL
-
LineEnding *LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLocalLineEnding(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the local LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document. Creates a new LineEnding from the global LineEnding if the local LineEnding does not exist.
- Parameters:
document – a pointer to the SBMLDocument object. @reactionId a string representing the identifier of the Reaction object. @reactionGlyphIndex the index number of the ReactionGlyph object. @speciesReferenceIndex the index number of the SpeciesReference object.
- Returns:
the LineEnding associated with the SpeciesReferenceGlyph with the given index, or
NULLif the object isNULL
-
LineEnding *LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLocalLineEnding(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the local LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document. Creates a new LineEnding from the global LineEnding if the local LineEnding does not exist.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object. @reactionId a string representing the identifier of the Reaction object. @reactionGlyphIndex the index number of the ReactionGlyph object. @speciesReferenceIndex the index number of the SpeciesReference object.
- Returns:
the LineEnding associated with the SpeciesReferenceGlyph with the given index, or
NULLif the object isNULL
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetEnableRotationalMapping(SBMLDocument *document, const std::string &sid)
Predicates returning
trueif the “enableRotationalMapping” attribute of the LineEnding with the given identifier of the first RenderInformationBase object of the SBML document is set.- Parameters:
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
trueif the “enableRotationalMapping” attribute of this LineEnding object is set,falseif either the “enableRotationalMapping” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetEnableRotationalMapping(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Predicates returning
trueif the “enableRotationalMapping” attribute of the LineEnding with the given identifier of the RenderInformationBase 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 RenderInformationBase object.
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
trueif the “enableRotationalMapping” attribute of this LineEnding object is set,falseif either the “enableRotationalMapping” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::getEnableRotationalMapping(SBMLDocument *document, const std::string &sid)
Returns the value of the “enableRotationalMapping” attribute of the LineEnding with the given identifier of the RenderInformationBase object with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the “enableRotationalMapping” attribute of the LineEnding object, or
falseif the object isNULL
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::getEnableRotationalMapping(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “enableRotationalMapping” attribute of the LineEnding with the given identifier 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.
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the “enableRotationalMapping” attribute of the LineEnding object, or
falseif the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEnableRotationalMapping(SBMLDocument *document, const std::string &sid, bool enableRotationalMapping)
Sets the value of the “enableRotationalMapping” attribute of the LineEnding with the given identifier of the first RenderInformationBase object of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the LineEnding to retrieve.
enableRotationalMapping – a boolean to use as the value of the “enableRotationalMapping” attribute of this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEnableRotationalMapping(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, bool enableRotationalMapping)
Sets the value of the “enableRotationalMapping” attribute of the LineEnding with the given identifier 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.
sid – a string representing the identifier of the LineEnding to retrieve.
enableRotationalMapping – a boolean to use as the value of the “enableRotationalMapping” attribute of this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
BoundingBox *LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingBoundingBox(SBMLDocument *document, const std::string &sid)
Returns the bounding box for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the bounding box for the LineEnding object, or
NULLif the object isNULL
-
BoundingBox *LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingBoundingBox(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the bounding box for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the bounding box for the LineEnding object, or
NULLif the object isNULL
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingEnableRotationalMapping(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Predicates returning
trueif the “enableRotationalMapping” attribute of the LineEnding associated with the SpeciesReferenceGlyph in the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document is set.- Parameters:
document – A pointer to the SBMLDocument object.
reactionId – A string representing the identifier of the Reaction object.
reactionGlyphIndex – The index number of the ReactionGlyph object.
speciesReferenceIndex – The index number of the SpeciesReference object.
- Returns:
trueif the “enableRotationalMapping” attribute of the LineEnding is set,falseif the attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingEnableRotationalMapping(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Predicates returning
trueif the “enableRotationalMapping” attribute of the LineEnding associated with the SpeciesReferenceGlyph in the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is set.- Parameters:
document – A pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – A string representing the identifier of the Reaction object.
reactionGlyphIndex – The index number of the ReactionGlyph object.
speciesReferenceIndex – The index number of the SpeciesReference object.
- Returns:
trueif the “enableRotationalMapping” attribute of the LineEnding is set,falseif the attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingEnableRotationalMapping(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “enableRotationalMapping” LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the value of “enableRotationalMapping” attribute of the LineEnding, or
falseif the object isNULLor the attribute is not set.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingEnableRotationalMapping(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “enableRotationalMapping” LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the value of “enableRotationalMapping” attribute of the LineEnding, or
falseif the object isNULLor the attribute is not set.
-
BoundingBox *LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingBoundingBox(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the bounding box for the LineEnding object, or
NULLif the object isNULL
-
BoundingBox *LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingBoundingBox(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the bounding box for the LineEnding object, or
NULLif the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingBoundingBoxX(SBMLDocument *document, const std::string &sid)
Returns the value of the “x” attribute of the bounding box for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the value of the “x” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingBoundingBoxX(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “x” attribute of the bounding box for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the value of the “x” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingBoundingBoxX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “x” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the value of the “x” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingBoundingBoxX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “x” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the value of the “x” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingBoundingBoxX(SBMLDocument *document, const std::string &sid, double x)
Sets the value of the “x” attribute of the bounding box for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the LineEnding to retrieve.
x – a double to use as the value of the “x” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingBoundingBoxX(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, double x)
Sets the value of the “x” attribute of the bounding box for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the LineEnding to retrieve.
x – a double to use as the value of the “x” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingBoundingBoxX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const double x)
Sets the value of the “x” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
x – a double to use as the value of the “x” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingBoundingBoxX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const double x)
Sets the value of the “x” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
x – a double to use as the value of the “x” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingBoundingBoxX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, const double x)
Sets the value of the “x” attribute of the bounding box for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
x – a double to use as the value of the “x” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingBoundingBoxX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, const double x)
Sets the value of the “x” attribute of the bounding box for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
x – a double to use as the value of the “x” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingBoundingBoxY(SBMLDocument *document, const std::string &sid)
Returns the value of the “y” attribute of the bounding box for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the value of the “y” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingBoundingBoxY(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “y” attribute of the bounding box for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the value of the “y” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingBoundingBoxY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “y” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the value of the “y” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingBoundingBoxY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “y” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the value of the “y” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingBoundingBoxY(SBMLDocument *document, const std::string &sid, double y)
Sets the value of the “y” attribute of the bounding box for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the LineEnding to retrieve.
y – a double to use as the value of the “y” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingBoundingBoxY(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, double y)
Sets the value of the “y” attribute of the bounding box for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the LineEnding to retrieve.
y – a double to use as the value of the “y” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingBoundingBoxY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const double y)
Sets the value of the “y” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
y – a double to use as the value of the “y” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingBoundingBoxY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const double y)
Sets the value of the “y” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
y – a double to use as the value of the “y” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingBoundingBoxY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, const double y)
Sets the value of the “y” attribute of the bounding box for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
y – a double to use as the value of the “y” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingBoundingBoxY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, const double y)
Sets the value of the “y” attribute of the bounding box for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
y – a double to use as the value of the “y” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingBoundingBoxWidth(SBMLDocument *document, const std::string &sid)
Returns the value of the “width” attribute of the bounding box for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the value of the “width” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingBoundingBoxWidth(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “width” attribute of the bounding box for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the value of the “width” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingBoundingBoxWidth(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “width” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the value of the “width” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingBoundingBoxWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “width” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document.
Returns the value of the “width” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the value of the “width” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL- Returns:
the value of the “width” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingBoundingBoxWidth(SBMLDocument *document, const std::string &sid, double width)
Sets the value of the “width” attribute of the bounding box for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the LineEnding to retrieve.
width – a double to use as the value of the “width” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingBoundingBoxWidth(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, double width)
Sets the value of the “width” attribute of the bounding box for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the LineEnding to retrieve.
width – a double to use as the value of the “width” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingBoundingBoxWidth(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const double width)
Sets the value of the “width” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
width – a double to use as the value of the “width” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingBoundingBoxWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const double width)
Sets the value of the “width” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
width – a double to use as the value of the “width” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingBoundingBoxWidth(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, const double width)
Sets the value of the “width” attribute of the bounding box for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
width – a double to use as the value of the “width” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingBoundingBoxWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, const double width)
Sets the value of the “width” attribute of the bounding box for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
width – a double to use as the value of the “width” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingBoundingBoxHeight(SBMLDocument *document, const std::string &sid)
Returns the value of the “height” attribute of the bounding box for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the value of the “height” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingBoundingBoxHeight(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “height” attribute of the bounding box for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the value of the “height” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingBoundingBoxHeight(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “height” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the LineEnding to retrieve.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the value of the “height” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingBoundingBoxHeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “height” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
sid – a string representing the identifier of the LineEnding to retrieve.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the value of the “height” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingBoundingBoxHeight(SBMLDocument *document, const std::string &sid, double height)
Sets the value of the “height” attribute of the bounding box for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the LineEnding to retrieve.
height – a double to use as the value of the “height” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingBoundingBoxWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “width” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document.
Returns the value of the “width” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the value of the “width” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL- Returns:
the value of the “width” attribute of the bounding box for this LineEnding, or
0.0if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingBoundingBoxHeight(SBMLDocument *document, unsigned int renderIndex, const std::string &sid, double height)
Sets the value of the “height” attribute of the bounding box for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the LineEnding to retrieve.
height – a double to use as the value of the “height” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingBoundingBoxHeight(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const double height)
Sets the value of the “height” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
height – a double to use as the value of the “height” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingBoundingBoxHeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const double height)
Sets the value of the “height” attribute of the bounding box for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
height – a double to use as the value of the “height” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingBoundingBoxHeight(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, const double height)
Sets the value of the “height” attribute of the bounding box for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
height – a double to use as the value of the “height” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingBoundingBoxHeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, const double height)
Sets the value of the “height” attribute of the bounding box for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
height – a double to use as the value of the “height” attribute of the bounding box for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
RenderGroup *LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingRenderGroup(SBMLDocument *document, const std::string &sid)
Returns the value of the “group” element of the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the value of the “group” element of this LineEnding as a RenderGroup, or
NULLif the object isNULL
-
RenderGroup *LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingRenderGroup(SBMLDocument *document, unsigned int renderIndex, const std::string &sid)
Returns the value of the “group” element of the LineEnding with the given identifier in the render information base with the givne index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the value of the “group” element of this LineEnding as a RenderGroup, or
NULLif the object isNULL
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingStrokeColor(SBMLDocument *document, const std::string &id)
Predicates returning
trueif the “stroke” attribute of the RenderGroup for the LineEnding with the given identifier.- Parameters:
document – a pointer to the SBMLDocument object.
sid – a string representing the identifier of the LineEnding to retrieve.
- Returns:
trueif the “stroke” attribute of the RenderGroup for this LineEnding object is set,falseif either the “stroke” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingStrokeColor(SBMLDocument *document, unsigned int renderIndex, const std::string &id)
Predicates returning
trueif the “stroke” attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index.- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
trueif the “stroke” attribute of the RenderGroup for this LineEnding object is set,falseif either the “stroke” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingStrokeColor(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Predicates returning
trueif the “stroke” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
trueif the “stroke” attribute of the RenderGroup for this LineEnding object is set,falseif either the “stroke” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingStrokeColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Predicates returning
trueif the “stroke” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
trueif the “stroke” attribute of the RenderGroup for this LineEnding object is set,falseif either the “stroke” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingStrokeColor(SBMLDocument *document, const std::string &id)
Returns the value of the “stroke” attribute of the RenderGroup for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the “stroke” attribute of the RenderGroup for this LineEnding object, or
NULLif the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingStrokeColor(SBMLDocument *document, unsigned int renderIndex, const std::string &id)
Returns the value of the “stroke” attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the “stroke” attribute of the RenderGroup for this LineEnding object, or
NULLif the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingStrokeColor(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “stroke” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the “stroke” attribute of the RenderGroup for this LineEnding object, or
NULLif the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingStrokeColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “stroke” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the “stroke” attribute of the RenderGroup for this LineEnding object, or
NULLif the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingStrokeColor(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “stroke” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the “stroke” attribute of the RenderGroup for this LineEnding object, or
NULLif the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingStrokeColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “stroke” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the “stroke” attribute of the RenderGroup for this LineEnding object, or
NULLif the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingStrokeColor(SBMLDocument *document, const std::string &id, const std::string &stroke)
Sets the value of the “stroke” attribute of the RenderGroup for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
stroke – a string to use as the value of the “stroke” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingStrokeColor(SBMLDocument *document, unsigned int renderIndex, const std::string &id, const std::string &stroke)
Sets the value of the “stroke” attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
stroke – a string to use as the value of the “stroke” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingStrokeColor(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const std::string &strokeColor)
Sets the value of the “stroke” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
strokeColor – a string to use as the value of the “stroke” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingStrokeColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const std::string &strokeColor)
Sets the value of the “stroke” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
strokeColor – a string to use as the value of the “stroke” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingStrokeColor(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, const std::string &strokeColor)
Sets the value of the “stroke” attribute of the RenderGroup for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
strokeColor – a string to use as the value of the “stroke” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingStrokeColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, const std::string &strokeColor)
Sets the value of the “stroke” attribute of the RenderGroup for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
strokeColor – a string to use as the value of the “stroke” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingStrokeWidth(SBMLDocument *document, const std::string &id)
Predicates returning
trueif the “stroke-width” attribute of the RenderGroup for the LineEnding with the given identifier.- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
trueif the “stroke-width” attribute of the RenderGroup for this LineEnding object is set,falseif either the “stroke-width” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingStrokeWidth(SBMLDocument *document, unsigned int renderIndex, const std::string &id)
Predicates returning
trueif the “stroke-width” attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index.- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
trueif the “stroke-width” attribute of the RenderGroup for this LineEnding object is set,falseif either the “stroke-width” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingStrokeWidth(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Predicates returning
trueif the “stroke-width” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
trueif the “stroke-width” attribute of the RenderGroup for this LineEnding object is set,falseif either the “stroke-width” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingStrokeWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Predicates returning
trueif the “stroke-width” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
trueif the “stroke-width” attribute of the RenderGroup for this LineEnding object is set,falseif either the “stroke-width” attribute is not set or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingStrokeWidth(SBMLDocument *document, const std::string &id)
Returns the value of the “stroke-width” attribute of the RenderGroup for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the “stroke-width” attribute of the RenderGroup for this LineEnding object, or
NULLif the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingStrokeWidth(SBMLDocument *document, unsigned int renderIndex, const std::string &id)
Returns the value of the “stroke-width” attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the “stroke-width” attribute of the RenderGroup for this LineEnding object, or
NULLif the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingStrokeWidth(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “stroke-width” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the value of the “stroke-width” attribute of the RenderGroup for this LineEnding object, or
0.0if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingStrokeWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “stroke-width” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the value of the “stroke-width” attribute of the RenderGroup for this LineEnding object, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingStrokeWidth(SBMLDocument *document, const std::string &id, double strokeWidth)
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
strokeWidth – a double to use as the value of the “stroke-width” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingStrokeWidth(SBMLDocument *document, unsigned int renderIndex, const std::string &id, double strokeWidth)
Sets the value of the “stroke-width” attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
strokeWidth – a double to use as the value of the “stroke-width” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingStrokeWidth(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const double strokeWidth)
Sets the value of the “stroke-width” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
strokeWidth – a double to use as the value of the “stroke-width” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingStrokeWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const double strokeWidth)
Sets the value of the “stroke-width” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
strokeWidth – a double to use as the value of the “stroke-width” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingStrokeWidth(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, const double strokeWidth)
Sets the value of the “stroke-width” attribute of the RenderGroup for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
strokeWidth – a double to use as the value of the “stroke-width” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingStrokeWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, const double strokeWidth)
Sets the value of the “stroke-width” attribute of the RenderGroup for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
strokeWidth – a double to use as the value of the “stroke-width” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingStrokeDashArray(SBMLDocument *document, const std::string &id)
Predicates returning
trueif the “stroke-dasharray” attribute of the RenderGroup for the LineEnding with the given identifier.- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
trueif the “stroke-dasharray” attribute of the RenderGroup for this LineEnding object is set,falseif either the “stroke-dasharray” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingStrokeDashArray(SBMLDocument *document, unsigned int renderIndex, const std::string &id)
Predicates returning
trueif the “stroke-dasharray” attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index.- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
trueif the “stroke-dasharray” attribute of the RenderGroup for this LineEnding object is set,falseif either the “stroke-dasharray” attribute is not set or the object isNULL.
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumSpeciesReferenceLineEndingStrokeDashes(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the number of dashes in the “stroke-dasharray” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the number of dashes in the “stroke-dasharray” attribute of the RenderGroup for this LineEnding object, or
0if the object isNULL.
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumSpeciesReferenceLineEndingStrokeDashes(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the number of dashes in the “stroke-dasharray” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the number of dashes in the “stroke-dasharray” attribute of the RenderGroup for this LineEnding object, or
0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingStrokeDashArray(SBMLDocument *document, const std::string &id, const std::vector<unsigned int> &strokeDashArray)
Sets the value of the “stroke-dasharray” attribute of the RenderGroup for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
strokeDashArray – a vector of unsigned integers to use as the value of the “stroke-dasharray” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingStrokeDashArray(SBMLDocument *document, unsigned int renderIndex, const std::string &id, const std::vector<unsigned int> &strokeDashArray)
Sets the value of the “stroke-dasharray” attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
strokeDashArray – a vector of unsigned integers to use as the value of the “stroke-dasharray” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumLineEndingStrokeDashes(SBMLDocument *document, const std::string &id)
Returns the size of the “stroke-dasharray” attribute of the RenderGroup for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the size of the “stroke-dasharray” attribute of the RenderGroup for this LineEnding object, or
0if the object isNULL
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumLineEndingStrokeDashes(SBMLDocument *document, unsigned int renderIndex, const std::string &id)
Returns the size of the “stroke-dasharray” attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the size of the “stroke-dasharray” attribute of the RenderGroup for this LineEnding object, or
0if the object isNULL
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingStrokeDash(SBMLDocument *document, const std::string &id, unsigned int dashIndex = 0)
Returns the stroke dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
dashIndex – an unsigned int representing the index of the stroke dash to retrieve.
- Returns:
the stroke dash at the given index of “stroke-dasharray” attribute of the RenderGroup for this LineEnding object,
0if the object isNULL
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingStrokeDash(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int dashIndex = 0)
Returns the stroke dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
dashIndex – an unsigned int representing the index of the stroke dash to retrieve.
- Returns:
the stroke dash at the given index of “stroke-dasharray” attribute of the RenderGroup for this LineEnding object,
0if the object isNULL
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingStrokeDash(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int dashIndex)
Returns the stroke dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
dashIndex – an unsigned int representing the index of the stroke dash to retrieve.
- Returns:
the stroke dash at the given index of “stroke-dasharray” attribute of the RenderGroup for this LineEnding object,
0if the object isNULL.
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingStrokeDash(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int dashIndex)
Returns the stroke dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
dashIndex – an unsigned int representing the index of the stroke dash to retrieve.
- Returns:
the stroke dash at the given index of “stroke-dasharray” attribute of the RenderGroup for this LineEnding object,
0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingStrokeDash(SBMLDocument *document, const std::string &id, unsigned int dash)
Sets the first dash of the ‘stroke-dasharray’ attribute of the RenderGroup for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
dash – a unsigned int value to use as the first dash of the ‘stroke-dasharray’ attribute of of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingStrokeDash(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int dash)
Sets the first dash of the ‘stroke-dasharray’ attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
dash – a unsigned int value to use as the first dash of the ‘stroke-dasharray’ attribute of of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingStrokeDash(SBMLDocument *document, const std::string &id, unsigned int dashIndex, unsigned int dash)
Sets the dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
dashIndex – an unsigned int representing the index of the stroke dash to retrieve.
dash – a unsigned int value to use as the dash at the given index of the ‘stroke-dasharray’ attribute of of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingStrokeDash(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int dashIndex, unsigned int dash)
Sets the dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
dashIndex – an unsigned int representing the index of the stroke dash to retrieve.
dash – a unsigned int value to use as the dash at the given index of the ‘stroke-dasharray’ attribute of of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingStrokeDash(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int dashIndex, unsigned int dash)
Sets the dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
dashIndex – an unsigned int representing the index of the stroke dash to set.
dash – an unsigned int value to use as the dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingStrokeDash(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int dashIndex, unsigned int dash)
Sets the dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
dashIndex – an unsigned int representing the index of the stroke dash to set.
dash – an unsigned int value to use as the dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingStrokeDash(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int dashIndex, unsigned int dash)
Sets the dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
dashIndex – an unsigned int representing the index of the stroke dash to set.
dash – an unsigned int value to use as the dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingStrokeDash(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int dashIndex, unsigned int dash)
Sets the dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
dashIndex – an unsigned int representing the index of the stroke dash to set.
dash – an unsigned int value to use as the dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingFillColor(SBMLDocument *document, const std::string &id)
Predicates returning
trueif the “fill” attribute of the RenderGroup for the LineEnding with the given identifier.- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
trueif the “fill” attribute of the RenderGroup for this LineEnding object is set,falseif either the “fill” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingFillColor(SBMLDocument *document, unsigned int renderIndex, const std::string &id)
Predicates returning
trueif the “fill” attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index.- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
trueif the “fill” attribute of the RenderGroup for this LineEnding object is set,falseif either the “fill” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingFillColor(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Predicates returning
trueif the “fill” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
trueif the “fill” attribute of the RenderGroup for this LineEnding object is set,falseif either the “fill” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingFillColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Predicates returning
trueif the “fill” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
trueif the “fill” attribute of the RenderGroup for this LineEnding object is set,falseif either the “fill” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingFillColor(SBMLDocument *document, const std::string &id)
Returns the value of the “fill” attribute of the RenderGroup for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the “fill” attribute of the RenderGroup for this LineEnding object, or
NULLif the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingFillColor(SBMLDocument *document, unsigned int renderIndex, const std::string &id)
Returns the value of the “fill” attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the “fill” attribute of the RenderGroup for this LineEnding object, or
NULLif the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingFillColor(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “fill” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the “fill” attribute of the RenderGroup for this LineEnding object, or
NULLif the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingFillColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “fill” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the “fill” attribute of the RenderGroup for this LineEnding object, or
NULLif the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingFillColor(SBMLDocument *document, const std::string &id, const std::string &fill)
Sets the value of the “fill” attribute of the RenderGroup for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
fill – a string to use as the value of the “fill” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingFillColorAsGradient(SBMLDocument *document, const std::string &id, const std::string &gradientType, std::vector<std::pair<std::string, double>> stopsVector)
Sets the value of the “fill” attribute of the RenderGroup for the LineEnding with the given identifier as a gradient.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
gradientType – a string representing the type of gradient to use.
stopsVector – a vector of pairs where each pair consists of a string representing the color and a double representing the offset for the gradient stop.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingFillColor(SBMLDocument *document, unsigned int renderIndex, const std::string &id, const std::string &fill)
Sets the value of the “fill” attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
fill – a string to use as the value of the “fill” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingFillColorAsGradient(SBMLDocument *document, unsigned int renderIndex, const std::string &id, const std::string &gradientType, std::vector<std::pair<std::string, double>> stopsVector)
Sets the value of the “fill” attribute of the RenderGroup for the LineEnding with the given identifier as a gradient in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
gradientType – a string representing the type of gradient to use.
stopsVector – a vector of pairs where each pair consists of a string representing the color and a double representing the offset for the gradient stop.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingFillColor(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const std::string &fillColor)
Sets the value of the “fill” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
fillColor – a string to use as the value of the “fill” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingFillColorAsGradient(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const std::string &gradientType, std::vector<std::pair<std::string, double>> stopsVector)
Sets the value of the “fill” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document as a gradient.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
gradientType – a string representing the type of gradient to use.
stopsVector – a vector of pairs where each pair consists of a string representing the color and a double representing the offset for the gradient stop.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingFillColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const std::string &fillColor)
Sets the value of the “fill” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
fillColor – a string to use as the value of the “fill” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingFillColorAsGradient(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const std::string &gradientType, std::vector<std::pair<std::string, double>> stopsVector)
Sets the value of the “fill” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a gradient.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
gradientType – a string representing the type of gradient to use.
stopsVector – a vector of pairs where each pair consists of a string representing the color and a double representing the offset for the gradient stop.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingFillColor(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, const std::string &fillColor)
Sets the value of the “fill” attribute of the RenderGroup for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
fillColor – a string to use as the value of the “fill” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingFillColorAsGradient(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, const std::string &gradientType, std::vector<std::pair<std::string, double>> stopsVector)
Sets the value of the “fill” attribute of the RenderGroup for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document as a gradient.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
gradientType – a string representing the type of gradient to use.
stopsVector – a vector of pairs where each pair consists of a string representing the color and a double representing the offset for the gradient stop.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingFillColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, const std::string &fillColor)
Sets the value of the “fill” attribute of the RenderGroup for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
fillColor – a string to use as the value of the “fill” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingFillColorAsGradient(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, const std::string &gradientType, std::vector<std::pair<std::string, double>> stopsVector)
Sets the value of the “fill” attribute of the RenderGroup for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a gradient.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
gradientType – a string representing the type of gradient to use.
stopsVector – a vector of pairs where each pair consists of a string representing the color and a double representing the offset for the gradient stop.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingFillRule(SBMLDocument *document, const std::string &id)
Predicates returning
trueif the “fill-rule” attribute of the RenderGroup for the LineEnding with the given identifier.- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
trueif the “fill-rule” attribute of the RenderGroup for this LineEnding object is set,falseif either the “fill-rule” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingFillRule(SBMLDocument *document, unsigned int renderIndex, const std::string &id)
Predicates returning
trueif the “fill-rule” attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index.- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
trueif the “fill-rule” attribute of the RenderGroup for this LineEnding object is set,falseif either the “fill-rule” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingFillRule(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Predicates returning
trueif the “fill-rule” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
trueif the “fill-rule” attribute of the RenderGroup for this LineEnding object is set,falseif either the “fill-rule” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingFillRule(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Predicates returning
trueif the “fill-rule” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
trueif the “fill-rule” attribute of the RenderGroup for this LineEnding object is set,falseif either the “fill-rule” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingFillRule(SBMLDocument *document, const std::string &id)
Returns the value of the “fill-rule” attribute of the RenderGroup for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the “fill-rule” attribute of the RenderGroup for this LineEnding object, or
NULLif the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingFillRule(SBMLDocument *document, unsigned int renderIndex, const std::string &id)
Returns the value of the “fill-rule” attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the “fill-rule” attribute of the RenderGroup for this LineEnding object, or
NULLif the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingFillRule(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “fill-rule” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the “fill-rule” attribute of the RenderGroup for this LineEnding object, or
NULLif the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingFillRule(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex)
Returns the value of the “fill-rule” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the “fill-rule” attribute of the RenderGroup for this LineEnding object, or
NULLif the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingFillRule(SBMLDocument *document, const std::string &id, const std::string &fillRule)
Sets the value of the “fill-rule” attribute of the RenderGroup for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
fillRule – a string to use as the value of the “fill-rule” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingFillRule(SBMLDocument *document, unsigned int renderIndex, const std::string &id, const std::string &fillRule)
Sets the value of the “fill-rule” attribute of the RenderGroup for the LineEnding with the given identifier in the render information base with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
fillRule – a string to use as the value of the “fill-rule” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingFillRule(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const std::string &fillRule)
Sets the value of the “fill-rule” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
fillRule – a string to use as the value of the “fill-rule” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingFillRule(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const std::string &fillRule)
Sets the value of the “fill-rule” attribute of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
fillRule – a string to use as the value of the “fill-rule” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingFillRule(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, const std::string &fillRule)
Sets the value of the “fill-rule” attribute of the RenderGroup for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
fillRule – a string to use as the value of the “fill-rule” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingFillRule(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, const std::string &fillRule)
Sets the value of the “fill-rule” attribute of the RenderGroup for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
fillRule – a string to use as the value of the “fill-rule” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumLineEndingGeometricShapes(SBMLDocument *document, const std::string &id)
Returns number of Transformation2D objects in the RenderGroup for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the number of Transformation2D objects in the RenderGroup for this LineEnding object, or
0if the object isNULL.
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumLineEndingGeometricShapes(SBMLDocument *document, unsigned int renderIndex, const std::string &id)
Returns number of Transformation2D objects in the RenderGroup for the LineEnding with the given identifier in the render information base with the given index.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
- Returns:
the number of Transformation2D objects in the RenderGroup for this LineEnding object, or
0if the object isNULL.
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumSpeciesReferenceLineEndingGeometricShapes(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0)
Returns the number of Transformation2D objects in the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the number of Transformation2D objects in the RenderGroup for this LineEnding object, or
0if the object isNULL.
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumSpeciesReferenceLineEndingGeometricShapes(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0)
Returns the number of Transformation2D objects in the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
the number of Transformation2D objects in the RenderGroup for this LineEnding object, or
0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addLineEndingGeometricShape(SBMLDocument *document, const std::string &id, const std::string &shape)
Adds a geometric shape to the Transformation2D objects in the RenderGroup for the LineEnding with the given identifier in the first RenderInformationBase object of the SBMLDocument.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
shape – a string value indicating the shape of the geometric shape to be set.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addLineEndingGeometricShape(SBMLDocument *document, unsigned int renderIndex, const std::string &id, const std::string &shape)
Adds a geometric shape to the Transformation2D objects in the RenderGroup for the LineEnding with the given identifier in the RenderInformationBase object with the given index of the SBMLDocument.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
shape – a string value indicating the shape of the geometric shape to be set.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addSpeciesReferenceLineEndingGeometricShape(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const std::string &shape)
Adds a geometric shape to the Transformation2D objects in the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
shape – a string value indicating the shape of the geometric shape to be set.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addSpeciesReferenceLineEndingGeometricShape(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const std::string &shape)
Adds a geometric shape to the Transformation2D objects in the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
shape – a string value indicating the shape of the geometric shape to be set.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeLineEndingGeometricShape(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Removes the geometric shape with the given index from the Transformation2D objects in the RenderGroup for the LineEnding with the given identifier in the first RenderInformationBase object of the SBMLDocument.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to remove.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeLineEndingGeometricShape(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Removes the geometric shape with the given index from the Transformation2D objects in the RenderGroup for the LineEnding with the given identifier in the RenderInformationBase object with the given index of the SBMLDocument.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to remove.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeSpeciesReferenceLineEndingGeometricShape(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int geometricShapeIndex = 0)
Removes the geometric shape with the given index from the Transformation2D objects in the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an int representing the index of the Transformation2D to remove.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeSpeciesReferenceLineEndingGeometricShape(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int geometricShapeIndex = 0)
Removes the geometric shape with the given index from the Transformation2D objects in the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an int representing the index of the Transformation2D to remove.
- Returns:
integer value indicating success/failure of the function.
-
std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeType(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the type of the geometric shape with the given index in the Transformation2D objects in the RenderGroup for the LineEnding with the given identifier in the first RenderInformationBase object of the SBMLDocument.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
the type of the geometric shape of the Transformation2D at the given index of the RenderGroup of this LineEnding, or
""if the object isNULL
-
std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeType(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the type of the geometric shape with the given index in the Transformation2D objects in the RenderGroup for the LineEnding with the given identifier in the RenderInformationBase object with the given index of the SBMLDocument.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
the type of the geometric shape of the Transformation2D at the given index of the RenderGroup of this LineEnding, or
""if the object isNULL
-
std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeType(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int geometricShapeIndex = 0)
Returns the type of the geometric shape with the given index of the Transformation2D objects in the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an int representing the index of the Transformation2D to remove.
- Returns:
the type of the geometric shape of the Transformation2D at the given index of the RenderGroup of this LineEnding, or
""if the object isNULL
-
std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeType(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int geometricShapeIndex = 0)
Returns the type of the geometric shape with the given index of the Transformation2D objects in the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an int representing the index of the Transformation2D to remove.
- Returns:
the type of the geometric shape of the Transformation2D at the given index of the RenderGroup of this LineEnding, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeType(SBMLDocument *document, const std::string &id, const std::string &shape)
Sets the type of the geometric shape of the Transformation2D objects in the RenderGroup for the LineEnding with the given identifier in the first RenderInformationBase object of the SBMLDocument.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
shape – a string value indicating the shape of the geometric shape to be set.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeType(SBMLDocument *document, unsigned int renderIndex, const std::string &id, const std::string &shape)
Sets the type of the geometric shape of the Transformation2D objects in the RenderGroup for the LineEnding with the given identifier in the RenderInformationBase object with the given index of the SBMLDocument.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
shape – a string value indicating the shape of the geometric shape to be set.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeType(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const std::string &shape)
Sets the type of the geometric shape of the Transformation2D objects in the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeType(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, const std::string &shape)
Sets the type of the geometric shape of the Transformation2D objects in the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeId(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the id of the geometric shape with the given index in the Transformation2D objects in the RenderGroup for the LineEnding with the given identifier in the first RenderInformationBase object of the SBMLDocument.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
the id of the geometric shape of the Transformation2D at the given index of the RenderGroup of this LineEnding, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeId(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the id of the geometric shape with the given index in the Transformation2D objects in the RenderGroup for the LineEnding with the given identifier in the RenderInformationBase object with the given index of the SBMLDocument.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
the type of the geometric shape of the Transformation2D at the given index of the RenderGroup of this LineEnding, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeId(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the id of the geometric shape with the given index of the Transformation2D objects in the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an int representing the index of the Transformation2D to remove.
- Returns:
the id of the geometric shape of the Transformation2D at the given index of the RenderGroup of this LineEnding, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeId(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the type of the geometric shape with the given index of the Transformation2D objects in the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an int representing the index of the Transformation2D to remove.
- Returns:
the type of the geometric shape of the Transformation2D at the given index of the RenderGroup of this LineEnding, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeId(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const std::string &shapeId)
Sets the type of the geometric shape with the given index of the Transformation2D objects in the RenderGroup for the LineEnding with the given identifier in the first RenderInformationBase object of the SBMLDocument.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
shapeId – a string value indicating the id of the geometric shape to be set.
- Returns:
the type of the geometric shape with the given index of the Transformation2D at the given index of the RenderGroup of this LineEnding, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeId(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const std::string &shapeId)
Sets the type of the geometric shape with the given index of the Transformation2D objects in the RenderGroup for the LineEnding with the given identifier in the RenderInformationBase object with the given index of the SBMLDocument.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
shapeId – a string value indicating the id of the geometric shape to be set.
- Returns:
the type of the geometric shape with the given index of the Transformation2D at the given index of the RenderGroup of this LineEnding, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeId(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const std::string &shapeId)
Sets the type of the geometric shape with the given index of the Transformation2D objects in the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeId(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const std::string &shapeId)
Sets the type of the geometric shape of the Transformation2D objects in the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isLineEndingRectangle(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif 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 – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Rectangle,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isLineEndingRectangle(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif 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.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Rectangle,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesReferenceLineEndingRectangle(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document is of type Rectangle.- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Rectangle,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesReferenceLineEndingRectangle(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is of type Rectangle.- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Rectangle,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isLineEndingEllipse(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif 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 – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Ellipse,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isLineEndingEllipse(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif 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.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Ellipse,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesReferenceLineEndingEllipse(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document is of type Ellipse.- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Ellipse,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesReferenceLineEndingEllipse(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is of type Ellipse.- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Ellipse,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isLineEndingPolygon(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif 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 – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Polygon,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isLineEndingPolygon(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif 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.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Polygon,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesReferenceLineEndingPolygon(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document is of type Polygon.- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Polygon,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesReferenceLineEndingPolygon(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is of type Polygon.- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Polygon,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isLineEndingImage(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif 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 – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Image,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isLineEndingImage(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif 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.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Image,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesReferenceLineEndingImage(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document is of type Image.- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Image,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesReferenceLineEndingImage(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is of type Image.- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Image,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isLineEndingRenderCurve(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif 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 – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type RenderCurve,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isLineEndingRenderCurve(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif 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.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type RenderCurve,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesReferenceLineEndingRenderCurve(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document is of type RenderCurve.- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type RenderCurve,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesReferenceLineEndingRenderCurve(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is of type RenderCurve.- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type RenderCurve,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isLineEndingText(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif 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 – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Text,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isLineEndingText(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif 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.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Text,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesReferenceLineEndingText(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document is of type Text.- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Text,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesReferenceLineEndingText(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is of type Text.- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Text,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeStrokeColor(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the first RenderInformationBase of the SBML document is set.- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “stroke” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object is set,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeStrokeColor(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif 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.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “stroke” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object is of type Text,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeStrokeColor(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex = 0, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “stroke” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is set.- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “stroke” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object is set,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeStrokeColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “stroke” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is set.- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “stroke” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object is set,falseotherwise.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeStrokeColor(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the first RenderInformationBase of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
the “stroke” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object, or
""if the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeStrokeColor(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 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 – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
the “stroke” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object, or
""if the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeStrokeColor(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int geometricShapeIndex = 0)
Returns the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “stroke” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object, or
""if the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeStrokeColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int geometricShapeIndex = 0)
Returns the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “stroke” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeStrokeColor(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const std::string &strokeColor)
Sets the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the first RenderInformationBase of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
strokeColor – a string to use as the value of the “stroke” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeStrokeColor(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const std::string &strokeColor)
Sets the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
strokeColor – a string to use as the value of the “stroke” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeStrokeColor(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const std::string &strokeColor)
Sets the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
strokeColor – a string to use as the value of the “stroke” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeStrokeColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const std::string &strokeColor)
Sets the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
strokeColor – a string to use as the value of the “stroke” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeStrokeWidth(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the first RenderInformationBase object of the SBML document is set.- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object is set,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeStrokeWidth(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif 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.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “stroke” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object is set,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeStrokeWidth(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document is set.- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object is set,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeStrokeWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is set.- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object is set,falseotherwise.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeStrokeWidth(SBMLDocument *document, const std::string &id, unsigned 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 of the first RenderInformationBase of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object, or
""if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeStrokeWidth(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned 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 of the RenderInformationBase object with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object, or
""if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeStrokeWidth(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int geometricShapeIndex = 0)
Returns the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object, or
""if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeStrokeWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int geometricShapeIndex = 0)
Returns the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeStrokeWidth(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, double strokeWidth)
Sets the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the first RenderInformationBase of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
strokeWidth – a string to use as the value of the “stroke-width” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeStrokeWidth(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, double strokeWidth)
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 with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
strokeWidth – a string to use as the value of the “stroke-width” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeStrokeWidth(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, double strokeWidth)
Sets the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
strokeWidth – a string to use as the value of the “stroke-width” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeStrokeWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, double strokeWidth)
Sets the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
strokeWidth – a string to use as the value of the “stroke-width” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeFillColor(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif “fill” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the first RenderInformationBase objec of the SBML document is set.- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “fill” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object is set,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeFillColor(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif 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.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “fill” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object is set,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeFillColor(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “fill” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document is set.- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “fill” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object is set,falseotherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeFillColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex = 0, unsigned int speciesReferenceIndex = 0, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “fill” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is set.- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “fill” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object is set,falseotherwise.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeFillColor(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex)
Returns the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the first RenderInformationBase of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
the “fill” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object, or
""if the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeFillColor(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex)
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 – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
- Returns:
the “fill” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object, or
""if the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeFillColor(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “fill” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object, or
""if the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeFillColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “fill” attribute of the Transformation2D at the given index of the RenderGroup for this LineEnding object, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeFillColor(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const std::string &fillColor)
Sets the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the first RenderInformationBase of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
fillColor – a string to use as the value of the “fill” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeFillColor(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const std::string &fillColor)
Sets the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
fillColor – a string to use as the value of the “fill” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeFillColorAsGradient(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const std::string &gradientType, std::vector<std::pair<std::string, double>> stopsVector)
Sets the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the first RenderInformationBase of the SBML document as gradient.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
gradientType – a string representing the type of gradient to use.
stopsVector – a vector of pairs where each pair consists of a string representing the color and a double representing the offset for the gradient stop.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeFillColorAsGradient(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const std::string &gradientType, std::vector<std::pair<std::string, double>> stopsVector)
Sets the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the LineEnding object of the RenderInformationBase with the given index of the SBML document as gradient.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an int representing the index of the Transformation2D to retrieve.
gradientType – a string representing the type of gradient to use.
stopsVector – a vector of pairs where each pair consists of a string representing the color and a double representing the offset for the gradient stop.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeFillColor(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const std::string &fillColor)
Sets the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
fillColor – a string to use as the value of the “fill” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeFillColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const std::string &fillColor)
Sets the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
fillColor – a string to use as the value of the “fill” attribute of the RenderGroup for this LineEnding object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeFillColorAsGradient(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const std::string &gradientType, std::vector<std::pair<std::string, double>> stopsVector)
Sets the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document as gradient.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
gradientType – a string representing the type of gradient to use.
stopsVector – a vector of pairs where each pair consists of a string representing the color and a double representing the offset for the gradient stop.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeFillColorAsGradient(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const std::string &gradientType, std::vector<std::pair<std::string, double>> stopsVector)
Sets the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as gradient.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
gradientType – a string representing the type of gradient to use.
stopsVector – a vector of pairs where each pair consists of a string representing the color and a double representing the offset for the gradient stop.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeX(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the X coordinate of the geometric shape for the LineEnding with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the X coordinate is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeX(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the X coordinate of the geometric shape for the LineEnding with the given identifier and render index is set.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the X coordinate is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the X coordinate is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is set.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the X coordinate is set, false otherwise.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeX(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the X coordinate of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeX(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the X coordinate of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X coordinate as a RelAbsVector.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeXAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the X coordinate of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X coordinate as a double, or
0if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeXAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the X coordinate of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X coordinate as a double, or
0if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeXAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X coordinate as a double, or
0if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X coordinate as a double, or
0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeX(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector &x)
Sets the X coordinate of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
x – the new X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeX(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector &x)
Sets the X coordinate of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
x – the new X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector &x)
Sets the X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
x – the new X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector &x)
Sets the X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
x – the new X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector &x)
Sets the X coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
x – the new X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector &x)
Sets the X coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
x – the new X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeXAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const double &x)
Sets the X coordinate of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
x – the new X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeXAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const double &x)
Sets the X coordinate of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
x – the new X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeXAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &x)
Sets the X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
x – the new X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &x)
Sets the X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
x – the new X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeXAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &x)
Sets the X coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
x – the new X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &x)
Sets the X coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
x – the new X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeY(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the Y coordinate of the geometric shape for the LineEnding with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the Y coordinate is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeY(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the Y coordinate of the geometric shape for the LineEnding with the given identifier and render index is set.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the Y coordinate is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the Y coordinate is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is set.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the Y coordinate is set, false otherwise.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeY(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the Y coordinate of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeY(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the Y coordinate of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y coordinate as a RelAbsVector.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeYAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the Y coordinate of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y coordinate as a double, or
0if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeYAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the Y coordinate of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y coordinate as a double, or
0if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeYAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y coordinate as a double, or
0if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y coordinate as a double, or
0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeY(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector &y)
Sets the Y coordinate of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
y – the new Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeY(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector &y)
Sets the Y coordinate of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
y – the new Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector &y)
Sets the Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
y – the new Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector &y)
Sets the Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
y – the new Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector &y)
Sets the Y coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
y – the new Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector &y)
Sets the Y coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
y – the new Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeYAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const double &y)
Sets the Y coordinate of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
y – the new Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeYAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const double &y)
Sets the Y coordinate of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
y – the new Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeYAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &y)
Sets the Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
y – the new Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &y)
Sets the Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
y – the new Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeYAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &y)
Sets the Y coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
y – the new Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &y)
Sets the Y coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
y – the new Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeWidth(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the width of the geometric shape for the LineEnding with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the width is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeWidth(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the width of the geometric shape for the LineEnding with the given identifier and render index is set.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the width is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeWidth(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the width of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the width is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the width of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is set.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the width is set, false otherwise.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeWidth(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the width of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the width as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeWidth(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the width of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the width as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeWidth(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the width of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the width as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the width of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the width as a RelAbsVector.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeWidthAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the width of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the width as a double, or
0if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeWidthAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the width of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the width as a double, or
0if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeWidthAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the width of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the width as a double, or
0if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeWidthAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the width of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the width as a double, or
0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeWidth(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector &width)
Sets the width of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
width – the new width as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeWidth(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector &width)
Sets the width of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
width – the new width as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeWidth(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector &width)
Sets the width of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
width – the new width as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector &width)
Sets the width of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
width – the new width as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeWidth(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector &width)
Sets the width of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
width – the new width as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeWidth(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector &width)
Sets the width of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
width – the new width as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeWidthAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const double &width)
Sets the width of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
width – the new width as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeWidthAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const double &width)
Sets the width of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
width – the new width as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeWidthAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &width)
Sets the width of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
width – the new width as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeWidthAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &width)
Sets the width of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
width – the new width as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeWidthAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &width)
Sets the width of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
width – the new width as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeWidthAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &width)
Sets the width of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
width – the new width as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeHeight(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the height of the geometric shape for the LineEnding with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the height is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeHeight(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the height of the geometric shape for the LineEnding with the given identifier and render index is set.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the height is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeHeight(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the height of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the height is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeHeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the height of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is set.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the height is set, false otherwise.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeHeight(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the height of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the height as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeHeight(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the height of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the height as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeHeight(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the height of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the height as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeHeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the height of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the height as a RelAbsVector.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeHeightAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the height of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the height as a double, or
0if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeHeightAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the height of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to retrieve.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the height as a double, or
0if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeHeightAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the height of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the height as a double, or
0if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeHeightAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the height of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the height as a double, or
0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeHeight(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector &height)
Sets the height of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
height – the new height as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeHeight(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector &height)
Sets the height of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
height – the new height as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeHeight(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector &height)
Sets the height of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
height – the new height as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeHeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector &height)
Sets the height of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
height – the new height as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeHeight(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector &height)
Sets the height of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
height – the new height as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeHeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector &height)
Sets the height of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
height – the new height as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeHeightAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const double &height)
Sets the height of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
height – the new height as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeHeightAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const double &height)
Sets the height of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
height – the new height as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeHeightAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &height)
Sets the height of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
height – the new height as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeHeightAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &height)
Sets the height of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
height – the new height as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeHeightAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &height)
Sets the height of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
height – the new height as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeHeightAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &height)
Sets the height of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
height – the new height as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeRatio(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the ratio of the geometric shape for the LineEnding with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
true if the ratio is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeRatio(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the ratio of the geometric shape for the LineEnding with the given identifier and render index is set.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
true if the ratio is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeRatio(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the ratio of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the ratio is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeRatio(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the ratio of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is set.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to check.
- Returns:
true if the ratio is set, false otherwise.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeRatio(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the ratio of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the ratio as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeRatio(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the ratio of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the ratio as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeRatio(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the ratio of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the ratio as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeRatio(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the ratio of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the ratio as a double.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeRatio(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, double ratio)
Sets the ratio of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
ratio – the new ratio as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeRatio(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, double ratio)
Sets the ratio of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
ratio – the new ratio as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeRatio(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &ratio)
Sets the ratio of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
ratio – the new ratio as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeRatio(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &ratio)
Sets the ratio of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
ratio – the new ratio as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeRatio(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &ratio)
Sets the ratio of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
ratio – the new ratio as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeRatio(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &ratio)
Sets the ratio of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
ratio – the new ratio as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the X curvature radius of the geometric shape corner for the LineEnding with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
true if the X curvature radius is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the X curvature radius of the geometric shape corner for the LineEnding with the given identifier and render index is set.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
true if the X curvature radius is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the X curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
true if the X curvature radius is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the X curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is set.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
true if the X curvature radius is set, false otherwise.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the X curvature radius of the geometric shape corner for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X curvature radius as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the X curvature radius of the geometric shape corner for the LineEnding with the given identifier and render index.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X curvature radius as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the X curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X curvature radius as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the X curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X curvature radius as a RelAbsVector.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the X curvature radius of the geometric shape corner for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X curvature radius as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the X curvature radius of the geometric shape corner for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X curvature radius as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the X curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X curvature radius as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the X curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X curvature radius as a double.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector &CornerCurvatureRadiusX)
Sets the X curvature radius of the geometric shape corner for the LineEnding with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
CornerCurvatureRadiusX – the new X curvature radius as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector &CornerCurvatureRadiusX)
Sets the X curvature radius of the geometric shape corner for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
CornerCurvatureRadiusX – The new X curvature radius as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector &radiusX)
Sets the X curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X curvature radius as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector &radiusX)
Sets the X curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X curvature radius as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector &radiusX)
Sets the X curvature radius of the geometric shape corner for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X curvature radius as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector &radiusX)
Sets the X curvature radius of the geometric shape corner for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X curvature radius as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const double &CornerCurvatureRadiusX)
Sets the X curvature radius of the geometric shape corner for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
CornerCurvatureRadiusX – the new X curvature radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const double &CornerCurvatureRadiusX)
Sets the X curvature radius of the geometric shape corner for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
CornerCurvatureRadiusX – the new X curvature radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &radiusX)
Sets the X curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X curvature radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &radiusX)
Sets the X curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X curvature radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &radiusX)
Sets the X curvature radius of the geometric shape corner for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X curvature radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &radiusX)
Sets the X curvature radius of the geometric shape corner for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X curvature radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the Y curvature radius of the geometric shape corner for the LineEnding with the given identifier is set.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
True if the Y curvature radius is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the Y curvature radius of the geometric shape corner for the LineEnding with the given identifier and render index is set.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
True if the Y curvature radius is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the Y curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
true if the Y curvature radius is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the Y curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is set.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
true if the Y curvature radius is set, false otherwise.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the Y curvature radius of the geometric shape corner for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
The Y curvature radius as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the Y curvature radius of the geometric shape corner for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
The Y curvature radius as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the Y curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout with of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y curvature radius as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the Y curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y curvature radius as a RelAbsVector.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the Y curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y curvature radius as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the Y curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y curvature radius as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the Y curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y curvature radius as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the Y curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y curvature radius as a double.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector &CornerCurvatureRadiusY)
Sets the Y curvature radius of the geometric shape corner for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
CornerCurvatureRadiusY – The new Y curvature radius as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector &CornerCurvatureRadiusY)
Sets the Y curvature radius of the geometric shape corner for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
CornerCurvatureRadiusY – The new Y curvature radius as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector &radiusY)
Sets the Y curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y curvature radius as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector &radiusY)
Sets the Y curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y curvature radius as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector &radiusY)
Sets the Y curvature radius of the geometric shape corner for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y curvature radius as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector &radiusY)
Sets the Y curvature radius of the geometric shape corner for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y curvature radius as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const double &CornerCurvatureRadiusY)
Sets the Y curvature radius of the geometric shape corner for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
CornerCurvatureRadiusY – the new Y curvature radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const double &CornerCurvatureRadiusY)
Sets the Y curvature radius of the geometric shape corner for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
CornerCurvatureRadiusY – the new Y curvature radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &radiusY)
Sets the Y curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y curvature radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &radiusY)
Sets the Y curvature radius of the geometric shape corner for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y curvature radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &radiusY)
Sets the Y curvature radius of the geometric shape corner for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y curvature radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &radiusY)
Sets the Y curvature radius of the geometric shape corner for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y curvature radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeCenterX(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the center X coordinate of the geometric shape for the LineEnding with the given identifier is set.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
True if the center X coordinate is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeCenterX(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the center X coordinate of the geometric shape for the LineEnding with the given identifier and render index is set.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
True if the center X coordinate is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeCenterX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the center X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
true if the center X coordinate is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeCenterX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the center X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is set.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
true if the center X coordinate is set, false otherwise.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeCenterX(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the center X coordinate of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
The center X coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeCenterX(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the center X coordinate of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
The center X coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeCenterX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the center X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the center X coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeCenterX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the center X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the center X coordinate as a RelAbsVector.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeCenterXAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the center X coordinate of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the center X coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeCenterXAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the center X coordinate of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the center X coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeCenterXAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the center X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the center X coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeCenterXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the center X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the center X coordinate as a double.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeCenterX(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector ¢erX)
Sets the center X coordinate of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
centerX – The new center X coordinate as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeCenterX(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector ¢erX)
Sets the center X coordinate of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
centerX – The new center X coordinate as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeCenterX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector ¢erX)
Sets the center X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerX – the new center X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeCenterX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector ¢erX)
Sets the center X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerX – the new center X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeCenterX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector ¢erX)
Sets the center X coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerX – the new center X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeCenterX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector ¢erX)
Sets the center X coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerX – the new center X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeCenterXAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const double ¢erX)
Sets the center X coordinate of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerX – the new center X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeCenterXAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const double ¢erX)
Sets the center X coordinate of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerX – the new center X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeCenterXAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double ¢erX)
Sets the center X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerX – the new center X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeCenterXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double ¢erX)
Sets the center X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerX – the new center X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeCenterXAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double ¢erX)
Sets the center X coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerX – the new center X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeCenterXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double ¢erX)
Sets the center X coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerX – the new center X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeCenterY(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the center Y coordinate of the geometric shape for the LineEnding with the given identifier is set.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
True if the center Y coordinate is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeCenterY(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the center Y coordinate of the geometric shape for the LineEnding with the given identifier and render index is set.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
True if the center Y coordinate is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeCenterY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the center Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
true if the center Y coordinate is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeCenterY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the center Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is set.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
true if the center Y coordinate is set, false otherwise.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeCenterY(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the center Y coordinate of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
The center Y coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeCenterY(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the center Y coordinate of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
The center Y coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeCenterY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeCenterY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the center Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the center Y coordinate as a RelAbsVector.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeCenterYAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the center Y coordinate of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the center Y coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeCenterYAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the center Y coordinate of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the center Y coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeCenterYAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the center Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the center Y coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeCenterYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the center Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the center Y coordinate as a double.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeCenterY(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector ¢erY)
Sets the center Y coordinate of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
centerY – The new center Y coordinate as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeCenterY(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector ¢erY)
Sets the center Y coordinate of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
centerY – The new center Y coordinate as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeCenterY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector ¢erY)
Sets the center Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerY – the new center Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeCenterY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector ¢erY)
Sets the center Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerY – the new center Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeCenterY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector ¢erY)
Sets the center Y coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerY – the new center Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeCenterY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector ¢erY)
Sets the center Y coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerY – the new center Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeCenterYAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const double ¢erY)
Sets the center Y coordinate of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerY – the new center Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeCenterYAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const double ¢erY)
Sets the center Y coordinate of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerY – the new center Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeCenterYAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double ¢erY)
Sets the center Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerY – the new center Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeCenterYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double ¢erY)
Sets the center Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerY – the new center Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeCenterYAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double ¢erY)
Sets the center Y coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerY – the new center Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeCenterYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double ¢erY)
Sets the center Y coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
centerY – the new center Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeRadiusX(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the radius X of the geometric shape for the LineEnding with the given identifier is set.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
True if the radius X is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeRadiusX(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the radius X of the geometric shape for the LineEnding with the given identifier and render index is set.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
True if the radius X is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeRadiusX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the radius X of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
true if the radius X is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeRadiusX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the radius X of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is set.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
true if the radius X is set, false otherwise.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeRadiusX(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the X radius of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
The X radius as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeRadiusX(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the X radius of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
The X radius as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeRadiusX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the X radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X radius as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeRadiusX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the X radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X radius as a RelAbsVector.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeRadiusXAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the X radius of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X radius as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeRadiusXAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the X radius of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X radius as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeRadiusXAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the X radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X radius as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeRadiusXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the X radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the X radius as a double.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeRadiusX(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector &radiusX)
Sets the X radius of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
radiusX – The new X radius as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeRadiusX(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector &radiusX)
Sets the X radius of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
radiusX – The new X radius as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeRadiusX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector &radiusX)
Sets the X radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X radius as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeRadiusX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector &radiusX)
Sets the X radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X radius as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeRadiusX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector &radiusX)
Sets the X radius of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X radius as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeRadiusX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector &radiusX)
Sets the X radius of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X radius as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeRadiusXAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const double &radiusX)
Sets the X radius of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeRadiusXAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const double &radiusX)
Sets the X radius of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeRadiusXAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &radiusX)
Sets the X radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeRadiusXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &radiusX)
Sets the X radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeRadiusXAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &radiusX)
Sets the X radius of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeRadiusXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &radiusX)
Sets the X radius of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusX – the new X radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeRadiusY(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the Y radius of the geometric shape for the LineEnding with the given identifier is set.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
True if the Y radius is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeRadiusY(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the Y radius of the geometric shape for the LineEnding with the given identifier and render index is set.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
True if the Y radius is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeRadiusY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the Y radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
true if the Y radius is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeRadiusY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the Y radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is set.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
true if the Y radius is set, false otherwise.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeRadiusY(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the Y radius of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
The Y radius as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeRadiusY(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the Y radius of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
The Y radius as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeRadiusY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the Y radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the first Layout of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y radius as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeRadiusY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Gets the Y radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y radius as a RelAbsVector.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeRadiusYAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the Y radius of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y radius as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeRadiusYAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Returns the Y radius of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y radius as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeRadiusYAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the Y radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y radius as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeRadiusYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the Y radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the Y radius as a double.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeRadiusY(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector &radiusY)
Sets the Y radius of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
radiusY – The new Y radius as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeRadiusY(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const RelAbsVector &radiusY)
Sets the Y radius of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
radiusY – The new Y radius as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeRadiusY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector &radiusY)
Sets the Y radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y radius as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeRadiusY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const RelAbsVector &radiusY)
Sets the Y radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y radius as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeRadiusY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector &radiusY)
Sets the Y radius of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y radius as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeRadiusY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const RelAbsVector &radiusY)
Sets the Y radius of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y radius as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeRadiusYAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const double &radiusY)
Sets the Y radius of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeRadiusYAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const double &radiusY)
Sets the Y radius of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeRadiusYAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &radiusY)
Sets the Y radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeRadiusYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const double &radiusY)
Sets the Y radius of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeRadiusYAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &radiusY)
Sets the Y radius of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeRadiusYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const double &radiusY)
Sets the Y radius of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
radiusY – the new Y radius as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeNumElements(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the number of elements in the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
The number of elements as an unsigned int.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeNumElements(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the number of elements in the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
The number of elements as an unsigned int.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeNumElements(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the number of elements in the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the number of elements as an unsigned int.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeNumElements(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Returns the number of elements in the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
the number of elements as an unsigned int.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isLineEndingGeometricShapeElementCubicBezier(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Checks if the geometric shape element for the LineEnding with the given identifier is a CubicBezier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
elementIndex – An unsigned int representing the index of the element.
- Returns:
True if the element is a CubicBezier, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isLineEndingGeometricShapeElementCubicBezier(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Checks if the geometric shape element for the LineEnding with the given identifier and render index is a CubicBezier.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
elementIndex – An unsigned int representing the index of the element.
- Returns:
True if the element is a CubicBezier, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesReferenceLineEndingGeometricShapeElementCubicBezier(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Checks if the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier is a CubicBezier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
true if the element is a CubicBezier, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSpeciesReferenceLineEndingGeometricShapeElementCubicBezier(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Checks if the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is a CubicBezier.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
true if the element is a CubicBezier, false otherwise.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeElementX(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Gets the X coordinate of the geometric shape element for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
elementIndex – An unsigned int representing the index of the element.
- Returns:
The X coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeElementX(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Gets the X coordinate of the geometric shape element for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
elementIndex – An unsigned int representing the index of the element.
- Returns:
The X coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeElementX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Gets the X coordinate of the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the X coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeElementX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Gets the X coordinate of the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the X coordinate as a RelAbsVector.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeElementXAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Returns the X coordinate of the geometric shape element for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the X coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeElementXAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Returns the X coordinate of the geometric shape element for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the X coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeElementXAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Returns the X coordinate of the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the X coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeElementXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Returns the X coordinate of the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the X coordinate as a double.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeElementX(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the X coordinate of the geometric shape element for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
elementIndex – An unsigned int representing the index of the element to modify.
x – The new X coordinate as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeElementX(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the X coordinate of the geometric shape element for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
elementIndex – An unsigned int representing the index of the element to modify.
x – The new X coordinate as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeElementX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the X coordinate of the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
x – the new X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeElementX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the X coordinate of the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
x – the new X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeElementX(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the X coordinate of the geometric shape element for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
x – the new X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeElementX(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the X coordinate of the geometric shape element for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
x – the new X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeElementXAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &x)
Sets the X coordinate of the geometric shape element for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
elementIndex – an unsigned int representing the index of the element to modify.
x – the new X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeElementXAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &x)
Sets the X coordinate of the geometric shape element for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
elementIndex – an unsigned int representing the index of the element to modify.
x – the new X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeElementXAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &x)
Sets the X coordinate of the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
x – the new X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeElementXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &x)
Sets the X coordinate of the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
x – the new X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeElementXAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &x)
Sets the X coordinate of the geometric shape element for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
x – the new X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeElementXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &x)
Sets the X coordinate of the geometric shape element for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
x – the new X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeElementY(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Gets the Y coordinate of the geometric shape element for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
elementIndex – An unsigned int representing the index of the element.
- Returns:
The Y coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeElementY(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Gets the Y coordinate of the geometric shape element for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
elementIndex – An unsigned int representing the index of the element.
- Returns:
The Y coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeElementY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Gets the Y coordinate of the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the Y coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeElementY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Gets the Y coordinate of the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the Y coordinate as a RelAbsVector.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeElementYAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Returns the Y coordinate of the geometric shape element for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the Y coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeElementYAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Returns the Y coordinate of the geometric shape element for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the Y coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeElementYAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Returns the Y coordinate of the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the Y coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeElementYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Returns the Y coordinate of the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the Y coordinate as a double.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeElementY(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the Y coordinate of the geometric shape element for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
elementIndex – An unsigned int representing the index of the element to modify.
y – The new Y coordinate as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeElementY(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the Y coordinate of the geometric shape element for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
elementIndex – An unsigned int representing the index of the element to modify.
y – The new Y coordinate as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeElementY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the Y coordinate of the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
y – the new Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeElementY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the Y coordinate of the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
y – the new Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeElementY(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the Y coordinate of the geometric shape element for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
y – the new Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeElementY(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the Y coordinate of the geometric shape element for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
y – the new Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeElementYAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &y)
Sets the Y coordinate of the geometric shape element for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
elementIndex – an unsigned int representing the index of the element to modify.
y – the new Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeElementYAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &y)
Sets the Y coordinate of the geometric shape element for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
elementIndex – an unsigned int representing the index of the element to modify.
y – the new Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeElementYAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &y)
Sets the Y coordinate of the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
y – the new Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeElementYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &y)
Sets the Y coordinate of the geometric shape element for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
y – the new Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeElementYAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &y)
Sets the Y coordinate of the geometric shape element for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
y – the new Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeElementYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &y)
Sets the Y coordinate of the geometric shape element for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
y – the new Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeBasePoint1X(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Gets the base point 1 X coordinate of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape, defaulting to 0.
elementIndex – An unsigned int representing the index of the element, defaulting to 0.
- Returns:
The base point 1 X coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeBasePoint1X(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Gets the base point 1 X coordinate of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape, defaulting to 0.
elementIndex – An unsigned int representing the index of the element, defaulting to 0.
- Returns:
The base point 1 X coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeBasePoint1X(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Gets the base point 1 X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the base point 1 X coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeBasePoint1X(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Gets the base point 1 X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the base point 1 X coordinate as a RelAbsVector.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Returns the base point 1 X coordinate of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape, defaulting to 0.
elementIndex – an unsigned int representing the index of the element, defaulting to 0.
- Returns:
the base point 1 X coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Returns the base point 1 X coordinate of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape, defaulting to 0.
elementIndex – an unsigned int representing the index of the element, defaulting to 0.
- Returns:
the base point 1 X coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Returns the base point 1 X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the base point 1 X coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Returns the base point 1 X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the base point 1 X coordinate as a double.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeBasePoint1X(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint1X)
Sets the base point 1 X coordinate of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
elementIndex – An unsigned int representing the index of the element to modify.
basePoint1X – The new base point 1 X coordinate as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeBasePoint1X(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint1X)
Sets the base point 1 X coordinate of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
elementIndex – An unsigned int representing the index of the element to modify.
basePoint1X – The new base point 1 X coordinate as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeBasePoint1X(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint1X)
Sets the base point 1 X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint1X – the new base point 1 X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeBasePoint1X(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint1X)
Sets the base point 1 X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint1X – the new base point 1 X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeBasePoint1X(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint1X)
Sets the base point 1 X coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint1X – the new base point 1 X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeBasePoint1X(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint1X)
Sets the base point 1 X coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint1X – the new base point 1 X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint1X)
Sets the base point 1 X coordinate of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
elementIndex – an unsigned int representing the index of the element to modify.
basePoint1X – the new base point 1 X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint1X)
Sets the base point 1 X coordinate of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
elementIndex – an unsigned int representing the index of the element to modify.
basePoint1X – the new base point 1 X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint1X)
Sets the base point 1 X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint1X – the new base point 1 X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint1X)
Sets the base point 1 X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint1X – the new base point 1 X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint1X)
Sets the base point 1 X coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint1X – the new base point 1 X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint1X)
Sets the base point 1 X coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint1X – the new base point 1 X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeBasePoint1Y(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Gets the base point 1 Y coordinate of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape, defaulting to 0.
elementIndex – An unsigned int representing the index of the element, defaulting to 0.
- Returns:
The base point 1 Y coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeBasePoint1Y(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Gets the base point 1 Y coordinate of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape, defaulting to 0.
elementIndex – An unsigned int representing the index of the element, defaulting to 0.
- Returns:
The base point 1 Y coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeBasePoint1Y(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Gets the base point 1 Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the base point 1 Y coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeBasePoint1Y(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Gets the base point 1 Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the base point 1 Y coordinate as a RelAbsVector.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Returns the base point 1 Y coordinate of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape, defaulting to 0.
elementIndex – an unsigned int representing the index of the element, defaulting to 0.
- Returns:
the base point 1 Y coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Returns the base point 1 Y coordinate of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape, defaulting to 0.
elementIndex – an unsigned int representing the index of the element, defaulting to 0.
- Returns:
the base point 1 Y coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Returns the base point 1 Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the base point 1 Y coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Returns the base point 1 Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the base point 1 Y coordinate as a double.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeBasePoint1Y(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint1Y)
Sets the base point 1 Y coordinate of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
elementIndex – An unsigned int representing the index of the element to modify.
basePoint1Y – The new base point 1 Y coordinate as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeBasePoint1Y(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint1Y)
Sets the base point 1 Y coordinate of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
elementIndex – An unsigned int representing the index of the element to modify.
basePoint1Y – The new base point 1 Y coordinate as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeBasePoint1Y(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint1Y)
Sets the base point 1 Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint1Y – the new base point 1 Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeBasePoint1Y(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint1Y)
Sets the base point 1 Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint1Y – the new base point 1 Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeBasePoint1Y(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint1Y)
Sets the base point 1 Y coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint1Y – the new base point 1 Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeBasePoint1Y(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint1Y)
Sets the base point 1 Y coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint1Y – the new base point 1 Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint1Y)
Sets the base point 1 Y coordinate of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
elementIndex – an unsigned int representing the index of the element to modify.
basePoint1Y – the new base point 1 Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint1Y)
Sets the base point 1 Y coordinate of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
elementIndex – an unsigned int representing the index of the element to modify.
basePoint1Y – the new base point 1 Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint1Y)
Sets the base point 1 Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint1Y – the new base point 1 Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint1Y)
Sets the base point 1 Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint1Y – the new base point 1 Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint1Y)
Sets the base point 1 Y coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint1Y – the new base point 1 Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint1Y)
Sets the base point 1 Y coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint1Y – the new base point 1 Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeBasePoint2X(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Gets the base point 2 X coordinate of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape, defaulting to 0.
elementIndex – An unsigned int representing the index of the element, defaulting to 0.
- Returns:
The base point 2 X coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeBasePoint2X(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Gets the base point 2 X coordinate of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape, defaulting to 0.
elementIndex – An unsigned int representing the index of the element, defaulting to 0.
- Returns:
The base point 2 X coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeBasePoint2X(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Gets the base point 2 X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the base point 2 X coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeBasePoint2X(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Gets the base point 2 X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the base point 2 X coordinate as a RelAbsVector.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Returns the base point 2 X coordinate of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape, defaulting to 0.
elementIndex – an unsigned int representing the index of the element, defaulting to 0.
- Returns:
the base point 2 X coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Returns the base point 2 X coordinate of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape, defaulting to 0.
elementIndex – an unsigned int representing the index of the element, defaulting to 0.
- Returns:
the base point 2 X coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Returns the base point 2 X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the base point 2 X coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Returns the base point 2 X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the base point 2 X coordinate as a double.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeBasePoint2X(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint2X)
Sets the base point 2 X coordinate of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
elementIndex – An unsigned int representing the index of the element to modify.
basePoint2X – The new base point 2 X coordinate as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeBasePoint2X(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint2X)
Sets the base point 2 X coordinate of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
elementIndex – An unsigned int representing the index of the element to modify.
basePoint2X – The new base point 2 X coordinate as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeBasePoint2X(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint2X)
Sets the base point 2 X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint2X – the new base point 2 X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeBasePoint2X(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint2X)
Sets the base point 2 X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint2X – the new base point 2 X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeBasePoint2X(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint2X)
Sets the base point 2 X coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint2X – the new base point 2 X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeBasePoint2X(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint2X)
Sets the base point 2 X coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint2X – the new base point 2 X coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint2X)
Sets the base point 2 X coordinate of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
elementIndex – an unsigned int representing the index of the element to modify.
basePoint2X – the new base point 2 X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint2X)
Sets the base point 2 X coordinate of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
elementIndex – an unsigned int representing the index of the element to modify.
basePoint2X – the new base point 2 X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint2X)
Sets the base point 2 X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint2X – the new base point 2 X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint2X)
Sets the base point 2 X coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint2X – the new base point 2 X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint2X)
Sets the base point 2 X coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint2X – the new base point 2 X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint2X)
Sets the base point 2 X coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint2X – the new base point 2 X coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeBasePoint2Y(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Gets the base point 2 Y coordinate of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape, defaulting to 0.
elementIndex – An unsigned int representing the index of the element, defaulting to 0.
- Returns:
The base point 2 Y coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeBasePoint2Y(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Gets the base point 2 Y coordinate of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape, defaulting to 0.
elementIndex – An unsigned int representing the index of the element, defaulting to 0.
- Returns:
The base point 2 Y coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeBasePoint2Y(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Gets the base point 2 Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the base point 2 Y coordinate as a RelAbsVector.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeBasePoint2Y(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Gets the base point 2 Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the base point 2 Y coordinate as a RelAbsVector.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeBasePoint2YAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Returns the base point 2 Y coordinate of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape, defaulting to 0.
elementIndex – an unsigned int representing the index of the element, defaulting to 0.
- Returns:
the base point 2 Y coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeBasePoint2YAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Returns the base point 2 Y coordinate of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding.
geometricShapeIndex – an unsigned int representing the index of the geometric shape, defaulting to 0.
elementIndex – an unsigned int representing the index of the element, defaulting to 0.
- Returns:
the base point 2 Y coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeBasePoint2YAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Returns the base point 2 Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the base point 2 Y coordinate as a double.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesReferenceLineEndingGeometricShapeBasePoint2YAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex)
Returns the base point 2 Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
- Returns:
the base point 2 Y coordinate as a double.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeBasePoint2Y(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint2Y)
Sets the base point 2 Y coordinate of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
elementIndex – An unsigned int representing the index of the element to modify.
basePoint2Y – The new base point 2 Y coordinate as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeBasePoint2Y(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint2Y)
Sets the base point 2 Y coordinate of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
elementIndex – An unsigned int representing the index of the element to modify.
basePoint2Y – The new base point 2 Y coordinate as a RelAbsVector.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeBasePoint2Y(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint2Y)
Sets the base point 2 Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint2Y – the new base point 2 Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeBasePoint2Y(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint2Y)
Sets the base point 2 Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint2Y – the new base point 2 Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeBasePoint2Y(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint2Y)
Sets the base point 2 Y coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint2Y – the new base point 2 Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeBasePoint2Y(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &basePoint2Y)
Sets the base point 2 Y coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint2Y – the new base point 2 Y coordinate as a RelAbsVector.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeBasePoint2YAsDouble(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint2Y)
Sets the base point 2 Y coordinate of the geometric shape for the LineEnding with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
elementIndex – an unsigned int representing the index of the element to modify.
basePoint2Y – the new base point 2 Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeBasePoint2YAsDouble(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint2Y)
Sets the base point 2 Y coordinate of the geometric shape for the LineEnding with the given identifier and render index as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – a string representing the identifier of the LineEnding to modify.
geometricShapeIndex – an unsigned int representing the index of the geometric shape to modify.
elementIndex – an unsigned int representing the index of the element to modify.
basePoint2Y – the new base point 2 Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeBasePoint2YAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint2Y)
Sets the base point 2 Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint2Y – the new base point 2 Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeBasePoint2YAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint2Y)
Sets the base point 2 Y coordinate of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint2Y – the new base point 2 Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeBasePoint2YAsDouble(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint2Y)
Sets the base point 2 Y coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint2Y – the new base point 2 Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeBasePoint2YAsDouble(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &basePoint2Y)
Sets the base point 2 Y coordinate of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
elementIndex – an unsigned int representing the index of the element.
basePoint2Y – the new base point 2 Y coordinate as a double.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeHref(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the Href attribute of the geometric shape for the LineEnding with the given identifier is set.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
True if the Href attribute is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetLineEndingGeometricShapeHref(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Checks if the Href attribute of the geometric shape for the LineEnding with the given identifier and render index is set.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
True if the Href attribute is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeHref(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the Href attribute of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier is set.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
True if the Href attribute is set, false otherwise.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetSpeciesReferenceLineEndingGeometricShapeHref(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex)
Checks if the Href attribute of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in the Layout with the given index of the SBML document is set.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
- Returns:
True if the Href attribute is set, false otherwise.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeHref(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the Href attribute of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
The Href attribute as a string.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingGeometricShapeHref(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex = 0)
Gets the Href attribute of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding.
geometricShapeIndex – An unsigned int representing the index of the geometric shape.
- Returns:
The Href attribute as a string.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeHref(SBMLDocument *document, const std::string &id, unsigned int geometricShapeIndex, const std::string &href)
Sets the Href attribute of the geometric shape for the LineEnding with the given identifier.
- Parameters:
document – A pointer to the SBMLDocument object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
href – The new Href attribute as a string.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingGeometricShapeHref(SBMLDocument *document, unsigned int renderIndex, const std::string &id, unsigned int geometricShapeIndex, const std::string &href)
Sets the Href attribute of the geometric shape for the LineEnding with the given identifier and render index.
- Parameters:
document – A pointer to the SBMLDocument object.
renderIndex – The index number of the RenderInformationBase object.
id – A string representing the identifier of the LineEnding to modify.
geometricShapeIndex – An unsigned int representing the index of the geometric shape to modify.
href – The new Href attribute as a string.
- Returns:
An integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeHref(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const std::string &href)
Sets the Href attribute of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
href – the new Href attribute as a string.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesReferenceLineEndingGeometricShapeHref(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int speciesReferenceIndex, unsigned int geometricShapeIndex, const std::string &href)
Sets the Href attribute of the geometric shape for the LineEnding associated with the SpeciesReferenceGlyph with the given index of the reaction glyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
speciesReferenceIndex – the index number of the SpeciesReference object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
href – the new Href attribute as a string.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeHref(SBMLDocument *document, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const std::string &href)
Sets the Href attribute of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier.
- Parameters:
document – a pointer to the SBMLDocument object.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
href – the new Href attribute as a string.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionLineEndingGeometricShapeHref(SBMLDocument *document, unsigned int layoutIndex, const std::string &reactionId, unsigned int reactionGlyphIndex, unsigned int geometricShapeIndex, const std::string &href)
Sets the Href attribute of the geometric shape for the LineEnding associated with the ReactionGlyph with the given index of the reaction with the given identifier in 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.
reactionId – a string representing the identifier of the Reaction object.
reactionGlyphIndex – the index number of the ReactionGlyph object.
geometricShapeIndex – an unsigned int representing the index of the geometric shape.
href – the new Href attribute as a string.
- Returns:
an integer indicating success (0) or failure (non-zero).
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getStyle(SBMLDocument *document, GraphicalObject *graphicalObject)
Searches among the styles of the first render information base in the SBML document and returns one that matches this GraphicalObject attributes.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getLocalStyle(SBMLDocument *document, GraphicalObject *graphicalObject)
Searches among the local styles of the first render information base in the SBML document and returns one that matches this GraphicalObject attributes.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getGlobalStyle(SBMLDocument *document, GraphicalObject *graphicalObject)
Searches among the global styles of the first render information base in the SBML document and returns one that matches this GraphicalObject attributes.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
a pointer to the found Style object.
Warning
doxygenfunction: Unable to resolve function “LIBSBMLNETWORK_CPP_NAMESPACE::getTextGlyphGlobalStyle” with arguments “(SBMLDocument*, GraphicalObject*)”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 22] LIBSBMLNETWORK_EXTERN Style * getTextGlyphGlobalStyle (SBMLDocument *document, unsigned int renderIndex, GraphicalObject *graphicalObject) ———————-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected ‘::’ in pointer to member (function). [error at 28] LIBSBMLNETWORK_EXTERN Style * getTextGlyphGlobalStyle (SBMLDocument *document, unsigned int renderIndex, GraphicalObject *graphicalObject) —————————-^ If declarator-id: Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 28] LIBSBMLNETWORK_EXTERN Style * getTextGlyphGlobalStyle (SBMLDocument *document, unsigned int renderIndex, GraphicalObject *graphicalObject) —————————-^
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::createLocalStyle(SBMLDocument *document, GraphicalObject *graphicalObject)
Creates a new Style object with the given GraphicalObject attributes and adds it to the styles of the first local render information in the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
a pointer to the created Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::createLocalStyle(SBMLDocument *document, TextGlyph *textGlyph, GraphicalObject *graphicalObject)
Creates a new Style object with the given GraphicalObject attributes and adds it to the styles of the first local render information in the SBML document for this TextGlyph object.
- Parameters:
document – a pointer to the SBMLDocument object.
textGlyph – a pointer to the TextGlyph object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
a pointer to the created Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getStyle(SBMLDocument *document, unsigned int renderIndex, GraphicalObject *graphicalObject)
Searches among the styles of the render information base with the given index of the SBML document and returns one that matches this GraphicalObject attributes.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getLocalStyle(SBMLDocument *document, unsigned int renderIndex, GraphicalObject *graphicalObject)
Searches among the local styles of the render information base with the given index of the SBML document and returns one that matches this GraphicalObject attributes.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getGlobalStyle(SBMLDocument *document, unsigned int renderIndex, GraphicalObject *graphicalObject)
Searches among the global styles of the render information base with the given index of the SBML document and returns one that matches this GraphicalObject attributes.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::createLocalStyle(SBMLDocument *document, unsigned int renderIndex, GraphicalObject *graphicalObject)
Creates a new Style object with the given GraphicalObject attributes and adds it to the styles of the local render information with the given index in the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
a pointer to the created Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getStyle(SBMLDocument *document, const std::string &attribute)
Searches among the styles of the first render information base in the SBML document and returns one that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getLocalStyle(SBMLDocument *document, const std::string &attribute)
Searches among the local styles of the first render information base in the SBML document and returns one that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getGlobalStyle(SBMLDocument *document, const std::string &attribute)
Searches among the global styles of the first render information base in the SBML document and returns one that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::createLocalStyle(SBMLDocument *document, const std::string &attribute)
Creates a new Style object with the given attribute and adds it to the styles of the first local render information in the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
a pointer to the created Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getStyle(SBMLDocument *document, unsigned int renderIndex, const std::string &attribute)
Searches among the styles of the render information base with the given index of the SBML document and returns one that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getLocalStyle(SBMLDocument *document, unsigned int renderIndex, const std::string &attribute)
Searches among the local styles of the render information base with the given index of the SBML document and returns one that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getGlobalStyle(SBMLDocument *document, unsigned int renderIndex, const std::string &attribute)
Searches among the global styles of the render information base with the given index of the SBML document and returns one that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::createLocalStyle(SBMLDocument *document, unsigned int renderIndex, const std::string &attribute)
Creates a new Style object with the given attribute and adds it to the styles of the local render information with the given index in the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
a pointer to the created Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getStyleById(SBMLDocument *document, GraphicalObject *graphicalObject)
Searches among the styles of the first render information base in the SBML document and returns one contains the “id” in its idlist.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getStyleById(SBMLDocument *document, unsigned int renderIndex, GraphicalObject *graphicalObject)
Searches among the styles of the render information base with the given index of the SBML document and returns one contains the “id” in its idlist.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getStyleById(SBMLDocument *document, const std::string &id)
Searches among the styles of the first render information base in the SBML document and returns one contains the “id” in its idlist.
- Parameters:
document – a pointer to the SBMLDocument object.
id – the id attribute of a GraphicalObject.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getStyleById(SBMLDocument *document, unsigned int renderIndex, const std::string &id)
Searches among the styles of the render information base with the given index of the SBML document and returns one contains the “id” in its idlist.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
id – the id attribute of a GraphicalObject.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getStyleByRole(SBMLDocument *document, GraphicalObject *graphicalObject)
Searches among the styles of the first render information base in the SBML document and returns one contains the “role” in its rolelist.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getStyleByRole(SBMLDocument *document, unsigned int renderIndex, GraphicalObject *graphicalObject)
Searches among the styles of the render information base with the given index of the SBML document and returns one contains the “role” in its rolelist.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getStyleByRole(SBMLDocument *document, const std::string &role)
Searches among the styles of the first render information base in the SBML document and returns one contains the “role” in its rolelist.
- Parameters:
document – a pointer to the SBMLDocument object.
role – the role attribute of a GraphicalObject.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getStyleByRole(SBMLDocument *document, unsigned int renderIndex, const std::string &role)
Searches among the styles of the render information base with the given index of the SBML document and returns one contains the “role” in its rolelist.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
role – the role attribute of a GraphicalObject.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getStyleByType(SBMLDocument *document, GraphicalObject *graphicalObject)
Searches among the styles of the first render information base in the SBML document and returns one contains the “type” in its typelist.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getStyleByType(SBMLDocument *document, unsigned int renderIndex, GraphicalObject *graphicalObject)
Searches among the styles of the render information base with the given index of the SBML document and returns one contains the “type” in its typelist.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getStyleByType(SBMLDocument *document, const std::string &type)
Searches among the styles of the first render information base in the SBML document and returns one contains the “type” in its typelist.
- Parameters:
document – a pointer to the SBMLDocument object.
type – the type attribute of a GraphicalObject.
- Returns:
a pointer to the found Style object.
-
Style *LIBSBMLNETWORK_CPP_NAMESPACE::getStyleByType(SBMLDocument *document, unsigned int renderIndex, const std::string &type)
Searches among the styles of the render information base with the given index of the SBML document and returns one contains the “type” in its typelist.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
type – the type attribute of a GraphicalObject.
- Returns:
a pointer to the found Style object.
-
RenderGroup *LIBSBMLNETWORK_CPP_NAMESPACE::getRenderGroup(SBMLDocument *document, GraphicalObject *graphicalObject)
Returns the value of the “group” element of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
the value of the “group” element of the Style for this GraphicalObjet as a RenderGroup, or
NULLif the object isNULL
-
RenderGroup *LIBSBMLNETWORK_CPP_NAMESPACE::getRenderGroup(SBMLDocument *document, unsigned int renderIndex, GraphicalObject *graphicalObject)
Returns the value of the “group” element of the Style for this GraphicalObject in the render information base with the givne index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
the value of the “group” element of the Style for this GraphicalObjet as a RenderGroup, or
NULLif the object isNULL
-
RenderGroup *LIBSBMLNETWORK_CPP_NAMESPACE::getRenderGroup(SBMLDocument *document, const std::string &attribute)
Returns the value of the “group” element of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
a pointer to the found Style object.
-
RenderGroup *LIBSBMLNETWORK_CPP_NAMESPACE::getRenderGroup(SBMLDocument *document, unsigned int renderIndex, const std::string &attribute)
Returns the value of the “group” element of the Style that matches this attribute (id, role, type) of a GraphicalObject in the render information base with the givne index of the SBML document.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the RenderInformationBase object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
a pointer to the found Style object.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetStrokeColor(SBMLDocument *document, GraphicalObject *graphicalObject)
Predicates returning
trueif the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
trueif the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “stroke” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetStrokeColor(SBMLDocument *document, const std::string &attribute)
Predicates returning
trueif the “stroke” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
trueif the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “stroke” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getStrokeColor(SBMLDocument *document, GraphicalObject *graphicalObject)
Returns the value of the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject object, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getStrokeColor(SBMLDocument *document, const std::string &attribute)
Returns the value of the “stroke” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setStrokeColor(SBMLDocument *document, GraphicalObject *graphicalObject, const std::string &stroke)
Sets the value of the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
stroke – a string value to use as the value of the “stroke” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setStrokeColor(SBMLDocument *document, const std::string &attribute, const std::string &stroke)
Sets the value of the “stroke” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
stroke – a string value to use as the value of the “stroke” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentStrokeColor(const SBMLDocument *document)
Returns the value of the “stroke” attribute of the RenderGroup of the Style for the Compartment.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “stroke” attribute of the RenderGroup of the Style for the Compartment, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentStrokeColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &stroke)
Sets the value of the “stroke” attribute of the RenderGroup of the Style for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
stroke – a string value to use as the value of the “stroke” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesStrokeColor(const SBMLDocument *document)
Returns the value of the “stroke” attribute of the RenderGroup of the Style for the Species.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “stroke” attribute of the RenderGroup of the Style for the Species, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesStrokeColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &stroke)
Sets the value of the “stroke” attribute of the RenderGroup of the Style for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
stroke – a string value to use as the value of the “stroke” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getReactionStrokeColor(const SBMLDocument *document)
Returns the value of the “stroke” attribute of the RenderGroup of the Style for the Reaction.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “stroke” attribute of the RenderGroup of the Style for the Reaction, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionStrokeColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &stroke, bool setSpeciesReferenceGlyphs = true)
Sets the value of the “stroke” attribute of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
stroke – a string value to use as the value of the “stroke” attribute of the RenderGroup of these Style objects.
setSpeciesReferenceGlyphs – a boolean value to indicate whether to set the “stroke” attribute of the RenderGroup of the Style for SpeciesReferenceGlyph objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingStrokeColor(SBMLDocument *document, unsigned int layoutIndex)
Returns the value of the “stroke” attribute of the RenderGroup of LineEnding objects, if they share the same “stroke”.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
- Returns:
the “stroke” attribute of the RenderGroup of LineEnding objects, or
""if the object isNULLor they don’t share the same “stroke”.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingStrokeColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &stroke)
Sets the value of the “stroke” attribute of the RenderGroup of all LineEnding objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
stroke – a string value to use as the value of the “stroke” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setStrokeColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &stroke)
Sets the value of the “stroke” attribute of the RenderGroup of the Style for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
stroke – a string value to use as the value of the “stroke” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getEmptySpeciesStrokeColor(const SBMLDocument *document)
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEmptySpeciesStrokeColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &stroke)
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetStrokeWidth(SBMLDocument *document, GraphicalObject *graphicalObject)
Predicates returning
trueif the “stroke-width” attribute of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
trueif the “stroke-width” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “stroke-width” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetStrokeWidth(SBMLDocument *document, const std::string &attribute)
Predicates returning
trueif the “stroke-width” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
trueif the “stroke-width” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “stroke-width” attribute is not set or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getStrokeWidth(SBMLDocument *document, GraphicalObject *graphicalObject)
Returns the value of the “stroke-width” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
the “stroke-width” attribute of the RenderGroup of the Style for this GraphicalObject object, or
0.0if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getStrokeWidth(SBMLDocument *document, const std::string &attribute)
Returns the value of the “stroke-width” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
the “stroke-width” attribute of the RenderGroup of the Style for this GraphicalObject, or
0.0if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setStrokeWidth(SBMLDocument *document, GraphicalObject *graphicalObject, const double &strokeWidth)
Sets the value of the “stroke-width” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
strokeWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setStrokeWidth(SBMLDocument *document, const std::string &attribute, const double &strokeWidth)
Sets the value of the “stroke-width” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
strokeWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentStrokeWidth(const SBMLDocument *document)
Returns the value of the “stroke-width” attribute of the RenderGroup of the Style for the Compartment.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “stroke-width” attribute of the RenderGroup of the Style for the Compartment, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentStrokeWidth(SBMLDocument *document, unsigned int layoutIndex, const double &strokeWidth)
Sets the value of the “stroke-width” attribute of the RenderGroup of the Style for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
strokeWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesStrokeWidth(SBMLDocument *document)
Returns the value of the “stroke-width” attribute of the RenderGroup of the Style for the Species.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “stroke-width” attribute of the RenderGroup of the Style for the Species, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesStrokeWidth(SBMLDocument *document, unsigned int layoutIndex, const double &strokeWidth)
Sets the value of the “stroke-width” attribute of the RenderGroup of the Style for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
strokeWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionStrokeWidth(SBMLDocument *document)
Returns the value of the “stroke-width” attribute of the RenderGroup of the Style for the Reaction.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “stroke-width” attribute of the RenderGroup of the Style for the Reaction, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionStrokeWidth(SBMLDocument *document, unsigned int layoutIndex, const double &strokeWidth, bool setSpeciesReferenceGlyphs = true)
Sets the value of the “stroke-width” attribute of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
strokeWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of these Style objects.
setSpeciesReferenceGlyphs – a boolean value to indicate whether to set the “stroke-width” attribute of the RenderGroup of the Style for SpeciesReferenceGlyph objects.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingStrokeWidth(SBMLDocument *document, unsigned int layoutIndex = 0)
Returns the value of the “stroke-width” attribute of the RenderGroup of LineEnding objects, if they share the same “stroke-width”.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
- Returns:
the “stroke-width” attribute of the RenderGroup of LineEnding objects, or
nanif the object isNULLor they don’t share the same “stroke-width”.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingStrokeWidth(SBMLDocument *document, unsigned int layoutIndex, const double &strokeWidth)
Sets the value of the “stroke-width” attribute of the RenderGroup of all LineEnding objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
strokeWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setStrokeWidth(SBMLDocument *document, unsigned int layoutIndex, const double &strokeWidth)
Sets the value of the “stroke-width” attribute of the RenderGroup of the Style for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
strokeWidth – a double value to use as the value of the “stroke-width” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getEmptySpeciesStrokeWidth(const SBMLDocument *document)
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEmptySpeciesStrokeWidth(SBMLDocument *document, unsigned int layoutIndex, const double &strokeWidth)
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetStrokeDashArray(SBMLDocument *document, GraphicalObject *graphicalObject)
Predicates returning
trueif the “stroke-dasharray” attribute of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
trueif the “stroke-dasharray” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “stroke-dasharray” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetStrokeDashArray(SBMLDocument *document, const std::string &attribute)
Predicates returning
trueif the “stroke-dasharray” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
trueif the “stroke-dasharray” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “stroke-dasharray” attribute is not set or the object isNULL.
-
const std::vector<unsigned int> LIBSBMLNETWORK_CPP_NAMESPACE::getStrokeDashArray(SBMLDocument *document, GraphicalObject *graphicalObject)
Returns the value of the “stroke-dasharray” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
the “stroke-dasharray” attribute of the RenderGroup of the Style for this GraphicalObject object, or an empty vector if the object is
NULL
-
const std::vector<unsigned int> LIBSBMLNETWORK_CPP_NAMESPACE::getStrokeDashArray(SBMLDocument *document, const std::string &attribute)
Returns the value of the “stroke-dasharray” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
the “stroke-dasharray” attribute of the RenderGroup of the Style for this GraphicalObject, or an empty vector if the object is
NULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setStrokeDashArray(SBMLDocument *document, GraphicalObject *graphicalObject, const std::vector<unsigned int> &strokeDashArray)
Sets the value of the “stroke-dasharray” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
strokeDashArray – a vector to use as the value of the “stroke-dasharray” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setStrokeDashArray(SBMLDocument *document, const std::string &attribute, const std::vector<unsigned int> &strokeDashArray)
Sets the value of the “stroke-dasharray” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
strokeDashArray – a vector to use as the value of the “stroke-dasharray” attribute of the the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumStrokeDashes(SBMLDocument *document, GraphicalObject *graphicalObject)
Returns the size of the “stroke-dasharray” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
the size of the “stroke-dasharray” attribute of the RenderGroup of the Style for this GraphicalObject object, or
""if the object isNULL
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumStrokeDashes(SBMLDocument *document, const std::string &attribute)
Returns the size of the “stroke-dasharray” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
the size of the “stroke-dasharray” attribute of the RenderGroup of the Style for this GraphicalObject, or
""if the object isNULL
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getStrokeDash(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int dashIndex = 0)
Returns the stroke dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
dashIndex – an unsigned int representing the index of the stroke dash to retrieve.
- Returns:
the stroke dash at the given index of “stroke-dasharray” attribute of the RenderGroup of the Style for this GraphicalObject object,
0if the object isNULL
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getStrokeDash(SBMLDocument *document, const std::string &attribute, unsigned int dashIndex = 0)
Returns the stroke dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
dashIndex – an unsigned int representing the index of the stroke dash to retrieve.
- Returns:
the stroke dash at the given index of “stroke-dasharray” attribute of the RenderGroup of the Style for this GraphicalObject, or
0if the object isNULL
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::setStrokeDash(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int dash)
Sets the first dash of the ‘stroke-dasharray’ attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
dash – a unsigned int value to use as the first dash of the ‘stroke-dasharray’ attribute of of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::setStrokeDash(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int dashIndex, unsigned int dash)
Sets the dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
dashIndex – an unsigned int representing the index of the stroke dash to retrieve.
dash – a unsigned int value to use as the dash at the given index of the ‘stroke-dasharray’ attribute of of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::setStrokeDash(SBMLDocument *document, const std::string &attribute, unsigned int dash)
Sets the first dash of the ‘stroke-dasharray’ attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
dash – a unsigned int value to use as the first dash of the ‘stroke-dasharray’ attribute of of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::setStrokeDash(SBMLDocument *document, const std::string &attribute, unsigned int dashIndex, unsigned int dash)
Sets the dash at the given index of the ‘stroke-dasharray’ attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
dashIndex – an unsigned int representing the index of the stroke dash to retrieve.
dash – a unsigned int value to use as the dash at the given index of the ‘stroke-dasharray’ attribute of of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetFontColor(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex = 0)
Predicates returning
trueif the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
trueif the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “stroke” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetFontColor(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex = 0)
Predicates returning
trueif the “stroke” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
trueif the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “stroke” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getFontColor(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex = 0)
Returns the value of the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject object, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getFontColor(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex = 0)
Returns the value of the “stroke” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontColor(SBMLDocument *document, GraphicalObject *graphicalObject, const std::string &fontColor)
Sets the value of the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
fontColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontColor(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex, const std::string &fontColor)
Sets the value of the “stroke” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
fontColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontColor(SBMLDocument *document, const std::string &attribute, const std::string &fontColor)
Sets the value of the “stroke” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
fontColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontColor(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex, const std::string &fontColor)
Sets the value of the “stroke” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
fontColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentFontColor(SBMLDocument *document)
Returns the value of the “stroke” attribute of the RenderGroup of the Style for the Compartment.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “stroke” attribute of the RenderGroup of the Style for the Compartment, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentFontColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontColor)
Sets the value of the “stroke” attribute of the RenderGroup of the Style for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesFontColor(SBMLDocument *document)
Returns the value of the “stroke” attribute of the RenderGroup of the Style for the Species.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “stroke” attribute of the RenderGroup of the Style for the Species, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesFontColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontColor)
Sets the value of the “stroke” attribute of the RenderGroup of the Style for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getReactionFontColor(SBMLDocument *document)
Returns the value of the “stroke” attribute of the RenderGroup of the Style for the Reaction.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “stroke” attribute of the RenderGroup of the Style for the Reaction, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionFontColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontColor)
Sets the value of the “stroke” attribute of the RenderGroup of the Style for all ReactionGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontColor)
Sets the value of the “stroke” attribute of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontColor – a string value to use as the value of the “stroke” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getEmptySpeciesFontColor(const SBMLDocument *document)
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEmptySpeciesFontColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontColor)
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetFontFamily(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex = 0)
Predicates returning
trueif the “font-family” attribute of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
trueif the “font-family” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “font-family” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetFontFamily(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex = 0)
Predicates returning
trueif the “font-family” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
trueif the “font-family” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “font-family” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getFontFamily(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex = 0)
Returns the value of the “font-family” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
the “font-family” attribute of the RenderGroup of the Style for this GraphicalObject object, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getFontFamily(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex = 0)
Returns the value of the “font-family” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
the “font-family” attribute of the RenderGroup of the Style for this GraphicalObject, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontFamily(SBMLDocument *document, GraphicalObject *graphicalObject, const std::string &fontFamily)
Sets the value of the “font-family” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
fontFamily – a string value to use as the value of the “font-family” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontFamily(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex, const std::string &fontFamily)
Sets the value of the “font-family” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
fontFamily – a string value to use as the value of the “font-family” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontFamily(SBMLDocument *document, const std::string &attribute, const std::string &fontFamily)
Sets the value of the “font-family” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
fontFamily – a string value to use as the value of the “font-family” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontFamily(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex, const std::string &fontFamily)
Sets the value of the “font-family” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
fontFamily – a string value to use as the value of the “font-family” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentFontFamily(SBMLDocument *document)
Returns the value of the “font-family” attribute of the RenderGroup of the Style for the Compartment.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “font-family” attribute of the RenderGroup of the Style for the Compartment, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentFontFamily(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontFamily)
Sets the value of the “font-family” attribute of the RenderGroup of the Style for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontFamily – a string value to use as the value of the “font-family” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesFontFamily(SBMLDocument *document)
Returns the value of the “font-family” attribute of the RenderGroup of the Style for the Species.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “font-family” attribute of the RenderGroup of the Style for the Species, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesFontFamily(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontFamily)
Sets the value of the “font-family” attribute of the RenderGroup of the Style for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontFamily – a string value to use as the value of the “font-family” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getReactionFontFamily(SBMLDocument *document)
Returns the value of the “font-family” attribute of the RenderGroup of the Style for the Reaction.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “font-family” attribute of the RenderGroup of the Style for the Reaction, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionFontFamily(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontFamily)
Sets the value of the “font-family” attribute of the RenderGroup of the Style for all ReactionGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontFamily – a string value to use as the value of the “font-family” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontFamily(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontFamily)
Sets the value of the “font-family” attribute of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontFamily – a string value to use as the value of the “font-family” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getEmptySpeciesFontFamily(const SBMLDocument *document)
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEmptySpeciesFontFamily(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontFamily)
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetFontSize(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex = 0)
Predicates returning
trueif the “font-size” attribute of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
trueif the “font-size” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “font-size” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetFontSize(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex = 0)
Predicates returning
trueif the “font-size” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
trueif the “font-size” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “font-size” attribute is not set or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getFontSize(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex = 0)
Returns the value of the “font-size” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
the “font-size” attribute of the RenderGroup of the Style for this GraphicalObject object, or
RelAbsVector()if the object isNULL
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getFontSize(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex = 0)
Returns the value of the “font-size” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
the “font-size” attribute of the RenderGroup of the Style for this GraphicalObject, or
RelAbsVector()if the object isNULL
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getFontSizeAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex = 0)
Returns the value of the “font-size” attribute of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
the “font-size” attribute of the RenderGroup of the Style for this GraphicalObject as a double, or 0.0 if the object is NULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getFontSizeAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex = 0)
Returns the value of the “font-size” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
the “font-size” attribute of the RenderGroup of the Style for this GraphicalObject as a double, or 0.0 if the object is NULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontSize(SBMLDocument *document, GraphicalObject *graphicalObject, const RelAbsVector &fontSize)
Sets the value of the “font-size” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
fontSize – a RelAbsVector value to use as the value of the “font-size” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontSize(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex, const RelAbsVector &fontSize)
Sets the value of the “font-size” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
fontSize – a RelAbsVector value to use as the value of the “font-size” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontSize(SBMLDocument *document, const std::string &attribute, const RelAbsVector &fontSize)
Sets the value of the “font-size” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
fontSize – a RelAbsVector to use as the value of the “font-size” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontSize(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex, const RelAbsVector &fontSize)
Sets the value of the “font-size” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
fontSize – a RelAbsVector to use as the value of the “font-size” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontSizeAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, const double &fontSize)
Sets the value of the “font-size” attribute of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
fontSize – a double value to use as the value of the “font-size” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontSizeAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex, const double &fontSize)
Sets the value of the “font-size” attribute of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
fontSize – a double value to use as the value of the “font-size” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontSizeAsDouble(SBMLDocument *document, const std::string &attribute, const double &fontSize)
Sets the value of the “font-size” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
fontSize – a double value to use as the value of the “font-size” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontSizeAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex, const double &fontSize)
Sets the value of the “font-size” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
fontSize – a double value to use as the value of the “font-size” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentFontSize(SBMLDocument *document)
Returns the value of the “font-size” attribute of the RenderGroup of the Style for the Compartment.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “font-size” attribute of the RenderGroup of the Style for the Compartment, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentFontSize(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &fontSize)
Sets the value of the “font-size” attribute of the RenderGroup of the Style for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontSize – a RelAbsVector value to use as the value of the “font-size” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentFontSizeAsDouble(SBMLDocument *document)
Returns the value of the “font-size” attribute of the RenderGroup of the Style for the Compartment as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “font-size” attribute of the RenderGroup of the Style for the Compartment as a double, or 0.0 if the object is NULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentFontSizeAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &fontSize)
Sets the value of the “font-size” attribute of the RenderGroup of the Style for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontSize – a double value to use as the value of the “font-size” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesFontSize(SBMLDocument *document)
Returns the value of the “font-size” attribute of the RenderGroup of the Style for the Species.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “font-size” attribute of the RenderGroup of the Style for the Species, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesFontSize(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &fontSize)
Sets the value of the “font-size” attribute of the RenderGroup of the Style for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontSize – a RelAbsVector value to use as the value of the “font-size” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesFontSizeAsDouble(SBMLDocument *document)
Returns the value of the “font-size” attribute of the RenderGroup of the Style for the Species as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “font-size” attribute of the RenderGroup of the Style for the Species as a double, or 0.0 if the object is NULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesFontSizeAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &fontSize)
Sets the value of the “font-size” attribute of the RenderGroup of the Style for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontSize – a double value to use as the value of the “font-size” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getReactionFontSize(SBMLDocument *document)
Returns the value of the “font-size” attribute of the RenderGroup of the Style for the Reaction.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “font-size” attribute of the RenderGroup of the Style for the Reaction, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionFontSize(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &fontSize)
Sets the value of the “font-size” attribute of the RenderGroup of the Style for all ReactionGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontSize – a RelAbsVector value to use as the value of the “font-size” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionFontSizeAsDouble(SBMLDocument *document)
Returns the value of the “font-size” attribute of the RenderGroup of the Style for the Reaction as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “font-size” attribute of the RenderGroup of the Style for the Reaction as a double, or 0.0 if the object is NULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionFontSizeAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &fontSize)
Sets the value of the “font-size” attribute of the RenderGroup of the Style for all ReactionGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontSize – a double value to use as the value of the “font-size” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontSize(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &fontSize)
Sets the value of the “font-size” attribute of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontSize – a RelAbsVector value to use as the value of the “font-size” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontSizeAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &fontSize)
Sets the value of the “font-size” attribute of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontSize – a double value to use as the value of the “font-size” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getEmptySpeciesFontSize(const SBMLDocument *document)
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEmptySpeciesFontSize(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &fontSize)
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getEmptySpeciesFontSizeAsDouble(const SBMLDocument *document)
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEmptySpeciesFontSizeAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &fontSize)
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetFontWeight(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex = 0)
Predicates returning
trueif the “font-weight” attribute of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
trueif the “font-weight” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “font-weight” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetFontWeight(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex = 0)
Predicates returning
trueif the “font-weight” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
trueif the “font-weight” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “font-weight” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getFontWeight(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex = 0)
Returns the value of the “font-weight” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
the “font-weight” attribute of the RenderGroup of the Style for this GraphicalObject object, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getFontWeight(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex = 0)
Returns the value of the “font-weight” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
the “font-weight” attribute of the RenderGroup of the Style for this GraphicalObject, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontWeight(SBMLDocument *document, GraphicalObject *graphicalObject, const std::string &fontWeight)
Sets the value of the “font-weight” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
fontWeight – a string value to use as the value of the “font-weight” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontWeight(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex, const std::string &fontWeight)
Sets the value of the “font-weight” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
fontWeight – a string value to use as the value of the “font-weight” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontWeight(SBMLDocument *document, const std::string &attribute, const std::string &fontWeight)
Sets the value of the “font-weight” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
fontWeight – a string value to use as the value of the “font-weight” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontWeight(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex, const std::string &fontWeight)
Sets the value of the “font-weight” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
fontWeight – a string value to use as the value of the “font-weight” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentFontWeight(SBMLDocument *document)
Returns the value of the “font-weight” attribute of the RenderGroup of the Style for the Compartment.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “font-weight” attribute of the RenderGroup of the Style for the Compartment, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentFontWeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontWeight)
Sets the value of the “font-weight” attribute of the RenderGroup of the Style for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontWeight – a string value to use as the value of the “font-weight” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesFontWeight(SBMLDocument *document)
Returns the value of the “font-weight” attribute of the RenderGroup of the Style for the Species.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “font-weight” attribute of the RenderGroup of the Style for the Species, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesFontWeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontWeight)
Sets the value of the “font-weight” attribute of the RenderGroup of the Style for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontWeight – a string value to use as the value of the “font-weight” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getReactionFontWeight(SBMLDocument *document)
Returns the value of the “font-weight” attribute of the RenderGroup of the Style for the Reaction.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “font-weight” attribute of the RenderGroup of the Style for the Reaction, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionFontWeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontWeight)
Sets the value of the “font-weight” attribute of the RenderGroup of the Style for all ReactionGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontWeight – a string value to use as the value of the “font-weight” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontWeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontWeight)
Sets the value of the “font-weight” attribute of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontWeight – a string value to use as the value of the “font-weight” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getEmptySpeciesFontWeight(const SBMLDocument *document)
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEmptySpeciesFontWeight(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontWeight)
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetFontStyle(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex = 0)
Predicates returning
trueif the “font-style” attribute of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
trueif the “font-style” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “font-style” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetFontStyle(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex = 0)
Predicates returning
trueif the “font-style” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
trueif the “font-style” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “font-style” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getFontStyle(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex = 0)
Returns the value of the “font-style” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
the “font-style” attribute of the RenderGroup of the Style for this GraphicalObject object, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getFontStyle(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex = 0)
Returns the value of the “font-style” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
the “font-style” attribute of the RenderGroup of the Style for this GraphicalObject, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontStyle(SBMLDocument *document, GraphicalObject *graphicalObject, const std::string &fontStyle)
Sets the value of the “font-style” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
fontStyle – a string value to use as the value of the “font-style” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontStyle(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex, const std::string &fontStyle)
Sets the value of the “font-style” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
fontStyle – a string value to use as the value of the “font-style” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontStyle(SBMLDocument *document, const std::string &attribute, const std::string &fontStyle)
Sets the value of the “font-style” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
fontStyle – a string value to use as the value of the “font-style” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontStyle(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex, const std::string &fontStyle)
Sets the value of the “font-style” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
fontStyle – a string value to use as the value of the “font-style” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentFontStyle(SBMLDocument *document)
Returns the value of the “font-style” attribute of the RenderGroup of the Style for the Compartment.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “font-style” attribute of the RenderGroup of the Style for the Compartment, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentFontStyle(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontStyle)
Sets the value of the “font-style” attribute of the RenderGroup of the Style for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontStyle – a string value to use as the value of the “font-style” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesFontStyle(SBMLDocument *document)
Returns the value of the “font-style” attribute of the RenderGroup of the Style for the Species.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “font-style” attribute of the RenderGroup of the Style for the Species, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesFontStyle(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontStyle)
Sets the value of the “font-style” attribute of the RenderGroup of the Style for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontStyle – a string value to use as the value of the “font-style” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getReactionFontStyle(SBMLDocument *document)
Returns the value of the “font-style” attribute of the RenderGroup of the Style for the Reaction.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “font-style” attribute of the RenderGroup of the Style for the Reaction, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionFontStyle(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontStyle)
Sets the value of the “font-style” attribute of the RenderGroup of the Style for all ReactionGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontStyle – a string value to use as the value of the “font-style” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFontStyle(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontStyle)
Sets the value of the “font-style” attribute of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fontStyle – a string value to use as the value of the “font-style” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getEmptySpeciesFontStyle(const SBMLDocument *document)
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEmptySpeciesFontStyle(SBMLDocument *document, unsigned int layoutIndex, const std::string &fontStyle)
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetTextAnchor(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex = 0)
Predicates returning
trueif the “text-anchor” attribute of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
trueif the “text-anchor” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “text-anchor” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetTextAnchor(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex = 0)
Predicates returning
trueif the “text-anchor” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
trueif the “text-anchor” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “text-anchor” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getTextAnchor(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex = 0)
Returns the value of the “text-anchor” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
the “text-anchor” attribute of the RenderGroup of the Style for this GraphicalObject object, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getTextAnchor(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex = 0)
Returns the value of the “text-anchor” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
the “text-anchor” attribute of the RenderGroup of the Style for this GraphicalObject, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextAnchor(SBMLDocument *document, GraphicalObject *graphicalObject, const std::string &textAnchor)
Sets the value of the “text-anchor” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textAnchor – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextAnchor(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex, const std::string &textAnchor)
Sets the value of the “text-anchor” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
textAnchor – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextAnchor(SBMLDocument *document, const std::string &attribute, const std::string &textAnchor)
Sets the value of the “text-anchor” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textAnchor – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextAnchor(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex, const std::string &textAnchor)
Sets the value of the “text-anchor” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
textAnchor – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentTextAnchor(SBMLDocument *document)
Returns the value of the “text-anchor” attribute of the RenderGroup of the Style for the Compartment.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “text-anchor” attribute of the RenderGroup of the Style for the Compartment, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentTextAnchor(SBMLDocument *document, unsigned int layoutIndex, const std::string &textAnchor)
Sets the value of the “text-anchor” attribute of the RenderGroup of the Style for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
textAnchor – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesTextAnchor(SBMLDocument *document)
Returns the value of the “text-anchor” attribute of the RenderGroup of the Style for the Species.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “text-anchor” attribute of the RenderGroup of the Style for the Species, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesTextAnchor(SBMLDocument *document, unsigned int layoutIndex, const std::string &textAnchor)
Sets the value of the “text-anchor” attribute of the RenderGroup of the Style for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
textAnchor – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getReactionTextAnchor(SBMLDocument *document)
Returns the value of the “text-anchor” attribute of the RenderGroup of the Style for the Reaction.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “text-anchor” attribute of the RenderGroup of the Style for the Reaction, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionTextAnchor(SBMLDocument *document, unsigned int layoutIndex, const std::string &textAnchor)
Sets the value of the “text-anchor” attribute of the RenderGroup of the Style for all ReactionGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
textAnchor – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setTextAnchor(SBMLDocument *document, unsigned int layoutIndex, const std::string &textAnchor)
Sets the value of the “text-anchor” attribute of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
textAnchor – a string value to use as the value of the “text-anchor” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getEmptySpeciesTextAnchor(const SBMLDocument *document)
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEmptySpeciesTextAnchor(SBMLDocument *document, unsigned int layoutIndex, const std::string &textAnchor)
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetVTextAnchor(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex = 0)
Predicates returning
trueif the “vtext-anchor” attribute of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
trueif the “vtext-anchor” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “vtext-anchor” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetVTextAnchor(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex = 0)
Predicates returning
trueif the “vtext-anchor” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
trueif the “vtext-anchor” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “vtext-anchor” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getVTextAnchor(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex = 0)
Returns the value of the “vtext-anchor” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
the “vtext-anchor” attribute of the RenderGroup of the Style for this GraphicalObject object, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getVTextAnchor(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex = 0)
Returns the value of the “vtext-anchor” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
- Returns:
the “vtext-anchor” attribute of the RenderGroup of the Style for this GraphicalObject, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setVTextAnchor(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int textGlyphIndex, const std::string &vtextAnchor)
Sets the value of the “vtext-anchor” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
vtextAnchor – a string value to use as the value of the “vtext-anchor” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setVTextAnchor(SBMLDocument *document, const std::string &attribute, unsigned int textGlyphIndex, const std::string &vtextAnchor)
Sets the value of the “vtext-anchor” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
textGlyphIndex – an unsigned int representing the index of the TextGlyph object.
vtextAnchor – a string value to use as the value of the “vtext-anchor” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentVTextAnchor(SBMLDocument *document)
Returns the value of the “vtext-anchor” attribute of the RenderGroup of the Style for the Compartment.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “vtext-anchor” attribute of the RenderGroup of the Style for the Compartment, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentVTextAnchor(SBMLDocument *document, unsigned int layoutIndex, const std::string &vtextAnchor)
Sets the value of the “vtext-anchor” attribute of the RenderGroup of the Style for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
vtextAnchor – a string value to use as the value of the “vtext-anchor” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesVTextAnchor(SBMLDocument *document)
Returns the value of the “vtext-anchor” attribute of the RenderGroup of the Style for the Species.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “vtext-anchor” attribute of the RenderGroup of the Style for the Species, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesVTextAnchor(SBMLDocument *document, unsigned int layoutIndex, const std::string &vtextAnchor)
Sets the value of the “vtext-anchor” attribute of the RenderGroup of the Style for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
vtextAnchor – a string value to use as the value of the “vtext-anchor” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getReactionVTextAnchor(SBMLDocument *document)
Returns the value of the “vtext-anchor” attribute of the RenderGroup of the Style for the Reaction.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “vtext-anchor” attribute of the RenderGroup of the Style for the Reaction, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionVTextAnchor(SBMLDocument *document, unsigned int layoutIndex, const std::string &vtextAnchor)
Sets the value of the “vtext-anchor” attribute of the RenderGroup of the Style for all ReactionGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
vtextAnchor – a string value to use as the value of the “vtext-anchor” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setVTextAnchor(SBMLDocument *document, unsigned int layoutIndex, const std::string &vtextAnchor)
Sets the value of the “vtext-anchor” attribute of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
vtextAnchor – a string value to use as the value of the “vtext-anchor” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getEmptySpeciesVTextAnchor(const SBMLDocument *document)
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEmptySpeciesVTextAnchor(SBMLDocument *document, unsigned int layoutIndex, const std::string &vtextAnchor)
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetFillColor(SBMLDocument *document, GraphicalObject *graphicalObject)
Predicates returning
trueif the “fill” attribute of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
trueif the “fill” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “fill” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetFillColor(SBMLDocument *document, const std::string &attribute)
Predicates returning
trueif the “fill” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
trueif the “fill” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “fill” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getFillColor(SBMLDocument *document, GraphicalObject *graphicalObject)
Returns the value of the “fill” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
the “fill” attribute of the RenderGroup of the Style for this GraphicalObject object, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getFillColor(SBMLDocument *document, const std::string &attribute)
Returns the value of the “fill” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
the “fill” attribute of the RenderGroup of the Style for this GraphicalObject, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFillColor(SBMLDocument *document, GraphicalObject *graphicalObject, const std::string &fillColor)
Sets the value of the “fill” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
fillColor – a string value to use as the value of the “fill” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFillColor(SBMLDocument *document, const std::string &attribute, const std::string &fillColor)
Sets the value of the “fill” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
fillColor – a string value to use as the value of the “fill” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentFillColor(SBMLDocument *document)
Returns the value of the “fill” attribute of the RenderGroup of the Style for the Compartment.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “fill” attribute of the RenderGroup of the Style for the Compartment, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentFillColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &fillColor)
Sets the value of the “fill” attribute of the RenderGroup of the Style for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fillColor – a string value to use as the value of the “fill” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentFillColorAsGradient(SBMLDocument *document, unsigned int layoutIndex, const std::string &gradientType, std::vector<std::pair<std::string, double>> stopsVector)
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesFillColor(SBMLDocument *document)
Returns the value of the “fill” attribute of the RenderGroup of the Style for the Species.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “fill” attribute of the RenderGroup of the Style for the Species, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesFillColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &fillColor)
Sets the value of the “fill” attribute of the RenderGroup of the Style for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fillColor – a string value to use as the value of the “fill” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesFillColorAsGradient(SBMLDocument *document, unsigned int layoutIndex, const std::string &gradientType, std::vector<std::pair<std::string, double>> stopsVector)
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getReactionFillColor(SBMLDocument *document)
Returns the value of the “fill” attribute of the RenderGroup of the Style for the Reaction.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “fill” attribute of the RenderGroup of the Style for the Reaction, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionFillColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &fillColor)
Sets the value of the “fill” attribute of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fillColor – a double value to use as the value of the “fill” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionFillColorAsGradient(SBMLDocument *document, unsigned int layoutIndex, const std::string &gradientType, std::vector<std::pair<std::string, double>> stopsVector)
Sets the value of the “fill” attribute of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a gradient.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
gradientType – a string representing the type of gradient to use.
stopsVector – a vector of pairs where each pair consists of a string representing the color and a double representing the offset for the gradient stop.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingFillColor(SBMLDocument *document, unsigned int layoutIndex = 0)
Returns the value of the “fill” attribute of the RenderGroup of LineEnding objects, if they share the same “fill”.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
- Returns:
the “fill” attribute of the RenderGroup of LineEnding objects, or
""if the object isNULLor they don’t share the same “fill”.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingFillColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &fillColor)
Sets the value of the “fill” attribute of the RenderGroup of all LineEnding objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fillColor – a string value to use as the value of the “fill” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingFillColorAsGradient(SBMLDocument *document, unsigned int layoutIndex, const std::string &gradientType, std::vector<std::pair<std::string, double>> stopsVector)
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFillColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &fillColor)
Sets the value of the “fill” attribute of the RenderGroup of the Style for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fillColor – a string value to use as the value of the “fill” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
Warning
doxygenfunction: Unable to resolve function “LIBSBMLNETWORK_CPP_NAMESPACE::setFillColorAsGradient” with arguments “(SBMLDocument*, unsigned int, const std::string&, std::vector<std::pair<std::string, double>>)”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 22] LIBSBMLNETWORK_EXTERN int setFillColorAsGradient (RenderInformationBase *renderInformationBase, GraphicalObject *graphicalObject, const std::string &gradientId) ———————-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name, got keyword: int [error at 25] LIBSBMLNETWORK_EXTERN int setFillColorAsGradient (RenderInformationBase *renderInformationBase, GraphicalObject *graphicalObject, const std::string &gradientId) ————————-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name, got keyword: int [error at 25] LIBSBMLNETWORK_EXTERN int setFillColorAsGradient (RenderInformationBase *renderInformationBase, GraphicalObject *graphicalObject, const std::string &gradientId) ————————-^
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getEmptySpeciesFillColor(const SBMLDocument *document)
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEmptySpeciesFillColor(SBMLDocument *document, unsigned int layoutIndex, const std::string &fillColor)
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEmptySpeciesFillColorAsGradient(SBMLDocument *document, unsigned int layoutIndex, const std::string &gradientType, std::vector<std::pair<std::string, double>> stopsVector)
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetFillRule(SBMLDocument *document, GraphicalObject *graphicalObject)
Predicates returning
trueif the “fill-rule” attribute of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
trueif the “fill-rule” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “fill-rule” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetFillRule(SBMLDocument *document, const std::string &attribute)
Predicates returning
trueif the “fill-rule” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
trueif the “fill-rule” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “fill-rule” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getFillRule(SBMLDocument *document, GraphicalObject *graphicalObject)
Returns the value of the “fill-rule” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
the “fill-rule” attribute of the RenderGroup of the Style for this GraphicalObject object, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getFillRule(SBMLDocument *document, const std::string &attribute)
Returns the value of the “fill-rule” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
the “fill-rule” attribute of the RenderGroup of the Style for this GraphicalObject, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFillRule(SBMLDocument *document, GraphicalObject *graphicalObject, const std::string &fillRule)
Sets the value of the “fill-rule” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
fillRule – a string value to use as the value of the “fill-rule” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFillRule(SBMLDocument *document, const std::string &attribute, const std::string &fillRule)
Sets the value of the “fill-rule” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
fillRule – a string value to use as the value of the “fill-rule” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentFillRule(SBMLDocument *document)
Returns the value of the “fill-rule” attribute of the RenderGroup of the Style for the Compartment.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “fill-rule” attribute of the RenderGroup of the Style for the Compartment, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentFillRule(SBMLDocument *document, unsigned int layoutIndex, const std::string &fillRule)
Sets the value of the “fill-rule” attribute of the RenderGroup of the Style for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fillRule – a string value to use as the value of the “fill-rule” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesFillRule(SBMLDocument *document)
Returns the value of the “fill-rule” attribute of the RenderGroup of the Style for the Species.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “fill-rule” attribute of the RenderGroup of the Style for the Species, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesFillRule(SBMLDocument *document, unsigned int layoutIndex, const std::string &fillRule)
Sets the value of the “fill-rule” attribute of the RenderGroup of the Style for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fillRule – a string value to use as the value of the “fill-rule” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getReactionFillRule(SBMLDocument *document)
Returns the value of the “fill-rule” attribute of the RenderGroup of the Style for the Reaction.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “fill-rule” attribute of the RenderGroup of the Style for the Reaction, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionFillRule(SBMLDocument *document, unsigned int layoutIndex, const std::string &fillRule)
Sets the value of the “fill-rule” attribute of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fillRule – a string value to use as the value of the “fill-rule” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getLineEndingFillRule(SBMLDocument *document, unsigned int layoutIndex = 0)
Returns the value of the “fill-rule” attribute of the RenderGroup of LineEnding objects, if they share the same “fill-rule”.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
- Returns:
the “fill-rule” attribute of the RenderGroup of LineEnding objects, or
""if the object isNULLor they don’t share the same “fill-rule”.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setLineEndingFillRule(SBMLDocument *document, unsigned int layoutIndex, const std::string &fillRule)
Sets the value of the “fill-rule” attribute of the RenderGroup of all LineEnding objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fillRule – a string value to use as the value of the “fill-rule” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setFillRule(SBMLDocument *document, unsigned int layoutIndex, const std::string &fillRule)
Sets the value of the “fill-rule” attribute of the RenderGroup of the Style for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
fillRule – a string value to use as the value of the “fill-rule” attribute of the RenderGroup of these Style objects.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getEmptySpeciesFillRule(const SBMLDocument *document)
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEmptySpeciesFillRule(SBMLDocument *document, unsigned int layoutIndex, const std::string &fillRule)
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetStartHead(SBMLDocument *document, GraphicalObject *graphicalObject)
Predicates returning
trueif the “startHead” attribute of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
trueif the “startHead” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “startHead” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetStartHead(SBMLDocument *document, const std::string &attribute)
Predicates returning
trueif the “startHead” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
trueif the “startHead” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “startHead” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getStartHead(SBMLDocument *document, GraphicalObject *graphicalObject)
Returns the value of the “startHead” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
the “startHead” attribute of the RenderGroup of the Style for this GraphicalObject object, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getStartHead(SBMLDocument *document, const std::string &attribute)
Returns the value of the “startHead” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
the “startHead” attribute of the RenderGroup of the Style for this GraphicalObject, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setStartHead(SBMLDocument *document, GraphicalObject *graphicalObject, const std::string &startHead)
Sets the value of the “startHead” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
startHead – a string value to use as the value of the “startHead” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setStartHead(SBMLDocument *document, const std::string &attribute, const std::string &startHead)
Sets the value of the “startHead” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
startHead – a string value to use as the value of the “startHead” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetEndHead(SBMLDocument *document, GraphicalObject *graphicalObject)
Predicates returning
trueif the “endHead” attribute of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
trueif the “endHead” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “endHead” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetEndHead(SBMLDocument *document, const std::string &attribute)
Predicates returning
trueif the “endHead” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
trueif the “endHead” attribute of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “endHead” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getEndHead(SBMLDocument *document, GraphicalObject *graphicalObject)
Returns the value of the “endHead” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
the “endHead” attribute of the RenderGroup of the Style for this GraphicalObject object, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getEndHead(SBMLDocument *document, const std::string &attribute)
Returns the value of the “endHead” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
the “endHead” attribute of the RenderGroup of the Style for this GraphicalObject, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEndHead(SBMLDocument *document, GraphicalObject *graphicalObject, const std::string &endHead)
Sets the value of the “endHead” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
endHead – a string value to use as the value of the “endHead” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEndHead(SBMLDocument *document, const std::string &attribute, const std::string &endHead)
Sets the value of the “endHead” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
endHead – a string value to use as the value of the “startHead” attribute of the RenderGroup of this Style object.
- Returns:
integer value indicating success/failure of the function.
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumGeometricShapes(SBMLDocument *document, GraphicalObject *graphicalObject)
Returns number of Transformation2D objects in the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
- Returns:
the number of Transformation2D objects in the RenderGroup of the Style for this GraphicalObject object, or
""if the object isNULL
-
unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getNumGeometricShapes(SBMLDocument *document, const std::string &attribute)
Returns number of Transformation2D objects in the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
- Returns:
the number of Transformation2D objects in the RenderGroup of the Style for this GraphicalObject, or
""if the object isNULL
-
Transformation2D *LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShape(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the Transformation2D at the given index the RenderGroup of the Style for this GraphicalObject object,
NULLif the object isNULL
-
Transformation2D *LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShape(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject, or
NULLif the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addGeometricShape(SBMLDocument *document, GraphicalObject *graphicalObject, const std::string &shape)
Add a geometric shape to the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addGeometricShape(SBMLDocument *document, const std::string &attribute, const std::string &shape)
Add a geometric shape to the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
shape – a string value indicating the shape of the geometric shape to be added.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeGeometricShape(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Remove a geometric shape from the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to remove.
- Returns:
a pointer to the Transformation2D with the given index of the RenderGroup of the Style for this GraphicalObject, or
NULLif the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::removeGeometricShape(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Remove a geometric shape from the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to remove.
- Returns:
a pointer to the Transformation2D with the given index of the RenderGroup of the Style for this GraphicalObject, or
NULLif the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeType(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value the type of the geometric shape of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the type of the geometric shape of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject, or
""if the object isNULL
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeType(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value the type of the geometric shape of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the type of the geometric shape of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject, or
""if the object isNULL
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeType(SBMLDocument *document, GraphicalObject *graphicalObject, const std::string &shape)
Sets the geometric shape as the single geometric shape of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
shape – a string value indicating the shape of the geometric shape to be set.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeType(SBMLDocument *document, const std::string &attribute, const std::string &shape)
Sets the geometric shape as the single geometric shape of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
shape – a string value indicating the shape of the geometric shape to be set.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeType(SBMLDocument *document)
Returns the value of the “geometric-shape” attribute of the RenderGroup of the Style for the Compartment.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “geometric-shape” attribute of the RenderGroup of the Style for the Compartment, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeType(SBMLDocument *document, unsigned int layoutIndex, const std::string &shape)
Sets the geometric shape as the single geometric shape of the RenderGroup of the Style for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
shape – a string value indicating the shape of the geometric shape to be set.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeType(SBMLDocument *document)
Returns the value of the “geometric-shape” attribute of the RenderGroup of the Style for the Species.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “geometric-shape” attribute of the RenderGroup of the Style for the Species, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeType(SBMLDocument *document, unsigned int layoutIndex, const std::string &shape)
Sets the geometric shape as the single geometric shape of the RenderGroup of the Style for for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
shape – a string value indicating the shape of the geometric shape to be set.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeType(SBMLDocument *document)
Returns the value of the “geometric-shape” attribute of the RenderGroup of the Style for the Reaction.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “geometric-shape” attribute of the RenderGroup of the Style for the Reaction, or
""if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeType(SBMLDocument *document, unsigned int layoutIndex, const std::string &shape)
Sets the geometric shape as the single geometric shape of the RenderGroup of the Style for for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
shape – a string value indicating the shape of the geometric shape to be set.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeType(SBMLDocument *document, unsigned int layoutIndex, const std::string &shape)
Sets the geometric shape as the single geometric shape of the RenderGroup of the Style for for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
shape – a string value indicating the shape of the geometric shape to be set.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getEmptySpeciesGeometricShapeType(const SBMLDocument *document)
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setEmptySpeciesGeometricShapeType(SBMLDocument *document, unsigned int layoutIndex, const std::string &shape)
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isRectangle(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Rectangle.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Rectangle,falseif it is not of type Rectangle or is or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isRectangle(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is of type Rectangle.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Rectangle,falseif it is not of type Rectangle or is or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSquare(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Square.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Square,falseif it is not of type Square or is or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSquare(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is of type Square.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Square,falseif it is not of type Square or is or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isEllipse(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Ellipse.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Ellipse,falseif it is not of type Ellipse or is or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isEllipse(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is of type Ellipse.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Ellipse,falseif it is not of type Ellipse or is or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isCircle(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Circle.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Circle,falseif it is not of type Circle or is or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isCircle(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is of type Circle.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Circle,falseif it is not of type Circle or is or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isPolygon(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Polygon.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Polygon,falseif it is not of type Polygon or is or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isPolygon(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is of type Polygon.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Polygon,falseif it is not of type Polygon or is or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isRenderCurve(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type RenderCurve.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type RenderCurve,falseif it is not of type RenderCurve or is or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isRenderCurve(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is of type RenderCurve.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type RenderCurve,falseif it is not of type RenderCurve or is or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isImage(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Image.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Image,falseif it is not of type Image or is or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isImage(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is of type Image.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Image,falseif it is not of type Image or is or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isText(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Text.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Text,falseif it is not of type Text or is or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isText(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is of type Text.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type Text,falseif it is not of type Text or is or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeStrokeColor(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex)
Predicates returning
trueif the “storke” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “stroke” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeStrokeColor(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex)
Predicates returning
trueif the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “stroke” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “stroke” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeStrokeColor(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex)
Returns the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D 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 isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeStrokeColor(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex)
Returns the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D 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 isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeStrokeColor(SBMLDocument *document, GraphicalObject *graphicalObject, const std::string &strokeColor)
Sets the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
strokeColor – a string value to use as the value of the “stroke” attribute of the Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeStrokeColor(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const std::string &strokeColor)
Sets the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
strokeColor – a string value to use as the value of the “stroke” attribute of the Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeStrokeColor(SBMLDocument *document, const std::string &attribute, const std::string &strokeColor)
Sets the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
strokeColor – a string value to use as the value of the “stroke” attribute of the Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeStrokeColor(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const std::string &strokeColor)
Sets the value of the “stroke” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
strokeColor – a string value to use as the value of the “stroke” attribute of the Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeStrokeWidth(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex)
Predicates returning
trueif the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “stroke-width” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “stroke-width” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeStrokeWidth(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex)
Predicates returning
trueif the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “stroke-width” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “stroke-width” attribute is not set or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeStrokeWidth(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex)
Returns the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D 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.0if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeStrokeWidth(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex)
Returns the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D 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.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeStrokeWidth(SBMLDocument *document, GraphicalObject *graphicalObject, const double &strokeWidth)
Sets the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
strokeWidth – a double value to use as the value of the “stroke-width” attribute of the Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeStrokeWidth(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const double &strokeWidth)
Sets the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
strokeWidth – a double value to use as the value of the “stroke-width” attribute of the Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeStrokeWidth(SBMLDocument *document, const std::string &attribute, const double &strokeWidth)
Sets the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
strokeWidth – a double value to use as the value of the “stroke-width” attribute of the Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeStrokeWidth(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const double &strokeWidth)
Sets the value of the “stroke-width” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
strokeWidth – a double value to use as the value of the “stroke-width” attribute of the Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeFillColor(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex)
Predicates returning
trueif the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “fill” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “fill” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeFillColor(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex)
Predicates returning
trueif the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “fill” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “fill” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeFillColor(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex)
Returns the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D 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 isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeFillColor(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex)
Returns the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D 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 isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeFillColor(SBMLDocument *document, GraphicalObject *graphicalObject, const std::string &fillColor)
Sets the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
fillColor – a string value to use as the value of the “fill” attribute of the Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeFillColor(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const std::string &fillColor)
Sets the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
fillColor – a string value to use as the value of the “fill” attribute of the Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeFillColor(SBMLDocument *document, const std::string &attribute, const std::string &fillColor)
Sets the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
fillColor – a string value to use as the value of the “fill” attribute of the Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeFillColor(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const std::string &fillColor)
Sets the value of the “fill” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
fillColor – a string value to use as the value of the “fill” attribute of the Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeX(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex)
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “x” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “x” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeX(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “x” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “x” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “x” attribute is not set or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeX(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “x” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D 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 isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeX(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “x” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D 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 isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeXAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “x” attribute of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “x” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeXAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “x” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “x” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeX(SBMLDocument *document, GraphicalObject *graphicalObject, const RelAbsVector &x)
Sets the value of the “x” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
x – a RelAbsVector to use as the value of the “x” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeX(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const RelAbsVector &x)
Sets the value of the “x” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeX(SBMLDocument *document, const std::string &attribute, const RelAbsVector &x)
Sets the value of the “x” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
x – a RelAbsVector to use as the value of the “x” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeX(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const RelAbsVector &x)
Sets the value of the “x” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeXAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const double &x)
Sets the value of the “x” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
x – a double value to use as the value of the “x” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeXAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const double &x)
Sets the value of the “x” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
x – a double value to use as the value of the “x” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeXAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, const double &x)
Sets the value of the “x” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
x – a double value to use as the value of the “x” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeXAsDouble(SBMLDocument *document, const std::string &attribute, const double &x)
Sets the value of the “x” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
x – a double value to use as the value of the “x” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeX(SBMLDocument *document)
Returns the value of the “x” attribute of the RenderGroup of the Style for the Compartment.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the RenderGroup of the Style for the Compartment, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeX(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &x)
Sets the “x” attribute of the geometric shape of the RenderGroup of the Style for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
x – a RelAbsVector to use as the value of the “x” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeXAsDouble(SBMLDocument *document)
Returns the value of the “x” attribute of the RenderGroup of the Style for the Compartment as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the RenderGroup of the Style for the Compartment as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &x)
Sets the “x” attribute of the geometric shape of the RenderGroup of the Style for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
x – a double value to use as the value of the “x” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeX(SBMLDocument *document)
Returns the value of the “x” attribute of the RenderGroup of the Style for the Species.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the RenderGroup of the Style for the Species, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeX(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &x)
Sets the “x” attribute of the geometric shape of the RenderGroup of the Style for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
x – a RelAbsVector to use as the value of the “x” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeXAsDouble(SBMLDocument *document)
Returns the value of the “x” attribute of the RenderGroup of the Style for the Species as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the RenderGroup of the Style for the Species as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &x)
Sets the “x” attribute of the geometric shape of the RenderGroup of the Style for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
x – a double value to use as the value of the “x” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeX(SBMLDocument *document)
Returns the value of the “x” attribute of the RenderGroup of the Style for the Reaction.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the RenderGroup of the Style for the Reaction, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeX(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &x)
Sets the “x” attribute of the geometric shape of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
x – a RelAbsVector to use as the value of the “x” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeXAsDouble(SBMLDocument *document)
Returns the value of the “x” attribute of the RenderGroup of the Style for the Reaction as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the RenderGroup of the Style for the Reaction as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &x)
Sets the “x” attribute of the geometric shape of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
x – a double value to use as the value of the “x” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeX(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &x)
Sets the “x” attribute of the geometric shape of the RenderGroup of the Style for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
x – a RelAbsVector to use as the value of the “x” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &x)
Sets the value of the “x” attribute of the geometric shape of the RenderGroup of the Style for all GraphicalObject objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
x – a double value to use as the value of the “x” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeY(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “y” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “y” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “y” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeY(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “y” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “y” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “y” attribute is not set or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeY(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “y” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “y” 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 “y” attribute, it is not set, or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeY(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “y” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “y” 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 “y” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeYAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “y” attribute of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “y” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “y” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeYAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “y” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “y” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “y” attribute, it is not set, or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeY(SBMLDocument *document, GraphicalObject *graphicalObject, const RelAbsVector &y)
Sets the value of the “y” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
y – a RelAbsVector to use as the value of the “y” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeY(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const RelAbsVector &y)
Sets the value of the “y” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeY(SBMLDocument *document, const std::string &attribute, const RelAbsVector &y)
Sets the value of the “y” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
y – a RelAbsVector to use as the value of the “y” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeY(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const RelAbsVector &y)
Sets the value of the “y” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeYAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const double &y)
Sets the value of the “y” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
y – a double value to use as the value of the “y” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeYAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const double &y)
Sets the value of the “y” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
y – a double value to use as the value of the “y” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeYAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, const double &y)
Sets the value of the “y” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
y – a double value to use as the value of the “y” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeYAsDouble(SBMLDocument *document, const std::string &attribute, const double &y)
Sets the value of the “y” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
y – a double value to use as the value of the “y” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeY(SBMLDocument *document)
Returns the value of the “y” attribute of the RenderGroup of the Style for the Compartment.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the RenderGroup of the Style for the Compartment, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeY(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &y)
Sets the “y” attribute of the geometric shape of the RenderGroup of the Style for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
y – a RelAbsVector to use as the value of the “y” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeYAsDouble(SBMLDocument *document)
Returns the value of the “y” attribute of the RenderGroup of the Style for the Compartment as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the RenderGroup of the Style for the Compartment as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &y)
Sets the value of the “y” attribute of the geometric shape of the RenderGroup of the Style for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
y – a double value to use as the value of the “y” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeY(SBMLDocument *document)
Returns the value of the “y” attribute of the RenderGroup of the Style for the Species.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the RenderGroup of the Style for the Species, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeY(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &y)
Sets the “y” attribute of the geometric shape of the RenderGroup of the Style for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
y – a RelAbsVector to use as the value of the “y” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeYAsDouble(SBMLDocument *document)
Returns the value of the “y” attribute of the RenderGroup of the Style for the Species as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the RenderGroup of the Style for the Species as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &y)
Sets the value of the “y” attribute of the geometric shape of the RenderGroup of the Style for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
y – a double value to use as the value of the “y” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeY(SBMLDocument *document)
Returns the value of the “y” attribute of the RenderGroup of the Style for the Reaction.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the RenderGroup of the Style for the Reaction, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeY(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &y)
Sets the “y” attribute of the geometric shape of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
y – a RelAbsVector to use as the value of the “y” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeYAsDouble(SBMLDocument *document)
Returns the value of the “y” attribute of the RenderGroup of the Style for the Reaction as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the RenderGroup of the Style for the Reaction as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &y)
Sets the value of the “y” attribute of the geometric shape of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
y – a double value to use as the value of the “y” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeY(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &y)
Sets the “y” attribute of the geometric shape of the RenderGroup of the Style for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
y – a RelAbsVector to use as the value of the “y” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &y)
Sets the value of the “y” attribute of the geometric shape of the RenderGroup of the Style for all GraphicalObject objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
y – a double value to use as the value of the “y” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeWidth(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “width” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “width” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “width” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeWidth(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “width” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “width” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “width” attribute is not set or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeWidth(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “width” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “width” 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 “width” attribute, it is not set, or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeWidth(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “width” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “width” 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 “width” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeWidthAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “width” attribute of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “width” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “width” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeWidthAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “width” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “width” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “width” attribute, it is not set, or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeWidth(SBMLDocument *document, GraphicalObject *graphicalObject, const RelAbsVector &width)
Sets the value of the “width” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
width – a RelAbsVector to use as the value of the “width” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeWidth(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const RelAbsVector &width)
Sets the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
width – a RelAbsVector to use as the value of the “width” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeWidth(SBMLDocument *document, const std::string &attribute, const RelAbsVector &width)
Sets the value of the “width” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
width – a RelAbsVector to use as the value of the “width” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeWidth(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const RelAbsVector &width)
Sets the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
width – a RelAbsVector to use as the value of the “width” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeWidthAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const double &width)
Sets the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
width – a double value to use as the value of the “width” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeWidthAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const double &width)
Sets the value of the “width” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
width – a double value to use as the value of the “width” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeWidthAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, const double &width)
Sets the value of the “width” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
width – a double value to use as the value of the “width” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeWidthAsDouble(SBMLDocument *document, const std::string &attribute, const double &width)
Sets the value of the “width” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
width – a double value to use as the value of the “width” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeWidth(SBMLDocument *document)
Returns the value of the “width” attribute of the RenderGroup of the Style for the Compartment.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “width” attribute of the RenderGroup of the Style for the Compartment, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeWidth(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &width)
Sets the “width” attribute of the geometric shape of the RenderGroup of the Style for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
width – a RelAbsVector to use as the value of the “width” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeWidthAsDouble(SBMLDocument *document)
Returns the value of the “width” attribute of the RenderGroup of the Style for the Compartment as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “width” attribute of the RenderGroup of the Style for the Compartment as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeWidthAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &width)
Sets the value of the “width” attribute of the geometric shape of the RenderGroup of the Style for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
width – a double value to use as the value of the “width” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeWidth(SBMLDocument *document)
Returns the value of the “width” attribute of the RenderGroup of the Style for the Species.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “width” attribute of the RenderGroup of the Style for the Species, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeWidth(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &width)
Sets the “width” attribute of the geometric shape of the RenderGroup of the Style for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
width – a RelAbsVector to use as the value of the “width” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeWidthAsDouble(SBMLDocument *document)
Returns the value of the “width” attribute of the RenderGroup of the Style for the Species as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “width” attribute of the RenderGroup of the Style for the Species as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeWidthAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &width)
Sets the value of the “width” attribute of the geometric shape of the RenderGroup of the Style for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
width – a double value to use as the value of the “width” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeWidth(SBMLDocument *document)
Returns the value of the “width” attribute of the RenderGroup of the Style for the Reaction.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “width” attribute of the RenderGroup of the Style for the Reaction, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeWidth(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &width)
Sets the “width” attribute of the geometric shape of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
width – a RelAbsVector to use as the value of the “width” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeWidthAsDouble(SBMLDocument *document)
Returns the value of the “width” attribute of the RenderGroup of the Style for the Reaction as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “width” attribute of the RenderGroup of the Style for the Reaction as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeWidthAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &width)
Sets the value of the “width” attribute of the geometric shape of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
width – a double value to use as the value of the “width” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeWidth(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &width)
Sets the “width” attribute of the geometric shape of the RenderGroup of the Style for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
width – a RelAbsVector to use as the value of the “width” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeWidthAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &width)
Sets the value of the “width” attribute of the geometric shape of the RenderGroup of the Style for all GraphicalObject objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
width – a double value to use as the value of the “width” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeHeight(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “height” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “height” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “height” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeHeight(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “height” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “height” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “height” attribute is not set or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeHeight(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “height” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “height” 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 “height” attribute, it is not set, or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeHeight(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “height” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “height” 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 “height” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeHeightAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “height” attribute of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “height” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “height” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeHeightAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “height” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “height” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “height” attribute, it is not set, or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeHeight(SBMLDocument *document, GraphicalObject *graphicalObject, const RelAbsVector &height)
Sets the value of the “height” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
height – a RelAbsVector to use as the value of the “height” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeHeight(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const RelAbsVector &height)
Sets the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
height – a RelAbsVector to use as the value of the “height” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeHeight(SBMLDocument *document, const std::string &attribute, const RelAbsVector &height)
Sets the value of the “height” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
height – a RelAbsVector to use as the value of the “height” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeHeight(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const RelAbsVector &height)
Sets the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
height – a RelAbsVector to use as the value of the “height” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeHeightAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const double &height)
Sets the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
height – a double value to use as the value of the “height” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeHeightAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const double &height)
Sets the value of the “height” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
height – a double value to use as the value of the “height” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeHeight(SBMLDocument *document)
Returns the value of the “height” attribute of the RenderGroup of the Style for the Compartment.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “height” attribute of the RenderGroup of the Style for the Compartment, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeHeight(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &height)
Sets the “height” attribute of the geometric shape of the RenderGroup of the Style for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
height – a RelAbsVector to use as the value of the “height” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeHeightAsDouble(SBMLDocument *document)
Returns the value of the “height” attribute of the RenderGroup of the Style for the Compartment as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “height” attribute of the RenderGroup of the Style for the Compartment as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeHeightAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &height)
Sets the value of the “height” attribute of the geometric shape of the RenderGroup of the Style for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
height – a double value to use as the value of the “height” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeHeight(SBMLDocument *document)
Returns the value of the “height” attribute of the RenderGroup of the Style for the Species.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “height” attribute of the RenderGroup of the Style for the Species, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeHeight(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &height)
Sets the “height” attribute of the geometric shape of the RenderGroup of the Style for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
height – a RelAbsVector to use as the value of the “height” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeHeightAsDouble(SBMLDocument *document)
Returns the value of the “height” attribute of the RenderGroup of the Style for the Species as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “height” attribute of the RenderGroup of the Style for the Species as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeHeightAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &height)
Sets the value of the “height” attribute of the geometric shape of the RenderGroup of the Style for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
height – a double value to use as the value of the “height” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeHeight(SBMLDocument *document)
Returns the value of the “height” attribute of the RenderGroup of the Style for the Reaction.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “height” attribute of the RenderGroup of the Style for the Reaction, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeHeight(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &height)
Sets the “height” attribute of the geometric shape of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
height – a RelAbsVector to use as the value of the “height” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeHeightAsDouble(SBMLDocument *document)
Returns the value of the “height” attribute of the RenderGroup of the Style for the Reaction as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “height” attribute of the RenderGroup of the Style for the Reaction as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeHeightAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &height)
Sets the value of the “height” attribute of the geometric shape of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
height – a double value to use as the value of the “height” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeHeight(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &height)
Sets the “height” attribute of the geometric shape of the RenderGroup of the Style for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
height – a RelAbsVector to use as the value of the “height” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeHeightAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &height)
Sets the value of the “height” attribute of the geometric shape of the RenderGroup of the Style for all GraphicalObject objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
height – a double value to use as the value of the “height” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeRatio(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “ratio” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “ratio” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeRatio(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “ratio” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “ratio” attribute is not set or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeRatio(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “ratio” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “ratio” 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 “ratio” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeRatio(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “ratio” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “ratio” 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 “ratio” attribute, it is not set, or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRatio(SBMLDocument *document, GraphicalObject *graphicalObject, const double &ratio)
Sets the value of the “ratio” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
ratio – a double to use as the value of the “ratio” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRatio(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const double &ratio)
Sets the value of the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
ratio – a double to use as the value of the “ratio” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRatio(SBMLDocument *document, const std::string &attribute, const double &ratio)
Sets the value of the “ratio” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
ratio – a double to use as the value of the “ratio” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRatio(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const double &ratio)
Sets the value of the “ratio” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
ratio – a double to use as the value of the “ratio” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeRatio(SBMLDocument *document)
Returns the value of the “ratio” attribute of the RenderGroup of the Style for the Compartment.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “ratio” attribute of the RenderGroup of the Style for the Compartment as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeRatio(SBMLDocument *document, unsigned int layoutIndex, const double &ratio)
Sets the “ratio” attribute of the geometric shape of the RenderGroup of the Style for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ratio – a double to use as the value of the “ratio” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeRatio(SBMLDocument *document)
Returns the value of the “ratio” attribute of the RenderGroup of the Style for the Species.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “ratio” attribute of the RenderGroup of the Style for the Species as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeRatio(SBMLDocument *document, unsigned int layoutIndex, const double &ratio)
Sets the “ratio” attribute of the geometric shape of the RenderGroup of the Style for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ratio – a double to use as the value of the “ratio” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeRatio(SBMLDocument *document)
Returns the value of the “ratio” attribute of the RenderGroup of the Style for the Reaction.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “ratio” attribute of the RenderGroup of the Style for the Reaction as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeRatio(SBMLDocument *document, unsigned int layoutIndex, const double &ratio)
Sets the “ratio” attribute of the geometric shape of the RenderGroup of the Style for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ratio – a double to use as the value of the “ratio” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRatio(SBMLDocument *document, unsigned int layoutIndex, const double &ratio)
Sets the “ratio” attribute of the geometric shape of the RenderGroup of the Style for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ratio – a double to use as the value of the “ratio” attribute of the geometric shape.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “rx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “rx” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “rx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “rx” attribute is not set or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “rx” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “rx” 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 “rx” attribute, it is not set, or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “rx” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “rx” 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 “rx” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “rx” attribute of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “rx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “rx” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “rx” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “rx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “rx” attribute, it is not set, or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, GraphicalObject *graphicalObject, const RelAbsVector &rx)
Sets the value of the “rx” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
rx – a RelAbsVector to use as the value of the “rx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const RelAbsVector &rx)
Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
rx – a RelAbsVector to use as the value of the “rx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, const std::string &attribute, const RelAbsVector &rx)
Sets the value of the “rx” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
rx – a RelAbsVector to use as the value of the “rx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const RelAbsVector &rx)
Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
rx – a RelAbsVector to use as the value of the “rx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const double &rx)
Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
rx – a double value to use as the value of the “rx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const double &rx)
Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
rx – a double value to use as the value of the “rx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, const double &rx)
Sets the value of the “rx” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
rx – a double value to use as the value of the “rx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, const std::string &attribute, const double &rx)
Sets the value of the “rx” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
rx – a double value to use as the value of the “rx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document)
Returns the value of the “rx” attribute of the geometric shape corner curvature radius for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “rx” attribute of the geometric shape corner curvature radius for all CompartmentGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &rx)
Sets the “rx” attribute of the geometric shape corner curvature radius for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
rx – a RelAbsVector to use as the value of the “rx” attribute of the geometric shape corner curvature radius.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document)
Returns the value of the “rx” attribute of the geometric shape corner curvature radius for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “rx” attribute of the geometric shape corner curvature radius for all CompartmentGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &rx)
Sets the value of the “rx” attribute of the geometric shape corner curvature radius for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
rx – a double value to use as the value of the “rx” attribute of the geometric shape corner curvature radius.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document)
Returns the value of the “rx” attribute of the geometric shape corner curvature radius for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “rx” attribute of the geometric shape corner curvature radius for all SpeciesGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &rx)
Sets the “rx” attribute of the geometric shape corner curvature radius for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
rx – a RelAbsVector to use as the value of the “rx” attribute of the geometric shape corner curvature radius.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document)
Returns the value of the “rx” attribute of the geometric shape corner curvature radius for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “rx” attribute of the geometric shape corner curvature radius for all SpeciesGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &rx)
Sets the value of the “rx” attribute of the geometric shape corner curvature radius for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
rx – a double value to use as the value of the “rx” attribute of the geometric shape corner curvature radius.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document)
Returns the value of the “rx” attribute of the geometric shape corner curvature radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “rx” attribute of the geometric shape corner curvature radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &rx)
Sets the “rx” attribute of the geometric shape corner curvature radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
rx – a RelAbsVector to use as the value of the “rx” attribute of the geometric shape corner curvature radius.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document)
Returns the value of the “rx” attribute of the geometric shape corner curvature radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “rx” attribute of the geometric shape corner curvature radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &rx)
Sets the value of the “rx” attribute of the geometric shape corner curvature radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
rx – a double value to use as the value of the “rx” attribute of the geometric shape corner curvature radius.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &rx)
Sets the “rx” attribute of the geometric shape corner curvature radius for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
rx – a RelAbsVector to use as the value of the “rx” attribute of the geometric shape corner curvature radius.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &rx)
Sets the value of the “rx” attribute of the geometric shape corner curvature radius for all GraphicalObject objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
rx – a double value to use as the value of the “rx” attribute of the geometric shape corner curvature radius.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “ry” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “ry” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “ry” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “ry” attribute is not set or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “ry” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “ry” 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 “ry” attribute, it is not set, or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “ry” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “ry” 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 “ry” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “ry” attribute of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “ry” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “ry” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “ry” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “ry” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “ry” attribute, it is not set, or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, GraphicalObject *graphicalObject, const RelAbsVector &ry)
Sets the value of the “ry” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
ry – a RelAbsVector to use as the value of the “ry” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const RelAbsVector &ry)
Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
ry – a RelAbsVector to use as the value of the “ry” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, const std::string &attribute, const RelAbsVector &ry)
Sets the value of the “ry” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
ry – a RelAbsVector to use as the value of the “ry” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const RelAbsVector &ry)
Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
ry – a RelAbsVector to use as the value of the “ry” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const double &ry)
Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
ry – a double value to use as the value of the “ry” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const double &ry)
Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
ry – a double value to use as the value of the “ry” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, const double &ry)
Sets the value of the “ry” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
ry – a double value to use as the value of the “ry” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, const std::string &attribute, const double &ry)
Sets the value of the “ry” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
ry – a double value to use as the value of the “ry” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeCornerCurvatureRadiusX(SBMLDocument *document)
Returns the value of the “rx” attribute of the geometric shape corner curvature radius for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “rx” attribute of the geometric shape corner curvature radius for all CompartmentGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &ry)
Sets the “ry” attribute of the geometric shape corner curvature radius for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ry – a RelAbsVector to use as the value of the “ry” attribute of the geometric shape corner curvature radius.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document)
Returns the value of the “ry” attribute of the geometric shape corner curvature radius for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “ry” attribute of the geometric shape corner curvature radius for all CompartmentGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &ry)
Sets the value of the “ry” attribute of the geometric shape corner curvature radius for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ry – a double value to use as the value of the “ry” attribute of the geometric shape corner curvature radius.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document)
Returns the value of the “ry” attribute of the geometric shape corner curvature radius for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “ry” attribute of the geometric shape corner curvature radius for all SpeciesGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &ry)
Sets the “ry” attribute of the geometric shape corner curvature radius for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ry – a RelAbsVector to use as the value of the “ry” attribute of the geometric shape corner curvature radius.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document)
Returns the value of the “ry” attribute of the geometric shape corner curvature radius for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “ry” attribute of the geometric shape corner curvature radius for all SpeciesGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &ry)
Sets the value of the “ry” attribute of the geometric shape corner curvature radius for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ry – a double value to use as the value of the “ry” attribute of the geometric shape corner curvature radius.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document)
Returns the value of the “ry” attribute of the geometric shape corner curvature radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “ry” attribute of the geometric shape corner curvature radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &ry)
Sets the “ry” attribute of the geometric shape corner curvature radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ry – a RelAbsVector to use as the value of the “ry” attribute of the geometric shape corner curvature radius.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document)
Returns the value of the “ry” attribute of the geometric shape corner curvature radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “ry” attribute of the geometric shape corner curvature radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &ry)
Sets the value of the “ry” attribute of the geometric shape corner curvature radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ry – a double value to use as the value of the “ry” attribute of the geometric shape corner curvature radius.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusY(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &ry)
Sets the “ry” attribute of the geometric shape corner curvature radius for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ry – a RelAbsVector to use as the value of the “ry” attribute of the geometric shape corner curvature radius.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCornerCurvatureRadiusYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &ry)
Sets the value of the “ry” attribute of the geometric shape corner curvature radius for all GraphicalObject objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ry – a double value to use as the value of the “ry” attribute of the geometric shape corner curvature radius.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeCenterX(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “cx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “cx” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeCenterX(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “cx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “cx” attribute is not set or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeCenterX(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “cx” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “cx” 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 “cx” attribute, it is not set, or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeCenterX(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “cx” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “cx” 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 “cx” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeCenterXAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “cx” attribute of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “cx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “cx” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeCenterXAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “cx” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “cx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “cx” attribute, it is not set, or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterX(SBMLDocument *document, GraphicalObject *graphicalObject, const RelAbsVector &cx)
Sets the value of the “cx” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
cx – a RelAbsVector to use as the value of the “cx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterX(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const RelAbsVector &cx)
Sets the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
cx – a RelAbsVector to use as the value of the “cx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterX(SBMLDocument *document, const std::string &attribute, const RelAbsVector &cx)
Sets the value of the “cx” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
cx – a RelAbsVector to use as the value of the “cx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterX(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const RelAbsVector &cx)
Sets the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
cx – a RelAbsVector to use as the value of the “cx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterXAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const double &cx)
Sets the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
cx – a double value to use as the value of the “cx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterXAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const double &cx)
Sets the value of the “cx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
cx – a double value to use as the value of the “cx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterXAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, const double &cx)
Sets the value of the “cx” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
cx – a double value to use as the value of the “cx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterXAsDouble(SBMLDocument *document, const std::string &attribute, const double &cx)
Sets the value of the “cx” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
cx – a double value to use as the value of the “cx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeCenterX(SBMLDocument *document)
Returns the value of the “cx” attribute of the geometric shape center for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “cx” attribute of the geometric shape center for all CompartmentGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeCenterX(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &cx)
Sets the “cx” attribute of the geometric shape center for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
cx – a RelAbsVector to use as the value of the “cx” attribute of the geometric shape center.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeCenterXAsDouble(SBMLDocument *document)
Returns the value of the “cx” attribute of the geometric shape center for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “cx” attribute of the geometric shape center for all CompartmentGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeCenterXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &cx)
Sets the value of the “cx” attribute of the geometric shape center for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
cx – a double value to use as the value of the “cx” attribute of the geometric shape center.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeCenterX(SBMLDocument *document)
Returns the value of the “cx” attribute of the geometric shape center for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “cx” attribute of the geometric shape center for all SpeciesGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeCenterX(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &cx)
Sets the “cx” attribute of the geometric shape center for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
cx – a RelAbsVector to use as the value of the “cx” attribute of the geometric shape center.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeCenterXAsDouble(SBMLDocument *document)
Returns the value of the “cx” attribute of the geometric shape center for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “cx” attribute of the geometric shape center for all SpeciesGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeCenterXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &cx)
Sets the value of the “cx” attribute of the geometric shape center for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
cx – a double value to use as the value of the “cx” attribute of the geometric shape center.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeCenterX(SBMLDocument *document)
Returns the value of the “cx” attribute of the geometric shape center for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “cx” attribute of the geometric shape center for all ReactionGlyph objects and their SpeciesReferenceGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeCenterX(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &cx)
Sets the “cx” attribute of the geometric shape center for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
cx – a RelAbsVector to use as the value of the “cx” attribute of the geometric shape center.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeCenterXAsDouble(SBMLDocument *document)
Returns the value of the “cx” attribute of the geometric shape center for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “cx” attribute of the geometric shape center for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeCenterXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &cx)
Sets the value of the “cx” attribute of the geometric shape center for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
cx – a double value to use as the value of the “cx” attribute of the geometric shape center.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterX(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &cx)
Sets the “cx” attribute of the geometric shape center for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
cx – a RelAbsVector to use as the value of the “cx” attribute of the geometric shape center.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &cx)
Sets the value of the “cx” attribute of the geometric shape center for all GraphicalObject objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
cx – a double value to use as the value of the “cx” attribute of the geometric shape center.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeCenterY(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “cy” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “cy” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeCenterY(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “cy” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “cy” attribute is not set or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeCenterY(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “cy” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “cy” 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 “cy” attribute, it is not set, or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeCenterY(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “cy” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “cy” 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 “cy” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeCenterYAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “cy” attribute of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “cy” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “cy” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeCenterYAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “cy” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “cy” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “cy” attribute, it is not set, or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterY(SBMLDocument *document, GraphicalObject *graphicalObject, const RelAbsVector &cy)
Sets the value of the “cy” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
cy – a RelAbsVector to use as the value of the “cy” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterY(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const RelAbsVector &cy)
Sets the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
cy – a RelAbsVector to use as the value of the “cy” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterY(SBMLDocument *document, const std::string &attribute, const RelAbsVector &cy)
Sets the value of the “cy” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
cy – a RelAbsVector to use as the value of the “cy” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterY(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const RelAbsVector &cy)
Sets the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
cy – a RelAbsVector to use as the value of the “cy” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterYAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const double &cy)
Sets the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
cy – a double value to use as the value of the “cy” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterYAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const double &cy)
Sets the value of the “cy” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
cy – a double value to use as the value of the “cy” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterYAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, const double &cy)
Sets the value of the “cy” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
cy – a double value to use as the value of the “cy” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterYAsDouble(SBMLDocument *document, const std::string &attribute, const double &cy)
Sets the value of the “cy” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
cy – a double value to use as the value of the “cy” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeCenterY(SBMLDocument *document)
Returns the value of the “cy” attribute of the geometric shape center for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “cy” attribute of the geometric shape center for all CompartmentGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeCenterY(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &cy)
Sets the “cy” attribute of the geometric shape center for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
cy – a RelAbsVector to use as the value of the “cy” attribute of the geometric shape center.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeCenterYAsDouble(SBMLDocument *document)
Returns the value of the “cy” attribute of the geometric shape center for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “cy” attribute of the geometric shape center for all CompartmentGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeCenterYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &cy)
Sets the value of the “cy” attribute of the geometric shape center for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
cy – a double value to use as the value of the “cy” attribute of the geometric shape center.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeCenterY(SBMLDocument *document)
Returns the value of the “cy” attribute of the geometric shape center for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “cy” attribute of the geometric shape center for all SpeciesGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeCenterY(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &cy)
Sets the “cy” attribute of the geometric shape center for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
cy – a RelAbsVector to use as the value of the “cy” attribute of the geometric shape center.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeCenterYAsDouble(SBMLDocument *document)
Returns the value of the “cy” attribute of the geometric shape center for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “cy” attribute of the geometric shape center for all SpeciesGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeCenterYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &cy)
Sets the value of the “cy” attribute of the geometric shape center for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
cy – a double value to use as the value of the “cy” attribute of the geometric shape center.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeCenterY(SBMLDocument *document)
Returns the value of the “cy” attribute of the geometric shape center for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “cy” attribute of the geometric shape center for all ReactionGlyph objects and their SpeciesReferenceGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeCenterY(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &cy)
Sets the “cy” attribute of the geometric shape center for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
cy – a RelAbsVector to use as the value of the “cy” attribute of the geometric shape center.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeCenterYAsDouble(SBMLDocument *document)
Returns the value of the “cy” attribute of the geometric shape center for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “cy” attribute of the geometric shape center for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeCenterYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &cy)
Sets the value of the “cy” attribute of the geometric shape center for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
cy – a double value to use as the value of the “cy” attribute of the geometric shape center.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterY(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &cy)
Sets the “cy” attribute of the geometric shape center for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
cy – a RelAbsVector to use as the value of the “cy” attribute of the geometric shape center.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeCenterYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &cy)
Sets the value of the “cy” attribute of the geometric shape center for all GraphicalObject objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
cy – a double value to use as the value of the “cy” attribute of the geometric shape center.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeRadiusX(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “rx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “rx” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeRadiusX(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “rx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “rx” attribute is not set or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeRadiusX(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “rx” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “rx” 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 “rx” attribute, it is not set, or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeRadiusX(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “rx” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “rx” 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 “rx” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeRadiusXAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “rx” attribute of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “rx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “rx” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeRadiusXAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “rx” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “rx” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “rx” attribute, it is not set, or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusX(SBMLDocument *document, GraphicalObject *graphicalObject, const RelAbsVector &rx)
Sets the value of the “rx” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
rx – a RelAbsVector to use as the value of the “rx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusX(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const RelAbsVector &rx)
Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
rx – a RelAbsVector to use as the value of the “rx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusX(SBMLDocument *document, const std::string &attribute, const RelAbsVector &rx)
Sets the value of the “rx” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
rx – a RelAbsVector to use as the value of the “rx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusX(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const RelAbsVector &rx)
Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
rx – a RelAbsVector to use as the value of the “rx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusXAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const double &rx)
Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
rx – a double value to use as the value of the “rx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusXAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const double &rx)
Sets the value of the “rx” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
rx – a double value to use as the value of the “rx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusXAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, const double &rx)
Sets the value of the “rx” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
rx – a double value to use as the value of the “rx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusXAsDouble(SBMLDocument *document, const std::string &attribute, const double &rx)
Sets the value of the “rx” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
rx – a double value to use as the value of the “rx” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeRadiusX(SBMLDocument *document)
Returns the value of the “rx” attribute of the geometric shape radius for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “rx” attribute of the geometric shape radius for all CompartmentGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeRadiusX(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &rx)
Sets the “rx” attribute of the geometric shape radius for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
rx – a RelAbsVector to use as the value of the “rx” attribute of the geometric shape radius.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeRadiusXAsDouble(SBMLDocument *document)
Returns the value of the “rx” attribute of the geometric shape radius for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “rx” attribute of the geometric shape radius for all CompartmentGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeRadiusXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &rx)
Sets the value of the “rx” attribute of the geometric shape radius for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
rx – a double value to use as the value of the “rx” attribute of the geometric shape radius.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeRadiusX(SBMLDocument *document)
Returns the value of the “rx” attribute of the geometric shape radius for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “rx” attribute of the geometric shape radius for all SpeciesGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeRadiusX(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &rx)
Sets the “rx” attribute of the geometric shape radius for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
rx – a RelAbsVector to use as the value of the “rx” attribute of the geometric shape radius.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeRadiusXAsDouble(SBMLDocument *document)
Returns the value of the “rx” attribute of the geometric shape radius for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “rx” attribute of the geometric shape radius for all SpeciesGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeRadiusXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &rx)
Sets the value of the “rx” attribute of the geometric shape radius for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
rx – a double value to use as the value of the “rx” attribute of the geometric shape radius.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeRadiusX(SBMLDocument *document)
Returns the value of the “rx” attribute of the geometric shape radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “rx” attribute of the geometric shape radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeRadiusX(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &rx)
Sets the “rx” attribute of the geometric shape radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
rx – a RelAbsVector to use as the value of the “rx” attribute of the geometric shape radius.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeRadiusXAsDouble(SBMLDocument *document)
Returns the value of the “rx” attribute of the geometric shape radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “rx” attribute of the geometric shape radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeRadiusXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &rx)
Sets the value of the “rx” attribute of the geometric shape radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
rx – a double value to use as the value of the “rx” attribute of the geometric shape radius.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusX(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &rx)
Sets the “rx” attribute of the geometric shape radius for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
rx – a RelAbsVector to use as the value of the “rx” attribute of the geometric shape radius.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusXAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &rx)
Sets the value of the “rx” attribute of the geometric shape radius for all GraphicalObject objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
rx – a double value to use as the value of the “rx” attribute of the geometric shape radius.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeRadiusY(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “ry” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “ry” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeRadiusY(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “ry” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “ry” attribute is not set or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeRadiusY(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “ry” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “ry” 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 “ry” attribute, it is not set, or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeRadiusY(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “ry” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “ry” 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 “ry” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeRadiusYAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “ry” attribute of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “ry” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “ry” attribute, it is not set, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeRadiusYAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “ry” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “ry” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject as a double, or
0.0if either Transformation2D object does not exist, does not have “ry” attribute, it is not set, or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusY(SBMLDocument *document, GraphicalObject *graphicalObject, const RelAbsVector &ry)
Sets the value of the “ry” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
ry – a RelAbsVector to use as the value of the “ry” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusY(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const RelAbsVector &ry)
Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
ry – a RelAbsVector to use as the value of the “ry” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusY(SBMLDocument *document, const std::string &attribute, const RelAbsVector &ry)
Sets the value of the “ry” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
ry – a RelAbsVector to use as the value of the “ry” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusY(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const RelAbsVector &ry)
Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
ry – a RelAbsVector to use as the value of the “ry” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusYAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const double &ry)
Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
ry – a double value to use as the value of the “ry” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusYAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const double &ry)
Sets the value of the “ry” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
ry – a double value to use as the value of the “ry” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusYAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, const double &ry)
Sets the value of the “ry” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
ry – a double value to use as the value of the “ry” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusYAsDouble(SBMLDocument *document, const std::string &attribute, const double &ry)
Sets the value of the “ry” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
ry – a double value to use as the value of the “ry” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeRadiusX(SBMLDocument *document)
Returns the value of the “rx” attribute of the geometric shape radius for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “rx” attribute of the geometric shape radius for all CompartmentGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeRadiusY(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &ry)
Sets the “ry” attribute of the geometric shape radius for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ry – a RelAbsVector to use as the value of the “ry” attribute of the geometric shape radius.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeRadiusYAsDouble(SBMLDocument *document)
Returns the value of the “ry” attribute of the geometric shape radius for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “ry” attribute of the geometric shape radius for all CompartmentGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeRadiusYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &ry)
Sets the value of the “ry” attribute of the geometric shape radius for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ry – a double value to use as the value of the “ry” attribute of the geometric shape radius.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeRadiusY(SBMLDocument *document)
Returns the value of the “ry” attribute of the geometric shape radius for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “ry” attribute of the geometric shape radius for all SpeciesGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeRadiusY(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &ry)
Sets the “ry” attribute of the geometric shape radius for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ry – a RelAbsVector to use as the value of the “ry” attribute of the geometric shape radius.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeRadiusYAsDouble(SBMLDocument *document)
Returns the value of the “ry” attribute of the geometric shape radius for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “ry” attribute of the geometric shape radius for all SpeciesGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeRadiusYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &ry)
Sets the value of the “ry” attribute of the geometric shape radius for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ry – a double value to use as the value of the “ry” attribute of the geometric shape radius.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeRadiusY(SBMLDocument *document)
Returns the value of the “ry” attribute of the geometric shape radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “ry” attribute of the geometric shape radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeRadiusY(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &ry)
Sets the “ry” attribute of the geometric shape radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ry – a RelAbsVector to use as the value of the “ry” attribute of the geometric shape radius.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeRadiusYAsDouble(SBMLDocument *document)
Returns the value of the “ry” attribute of the geometric shape radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “ry” attribute of the geometric shape radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeRadiusYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &ry)
Sets the value of the “ry” attribute of the geometric shape radius for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ry – a double value to use as the value of the “ry” attribute of the geometric shape radius.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusY(SBMLDocument *document, unsigned int layoutIndex, const RelAbsVector &ry)
Sets the “ry” attribute of the geometric shape radius for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ry – a RelAbsVector to use as the value of the “ry” attribute of the geometric shape radius.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeRadiusYAsDouble(SBMLDocument *document, unsigned int layoutIndex, const double &ry)
Sets the value of the “ry” attribute of the geometric shape radius for all GraphicalObject objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
ry – a double value to use as the value of the “ry” attribute of the geometric shape radius.
- Returns:
integer value indicating success/failure of the function.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeNumElements(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the number of elements of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D 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
0if either Transformation2D object does not exists, does not have any elements, or the object isNULL.
-
const unsigned int LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeNumElements(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the number of elements of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D 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
0if either Transformation2D object does not exists, does not have any elements, or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isGeometricShapeElementCubicBezier(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Predicates returning
trueif the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is a CubicBezier object.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
- Returns:
trueif the element at the given index of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is a CubicBezier object,falseif either the Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isGeometricShapeElementCubicBezier(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Predicates returning
trueif the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is a CubicBezier object.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
- Returns:
trueif the element at the given index of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is a CubicBezier object,falseif either the Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeElementX(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
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 for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element 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
RelAbsVector()if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeElementX(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 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 attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element 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
RelAbsVector()if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeElementXAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
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 for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element 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 as a double, or
0.0if either Transformation2D object does not exist, does not have any elements, it has less than n elements, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeElementXAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
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 that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element 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 as a double, or
0.0if either Transformation2D object does not exist, does not have any elements, it has less than n elements, or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementX(SBMLDocument *document, GraphicalObject *graphicalObject, const RelAbsVector &x)
Sets the value of the “x” attribute of the first element of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
x – a RelAbsVector to use as the value of the “x” attribute of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementX(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int elementIndex, const RelAbsVector &x)
Sets the value of the “x” attribute of the element at the given index of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementX(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &x)
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 for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementX(SBMLDocument *document, const std::string &attribute, const RelAbsVector &x)
Sets the value of the “x” attribute of the first element of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
x – a RelAbsVector to use as the value of the “x” attribute of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementX(SBMLDocument *document, const std::string &attribute, unsigned int elementIndex, const RelAbsVector &x)
Sets the value of the “x” attribute of the element at the given index of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementX(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &x)
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 that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementXAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, const double &x)
Sets the value of the “x” attribute of the first element of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
x – a double value to use as the value of the “x” attribute of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementXAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the element at the given index of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementXAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &x)
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 for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementXAsDouble(SBMLDocument *document, const std::string &attribute, const double &x)
Sets the value of the “x” attribute of the first element of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
x – a double value to use as the value of the “x” attribute of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementXAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the element at the given index of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementXAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &x)
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 that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeElementX(SBMLDocument *document)
Returns the value of the “x” attribute of the geometric shape element for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the geometric shape element for all CompartmentGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeElementX(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the “x” attribute of the geometric shape element for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeElementXAsDouble(SBMLDocument *document)
Returns the value of the “x” attribute of the geometric shape element for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the geometric shape element for all CompartmentGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeElementXAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the geometric shape element for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeElementX(SBMLDocument *document)
Returns the value of the “x” attribute of the geometric shape element for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the geometric shape element for all SpeciesGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeElementX(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the “x” attribute of the geometric shape element for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeElementXAsDouble(SBMLDocument *document)
Returns the value of the “x” attribute of the geometric shape element for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the geometric shape element for all SpeciesGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeElementXAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the geometric shape element for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeElementX(SBMLDocument *document)
Returns the value of the “x” attribute of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeElementX(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the “x” attribute of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeElementXAsDouble(SBMLDocument *document)
Returns the value of the “x” attribute of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeElementXAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementX(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the “x” attribute of the geometric shape element for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementXAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the geometric shape element for all GraphicalObject objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeElementY(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 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 for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element 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
RelAbsVector()if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeElementY(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 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 attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element 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
RelAbsVector()if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeElementYAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
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 for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element 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 as a double, or
0.0if either Transformation2D object does not exist, does not have any elements, it has less than n elements, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeElementYAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
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 that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element 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 as a double, or
0.0if either Transformation2D object does not exist, does not have any elements, it has less than n elements, or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementY(SBMLDocument *document, GraphicalObject *graphicalObject, const RelAbsVector &y)
Sets the value of the “y” attribute of the first element of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
y – a RelAbsVector to use as the value of the “y” attribute of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementY(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int elementIndex, const RelAbsVector &y)
Sets the value of the “y” attribute of the element at the given index of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementY(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &y)
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 for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementY(SBMLDocument *document, const std::string &attribute, const RelAbsVector &y)
Sets the value of the “y” attribute of the first element of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
y – a RelAbsVector to use as the value of the “y” attribute of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementY(SBMLDocument *document, const std::string &attribute, unsigned int elementIndex, const RelAbsVector &y)
Sets the value of the “y” attribute of the element at the given index of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementY(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &y)
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 that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeElementX(SBMLDocument *document)
Returns the value of the “x” attribute of the geometric shape element for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the geometric shape element for all CompartmentGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeElementY(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the “y” attribute of the geometric shape element for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeElementYAsDouble(SBMLDocument *document)
Returns the value of the “y” attribute of the geometric shape element for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the geometric shape element for all CompartmentGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeElementYAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &y)
Sets the value of the “y” attribute of the geometric shape element for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a double value to use as the value of the “y” attribute of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeElementX(SBMLDocument *document)
Returns the value of the “x” attribute of the geometric shape element for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the geometric shape element for all SpeciesGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeElementY(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the “y” attribute of the geometric shape element for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeElementYAsDouble(SBMLDocument *document)
Returns the value of the “y” attribute of the geometric shape element for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the geometric shape element for all SpeciesGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeElementYAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &y)
Sets the value of the “y” attribute of the geometric shape element for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a double value to use as the value of the “y” attribute of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeElementX(SBMLDocument *document)
Returns the value of the “x” attribute of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeElementY(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the “y” attribute of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeElementYAsDouble(SBMLDocument *document)
Returns the value of the “y” attribute of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeElementYAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &y)
Sets the value of the “y” attribute of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a double value to use as the value of the “y” attribute of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeElementY(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the “y” attribute of the geometric shape element for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeBasePoint1X(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 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 for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element 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
RelAbsVector()if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeBasePoint1X(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 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 attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element 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
RelAbsVector()if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
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 for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
- Returns:
the “x” attribute of 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 as a double, or
0.0if either Transformation2D object does not exist, does not have any elements, it has less than n elements, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
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 that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
- Returns:
the “x” attribute of 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 as a double, or
0.0if either Transformation2D object does not exist, does not have any elements, it has less than n elements, or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1X(SBMLDocument *document, GraphicalObject *graphicalObject, const RelAbsVector &x)
Sets the value of the “x” attribute of the base point 1 of the first element of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 1 of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1X(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int elementIndex, const RelAbsVector &x)
Sets the value of the “x” attribute of the base point 1 of the element at the given index of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 1 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1X(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the value of the “x” attribute of the base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 1 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1X(SBMLDocument *document, const std::string &attribute, const RelAbsVector &x)
Sets the value of the “x” attribute of the base point 1 of the first element of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 1 of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1X(SBMLDocument *document, const std::string &attribute, unsigned int elementIndex, const RelAbsVector &x)
Sets the value of the “x” attribute of the base point 1 of the element at the given index of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 1 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1X(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the value of the “x” attribute of the base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 1 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, const double &x)
Sets the value of the “x” attribute of the base point 1 of the first element of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
x – a double value to use as the value of the “x” attribute of the base point 1 of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the base point 1 of the element at the given index of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 1 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 1 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, const std::string &attribute, const double &x)
Sets the value of the “x” attribute of the base point 1 of the first element of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
x – a double value to use as the value of the “x” attribute of the base point 1 of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the base point 1 of the element at the given index of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 1 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 1 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeBasePoint1X(SBMLDocument *document)
Returns the value of the “x” attribute of the base point 1 of the geometric shape element for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the base point 1 of the geometric shape element for all CompartmentGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeBasePoint1X(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the “x” attribute of the base point 1 of the geometric shape element for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 1 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeBasePoint1XAsDouble(SBMLDocument *document)
Returns the value of the “x” attribute of the base point 1 of the geometric shape element for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the base point 1 of the geometric shape element for all CompartmentGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the base point 1 of the geometric shape element for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 1 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeBasePoint1X(SBMLDocument *document)
Returns the value of the “x” attribute of the base point 1 of the geometric shape element for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the base point 1 of the geometric shape element for all SpeciesGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeBasePoint1X(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the “x” attribute of the base point 1 of the geometric shape element for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 1 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeBasePoint1XAsDouble(SBMLDocument *document)
Returns the value of the “x” attribute of the base point 1 of the geometric shape element for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the base point 1 of the geometric shape element for all SpeciesGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the base point 1 of the geometric shape element for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 1 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeBasePoint1X(SBMLDocument *document)
Returns the value of the “x” attribute of the base point 1 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the base point 1 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeBasePoint1X(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the “x” attribute of the base point 1 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 1 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeBasePoint1XAsDouble(SBMLDocument *document)
Returns the value of the “x” attribute of the base point 1 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the base point 1 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the base point 1 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 1 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1X(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the “x” attribute of the base point 1 of the geometric shape element for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 1 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1XAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the base point 1 of the geometric shape element for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 1 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeBasePoint1Y(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 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 for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element 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
RelAbsVector()if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeBasePoint1Y(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 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 attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element 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
RelAbsVector()if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
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 for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
- Returns:
the “y” attribute of 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 as a double, or
0.0if either Transformation2D object does not exist, does not have any elements, it has less than n elements, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
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 that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
- Returns:
the “y” attribute of 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 as a double, or
0.0if either Transformation2D object does not exist, does not have any elements, it has less than n elements, or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1Y(SBMLDocument *document, GraphicalObject *graphicalObject, const RelAbsVector &y)
Sets the value of the “y” attribute of the base point 1 of the first element of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 1 of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1Y(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int elementIndex, const RelAbsVector &y)
Sets the value of the “y” attribute of the base point 1 of the first element at the given index of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 1 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1Y(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the value of the “y” attribute of the base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 1 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1Y(SBMLDocument *document, const std::string &attribute, const RelAbsVector &y)
Sets the value of the “y” attribute of the base point 1 of the first element of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 1 of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1Y(SBMLDocument *document, const std::string &attribute, unsigned int elementIndex, const RelAbsVector &y)
Sets the value of the “y” attribute of the base point 1 of the element at the given index of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 1 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1Y(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the value of the “y” attribute of the base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 1 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, const double &y)
Sets the value of the “y” attribute of the base point 1 of the first element of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
y – a double value to use as the value of the “y” attribute of the base point 1 of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int elementIndex, const double &y)
Sets the value of the “y” attribute of the base point 1 of the element at the given index of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 1 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &y)
Sets the value of the “y” attribute of the base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 1 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, const std::string &attribute, const double &y)
Sets the value of the “y” attribute of the base point 1 of the first element of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
y – a double value to use as the value of the “y” attribute of the base point 1 of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int elementIndex, const double &y)
Sets the value of the “y” attribute of the base point 1 of the element at the given index of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 1 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &y)
Sets the value of the “y” attribute of the base point 1 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 1 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeBasePoint1Y(SBMLDocument *document)
Returns the value of the “y” attribute of the base point 1 of the geometric shape element for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the base point 1 of the geometric shape element for all CompartmentGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeBasePoint1Y(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the “y” attribute of the base point 1 of the geometric shape element for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 1 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeBasePoint1YAsDouble(SBMLDocument *document)
Returns the value of the “y” attribute of the base point 1 of the geometric shape element for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the base point 1 of the geometric shape element for all CompartmentGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &y)
Sets the value of the “y” attribute of the base point 1 of the geometric shape element for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 1 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeBasePoint1Y(SBMLDocument *document)
Returns the value of the “y” attribute of the base point 1 of the geometric shape element for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the base point 1 of the geometric shape element for all SpeciesGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeBasePoint1Y(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the “y” attribute of the base point 1 of the geometric shape element for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 1 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeBasePoint1YAsDouble(SBMLDocument *document)
Returns the value of the “y” attribute of the base point 1 of the geometric shape element for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the base point 1 of the geometric shape element for all SpeciesGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &y)
Sets the value of the “y” attribute of the base point 1 of the geometric shape element for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 1 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeBasePoint1Y(SBMLDocument *document)
Returns the value of the “y” attribute of the base point 1 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the base point 1 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeBasePoint1Y(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the “y” attribute of the base point 1 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 1 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeBasePoint1YAsDouble(SBMLDocument *document)
Returns the value of the “y” attribute of the base point 1 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the base point 1 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &y)
Sets the value of the “y” attribute of the base point 1 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 1 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1Y(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the “y” attribute of the base point 1 of the geometric shape element for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 1 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint1YAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &y)
Sets the value of the “y” attribute of the base point 1 of the geometric shape element for all GraphicalObject objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 1 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeBasePoint2X(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 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 for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element 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
RelAbsVector()if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeBasePoint2X(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 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 attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element 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
RelAbsVector()if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
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 for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
- Returns:
the “x” attribute of 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 as a double, or
0.0if either Transformation2D object does not exist, does not have any elements, it has less than n elements, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
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 that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
- Returns:
the “x” attribute of 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 as a double, or
0.0if either Transformation2D object does not exist, does not have any elements, it has less than n elements, or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2X(SBMLDocument *document, GraphicalObject *graphicalObject, const RelAbsVector &x)
Sets the value of the “x” attribute of the base point 2 of the first element of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 2 of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2X(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int elementIndex, const RelAbsVector &x)
Sets the value of the “x” attribute of the base point 2 of the element at the given index of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 2 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2X(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the value of the “x” attribute of the base point 2 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 2 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2X(SBMLDocument *document, const std::string &attribute, const RelAbsVector &x)
Sets the value of the “x” attribute of the base point 2 of the first element of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 2 of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2X(SBMLDocument *document, const std::string &attribute, unsigned int elementIndex, const RelAbsVector &x)
Sets the value of the “x” attribute of the base point 2 of the element at the given index of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 2 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2X(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the value of the “x” attribute of the base point 2 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 2 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, const double &x)
Sets the value of the “x” attribute of the base point 2 of the first element of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
x – a double value to use as the value of the “x” attribute of the base point 2 of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the base point 2 of the element at the given index of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 2 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the base point 2 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 2 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, const std::string &attribute, const double &x)
Sets the value of the “x” attribute of the base point 2 of the first element of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
x – a double value to use as the value of the “x” attribute of the base point 2 of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the base point 2 of the element at the given index of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 2 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the base point 2 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 2 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeBasePoint2X(SBMLDocument *document)
Returns the value of the “x” attribute of the base point 2 of the geometric shape element for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the base point 2 of the geometric shape element for all CompartmentGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeBasePoint2X(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the “x” attribute of the base point 2 of the geometric shape element for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 2 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeBasePoint2XAsDouble(SBMLDocument *document)
Returns the value of the “x” attribute of the base point 2 of the geometric shape element for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the base point 2 of the geometric shape element for all CompartmentGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the base point 2 of the geometric shape element for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 2 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeBasePoint2X(SBMLDocument *document)
Returns the value of the “x” attribute of the base point 2 of the geometric shape element for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the base point 2 of the geometric shape element for all SpeciesGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeBasePoint2X(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the “x” attribute of the base point 2 of the geometric shape element for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 2 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeBasePoint2XAsDouble(SBMLDocument *document)
Returns the value of the “x” attribute of the base point 2 of the geometric shape element for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the base point 2 of the geometric shape element for all SpeciesGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the base point 2 of the geometric shape element for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 2 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeBasePoint2X(SBMLDocument *document)
Returns the value of the “x” attribute of the base point 2 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the base point 2 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeBasePoint2X(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the “x” attribute of the base point 2 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 2 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeBasePoint2XAsDouble(SBMLDocument *document)
Returns the value of the “x” attribute of the base point 2 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “x” attribute of the base point 2 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the base point 2 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 2 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2X(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &x)
Sets the “x” attribute of the base point 2 of the geometric shape element for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a RelAbsVector to use as the value of the “x” attribute of the base point 2 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2XAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &x)
Sets the value of the “x” attribute of the base point 2 of the geometric shape element for all GraphicalObject objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
x – a double value to use as the value of the “x” attribute of the base point 2 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeBasePoint2Y(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 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 for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element 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
RelAbsVector()if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object isNULL.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeBasePoint2Y(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 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 attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element 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
RelAbsVector()if either Transformation2D object does not exists, does not have any elements, it has less than n elements, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeBasePoint2YAsDouble(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
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 for this GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
- Returns:
the “y” attribute of 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 as a double, or
0.0if either Transformation2D object does not exist, does not have any elements, it has less than n elements, or the object isNULL.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeBasePoint2YAsDouble(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
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 that matches this attribute (id, role, type) of a GraphicalObject as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
- Returns:
the “y” attribute of 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 as a double, or
0.0if either Transformation2D object does not exist, does not have any elements, it has less than n elements, or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2Y(SBMLDocument *document, GraphicalObject *graphicalObject, const RelAbsVector &y)
Sets the value of the “y” attribute of the base point 2 of the first element of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 2 of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2Y(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int elementIndex, const RelAbsVector &y)
Sets the value of the “y” attribute of the base point 2 of the element at the given index of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 2 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2Y(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the value of the “y” attribute of the base point 2 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 2 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2Y(SBMLDocument *document, const std::string &attribute, const RelAbsVector &y)
Sets the value of the “y” attribute of the base point 2 of the first element of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 2 of the first element of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2Y(SBMLDocument *document, const std::string &attribute, unsigned int elementIndex, const RelAbsVector &y)
Sets the value of the “y” attribute of the base point 2 of the element at the given index of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 2 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2Y(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the value of the “y” attribute of the base point 2 of the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 2 of the element at the given index of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeBasePoint2Y(SBMLDocument *document)
Returns the value of the “y” attribute of the base point 2 of the geometric shape element for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the base point 2 of the geometric shape element for all CompartmentGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeBasePoint2Y(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the “y” attribute of the base point 2 of the geometric shape element for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 2 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeBasePoint2YAsDouble(SBMLDocument *document)
Returns the value of the “y” attribute of the base point 2 of the geometric shape element for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the base point 2 of the geometric shape element for all CompartmentGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeBasePoint2YAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &y)
Sets the value of the “y” attribute of the base point 2 of the geometric shape element for all CompartmentGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 2 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeBasePoint2Y(SBMLDocument *document)
Returns the value of the “y” attribute of the base point 2 of the geometric shape element for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the base point 2 of the geometric shape element for all SpeciesGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeBasePoint2Y(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the “y” attribute of the base point 2 of the geometric shape element for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 2 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeBasePoint2YAsDouble(SBMLDocument *document)
Returns the value of the “y” attribute of the base point 2 of the geometric shape element for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the base point 2 of the geometric shape element for all SpeciesGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeBasePoint2YAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &y)
Sets the value of the “y” attribute of the base point 2 of the geometric shape element for all SpeciesGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 2 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const RelAbsVector LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeBasePoint2Y(SBMLDocument *document)
Returns the value of the “y” attribute of the base point 2 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the base point 2 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects, or
RelAbsVector()if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeBasePoint2Y(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the “y” attribute of the base point 2 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 2 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
const double LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeBasePoint2YAsDouble(SBMLDocument *document)
Returns the value of the “y” attribute of the base point 2 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “y” attribute of the base point 2 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double, or
0.0if the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeBasePoint2YAsDouble(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const double &y)
Sets the value of the “y” attribute of the base point 2 of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects as a double.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a double value to use as the value of the “y” attribute of the base point 2 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeBasePoint2Y(SBMLDocument *document, unsigned int layoutIndex, unsigned int elementIndex, const RelAbsVector &y)
Sets the “y” attribute of the base point 2 of the geometric shape element for all GraphicalObject objects.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
elementIndex – an unsigned int representing the index of the element to retrieve.
y – a RelAbsVector to use as the value of the “y” attribute of the base point 2 of the geometric shape element.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addRenderPointToGeometricShape(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Add a render point to the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addRenderPointToGeometricShape(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Add a render point to the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addRenderCubicBezierToGeometricShape(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Add a render cubic bezier to the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::addRenderCubicBezierToGeometricShape(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Add a render cubic bezier to the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
integer value indicating success/failure of the function.
-
RenderPoint *LIBSBMLNETWORK_CPP_NAMESPACE::removeElementFromGeometricShape(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Remove an element from the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
index – an unsigned int representing the index of the element to be removed.
- Returns:
a pointer to the RenderPoint at the given index of this Transformation2D object, or
NULLif
-
RenderPoint *LIBSBMLNETWORK_CPP_NAMESPACE::removeElementFromGeometricShape(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Remove an element from the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
index – an unsigned int representing the index of the element to be removed.
- Returns:
a pointer to the RenderPoint at the given index of this Transformation2D object, or
NULLif
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isRenderCubicBezier(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type RenderCubicBezier.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
- Returns:
trueif the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type RenderCubicBezier,falseotherwise
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isRenderCubicBezier(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0, unsigned int elementIndex = 0)
Predicates returning
trueif the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is of type RenderCubicBezier.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
elementIndex – an unsigned int representing the index of the element to retrieve.
- Returns:
trueif the element at the given index of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is of type RenderCubicBezier,falseotherwise
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeHref(SBMLDocument *document, GraphicalObject *graphicalObject = 0, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “href” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “href” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “href” attribute is not set or the object isNULL.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::isSetGeometricShapeHref(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Predicates returning
trueif the “href” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject is set.- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
trueif the “href” attribute of the Transformation2D object at the given index of the RenderGroup of the Style for this GraphicalObject is set,falseif either the “href” attribute is not set or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeHref(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex = 0)
Returns the value of the “href” attribute of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “href” 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 “href” attribute, it is not set, or the object isNULL.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getGeometricShapeHref(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex = 0)
Returns the value of the “href” attribute of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
- Returns:
the “href” 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 “href” attribute, it is not set, or the object isNULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeHref(SBMLDocument *document, GraphicalObject *graphicalObject, const std::string &href)
Sets the value of the “href” attribute of the first Transformation2D of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
href – a string value to use as the value of the “href” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeHref(SBMLDocument *document, GraphicalObject *graphicalObject, unsigned int geometricShapeIndex, const std::string &href)
Sets the value of the “href” attribute of the Transformation2D at the given index of the RenderGroup of the Style for this GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
graphicalObject – a pointer to the GraphicalObject object.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
href – a string value to use as the value of the “href” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeHref(SBMLDocument *document, const std::string &attribute, const std::string &href)
Sets the value of the “href” attribute of the first Transformation2D of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
href – a string value to use as the value of the “href” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeHref(SBMLDocument *document, const std::string &attribute, unsigned int geometricShapeIndex, const std::string &href)
Sets the value of the “href” attribute of the Transformation2D at the given index of the RenderGroup of the Style that matches this attribute (id, role, type) of a GraphicalObject.
- Parameters:
document – a pointer to the SBMLDocument object.
attribute – the attribute (id, role, type) of a GraphicalObject.
geometricShapeIndex – an unsigned int representing the index of the Transformation2D to retrieve.
href – a string value to use as the value of the “href” attribute of this Transformation2D object.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getCompartmentGeometricShapeHref(SBMLDocument *document)
Returns the value of the “href” attribute of the geometric shape element for all CompartmentGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “href” attribute of the geometric shape element for all CompartmentGlyph objects, or an empty string if the object is
NULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setCompartmentGeometricShapeHref(SBMLDocument *document, unsigned int layoutIndex, const std::string &href)
Sets the “href” attribute of the geometric shape element for all CompartmentGlyph objects in the specified layout.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
href – a string representing the “href” attribute value.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getSpeciesGeometricShapeHref(SBMLDocument *document)
Returns the value of the “href” attribute of the geometric shape element for all SpeciesGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “href” attribute of the geometric shape element for all SpeciesGlyph objects, or an empty string if the object is
NULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setSpeciesGeometricShapeHref(SBMLDocument *document, unsigned int layoutIndex, const std::string &href)
Sets the “href” attribute of the geometric shape element for all SpeciesGlyph objects in the specified layout.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
href – a string representing the “href” attribute value.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getReactionGeometricShapeHref(SBMLDocument *document)
Returns the value of the “href” attribute of the geometric shape element for all ReactionGlyph objects.
- Parameters:
document – a pointer to the SBMLDocument object.
- Returns:
the “href” attribute of the geometric shape element for all ReactionGlyph objects, or an empty string if the object is
NULL.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setReactionGeometricShapeHref(SBMLDocument *document, unsigned int layoutIndex, const std::string &href)
Sets the “href” attribute of the geometric shape element for all ReactionGlyph objects and their SpeciesReferenceGlyph objects in the specified layout.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
href – a string representing the “href” attribute value.
- Returns:
integer value indicating success/failure of the function.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setGeometricShapeHref(SBMLDocument *document, unsigned int layoutIndex, const std::string &href)
Sets the “href” attribute of the geometric shape element for all GraphicalObject objects in the specified layout.
- Parameters:
document – a pointer to the SBMLDocument object.
layoutIndex – the index number of the Layout object.
href – a string representing the “href” attribute value.
- Returns:
integer value indicating success/failure of the function.
-
const std::string LIBSBMLNETWORK_CPP_NAMESPACE::getStyle(SBMLDocument *document, unsigned 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 – the index number of the Render object.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::setStyle(SBMLDocument *document, unsigned int renderIndex, const std::string &styleName)
Sets the general style features of the SBMLDocument object.
- Parameters:
document – a pointer to the SBMLDocument object.
renderIndex – the index number of the Render object.
styleName – a string representing the name of the style to set.
- Returns:
integer value indicating success/failure of the function.
-
bool LIBSBMLNETWORK_CPP_NAMESPACE::whetherDisplayReactionTextLabel(const std::string &styleName)
Determines whether the style allows the display of the reaction text label.
- Parameters:
styleName – a string representing the name of the style.
- Returns:
boolean value indicating whether to display the reaction text label.
-
int LIBSBMLNETWORK_CPP_NAMESPACE::makeVisible(SBMLDocument *document, unsigned 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::makeInvisible(SBMLDocument *document, unsigned 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::makeCompartmentVisible(SBMLDocument *document, unsigned 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::makeCompartmentInvisible(SBMLDocument *document, unsigned 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::makeSpeciesVisible(SBMLDocument *document, unsigned 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::makeSpeciesInvisible(SBMLDocument *document, unsigned 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::makeReactionVisible(SBMLDocument *document, unsigned 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::makeReactionInvisible(SBMLDocument *document, unsigned 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::makeSpeciesReferenceVisible(SBMLDocument *document, unsigned 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::makeSpeciesReferenceInvisible(SBMLDocument *document, unsigned int layoutIndex)
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::makeLineEndingVisible(SBMLDocument *document, unsigned 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::makeLineEndingInvisible(SBMLDocument *document, unsigned int layoutIndex)
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::isVisible(SBMLDocument *document, GraphicalObject *graphicalObject)
Predicates returning
trueif 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.
graphicalObjectIndex – the index number of the GraphicalObject to return.
layoutIndex – the index number of the Layout to return.
- Returns:
trueif 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::makeVisible(SBMLDocument *document, GraphicalObject *graphicalObject, const bool &applyToConnectedElements = true)
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::makeInvisible(SBMLDocument *document, GraphicalObject *graphicalObject, const bool &applyToConnectedElements = true)
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.