libSBML C++ API  libSBML 5.19.7 C++ API
FbcExtension.h File Reference

Definition of FbcExtension, the core module of fbc package. More...

Include dependency graph for FbcExtension.h:
This graph shows which files directly or indirectly include this file:

Classes

class  FbcExtension
 @sbmlpackage{fbc}
More...
 

Macros

#define FBC_CREATE_NS(variable, sbmlns)    EXTENSION_CREATE_NS(FbcPkgNamespaces, variable, sbmlns);
 
#define FBC_CREATE_NS_WITH_VERSION(variable, sbmlns, version)    EXTENSION_CREATE_NS_WITH_VERSION(FbcPkgNamespaces, variable, sbmlns, version);
 

Typedefs

typedef SBMLExtensionNamespaces< FbcExtensionFbcPkgNamespaces
 

Enumerations

enum  FbcVariableType_t {
  FBC_VARIABLE_TYPE_LINEAR ,
  FBC_VARIABLE_TYPE_QUADRATIC ,
  FBC_VARIABLE_TYPE_INVALID
}
 Enumeration of values permitted as the value of the "fbcvariabletype" attribute on Fbc objects. More...
 
enum  SBMLFbcTypeCode_t {
  SBML_FBC_V1ASSOCIATION = 800 ,
  SBML_FBC_FLUXBOUND = 801 ,
  SBML_FBC_FLUXOBJECTIVE = 802 ,
  SBML_FBC_GENEASSOCIATION = 803 ,
  SBML_FBC_OBJECTIVE = 804 ,
  SBML_FBC_ASSOCIATION = 805 ,
  SBML_FBC_GENEPRODUCTASSOCIATION = 806 ,
  SBML_FBC_GENEPRODUCT = 807 ,
  SBML_FBC_GENEPRODUCTREF = 808 ,
  SBML_FBC_AND = 809 ,
  SBML_FBC_OR = 810 ,
  SBML_FBC_USERDEFINEDCONSTRAINTCOMPONENT = 811 ,
  SBML_FBC_USERDEFINEDCONSTRAINT = 812 ,
  SBML_FBC_KEYVALUEPAIR = 813
}
 SBMLFbcTypeCode_t Enumeration of possible types in the libSBML “fbc” package implementation. More...
 

Functions

FbcVariableType_t FbcVariableType_fromString (const char *code)
 Returns the FbcVariableType_t enumeration corresponding to the given string or FBC_VARIABLE_TYPE_INVALIDendif. More...
 
int FbcVariableType_isValid (FbcVariableType_t fvt)
 Predicate returning 1 (true) or 0 (false) depending on whether the given FbcVariableType_t is valid. More...
 
int FbcVariableType_isValidString (const char *code)
 Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid FbcVariableType_t. More...
 
const char * FbcVariableType_toString (FbcVariableType_t fvt)
 Returns the string version of the provided FbcVariableType_t enumeration. More...
 

Detailed Description

Definition of FbcExtension, the core module of fbc package.

Author
Frank T. Bergmann

Macro Definition Documentation

◆ FBC_CREATE_NS

#define FBC_CREATE_NS (   variable,
  sbmlns 
)     EXTENSION_CREATE_NS(FbcPkgNamespaces, variable, sbmlns);

◆ FBC_CREATE_NS_WITH_VERSION

#define FBC_CREATE_NS_WITH_VERSION (   variable,
  sbmlns,
  version 
)     EXTENSION_CREATE_NS_WITH_VERSION(FbcPkgNamespaces, variable, sbmlns, version);

Typedef Documentation

◆ FbcPkgNamespaces

Enumeration Type Documentation

◆ FbcVariableType_t

Enumeration of values permitted as the value of the "fbcvariabletype" attribute on Fbc objects.

See also
Fbc::getFbcvariabletype()
Fbc::setFbcvariabletype()
Enumerator
FBC_VARIABLE_TYPE_LINEAR 

The fbc fbcvariabletype is "linear".

FBC_VARIABLE_TYPE_QUADRATIC 

The fbc fbcvariabletype is "quadratic".

FBC_VARIABLE_TYPE_INVALID 

Invalid FbcVariableType value.

◆ SBMLFbcTypeCode_t

SBMLFbcTypeCode_t Enumeration of possible types in the libSBML “fbc” package implementation.

Enumerator
SBML_FBC_V1ASSOCIATION 

Association (only used in Version 1; replaced in Version 2 with FbcAssociation)

SBML_FBC_FLUXBOUND 

FluxBound

SBML_FBC_FLUXOBJECTIVE 

FluxObjective

SBML_FBC_GENEASSOCIATION 

GeneAssociation (only used in Version 1; replaced in Version 2 with GeneProductAssociation)

SBML_FBC_OBJECTIVE 

Objective

SBML_FBC_ASSOCIATION 

FbcAssociation

SBML_FBC_GENEPRODUCTASSOCIATION 

GeneProductAssociation

SBML_FBC_GENEPRODUCT 

GeneProduct

SBML_FBC_GENEPRODUCTREF 

GeneProductRef

SBML_FBC_AND 

FbcAnd

SBML_FBC_OR 

FbcOr

SBML_FBC_USERDEFINEDCONSTRAINTCOMPONENT 

UserDefinedConstraintComponent

SBML_FBC_USERDEFINEDCONSTRAINT 

UserDefinedConstraint

SBML_FBC_KEYVALUEPAIR 

KeyValuePair

Function Documentation

◆ FbcVariableType_fromString()

FbcVariableType_t FbcVariableType_fromString ( const char *  code)

Returns the FbcVariableType_t enumeration corresponding to the given string or FBC_VARIABLE_TYPE_INVALIDendif.

◆ FbcVariableType_isValid()

int FbcVariableType_isValid ( FbcVariableType_t  fvt)

Predicate returning 1 (true) or 0 (false) depending on whether the given FbcVariableType_t is valid.

Parameters
fvtthe FbcVariableType_t enumeration to query.
Returns
1 (true) if the FbcVariableType_t is FBC_VARIABLE_TYPE_LINEARendif

◆ FbcVariableType_isValidString()

int FbcVariableType_isValidString ( const char *  code)

Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid FbcVariableType_t.

Parameters
codethe string to query.
Returns
1 (true) if the string is "linear", "quadratic", or "invalid FbcVariableType value"; 0 (false) otherwise.
Note
The matching is case-sensitive: "linear" will return 1 (true), but "Linear" will return 0 (false).

◆ FbcVariableType_toString()

const char* FbcVariableType_toString ( FbcVariableType_t  fvt)

Returns the string version of the provided FbcVariableType_t enumeration.

Parameters
fvtthe FbcVariableType_t enumeration value to convert.
Returns
A string corresponding to the given type: "linear", "quadratic", "invalid FbcVariableType value", or NULL if the value is FBC_VARIABLE_TYPE_INVALIDendif