libSBML C# API
libSBML 5.8.0 C# API
|
Public Member Functions | |
void | addArgument (string arg) |
Adds the given argument to the list of additional arguments. More... | |
void | clearArguments () |
Clear all additional arguments. More... | |
void | clearFailures () |
Clears this validator's list of failures. More... | |
SBMLValidator | clone () |
Creates and returns a deep copy of this converter. More... | |
override void | Dispose () |
string | getArgument (long n) |
Returns the argument for the given index. More... | |
SBMLDocument | getDocument () |
Returns the current SBML document in use by this validator. More... | |
SBMLErrorLog | getErrorLog () |
Returns the list of errors or warnings logged during parsing, consistency checking, or attempted translation of this model. More... | |
SBMLError | getFailure (long n) |
Returns the failure object at index n in this validator's list of failures logged during the last run. More... | |
Model | getModel () |
Returns the Model object stored in the SBMLDocument. More... | |
long | getNumArguments () |
long | getNumFailures () |
Returns the number of failures encountered in the last validation run. More... | |
string | getOutputFileName () |
string | getProgram () |
string | getSBMLFileName () |
void | logFailure (SBMLError err) |
Adds the given failure to this list of Validators failures. More... | |
SBMLExternalValidator () | |
Constructor. More... | |
SBMLExternalValidator (SBMLExternalValidator arg0) | |
Copy constructor. More... | |
int | setDocument (SBMLDocument doc) |
Sets the current SBML document to the given SBMLDocument object. More... | |
void | setOutputFileName (string outputFileName) |
Sets the output file name. More... | |
void | setProgram (string program) |
Sets the name of the program to run. More... | |
void | setSBMLFileName (string sbmlFileName) |
Sets the filename for the temporary file to be created. More... | |
delegate IntPtr | SwigDelegateSBMLValidator_0 () |
delegate IntPtr | SwigDelegateSBMLValidator_1 () |
delegate IntPtr | SwigDelegateSBMLValidator_2 () |
delegate int | SwigDelegateSBMLValidator_3 (IntPtr doc) |
delegate uint | SwigDelegateSBMLValidator_4 () |
delegate void | SwigDelegateSBMLValidator_5 () |
long | validate () |
the actual conversion More... | |
long | validate (SBMLDocument d) |
Validates the given SBMLDocument object. More... | |
long | validate (string filename) |
Validates the SBML document located at the given filename . More... | |
Protected Attributes | |
bool | swigCMemOwn |
libsbmlcs.SBMLExternalValidator.SBMLExternalValidator | ( | ) |
Constructor.
libsbmlcs.SBMLExternalValidator.SBMLExternalValidator | ( | SBMLExternalValidator | arg0 | ) |
Copy constructor.
void libsbmlcs.SBMLExternalValidator.addArgument | ( | string | arg | ) |
Adds the given argument to the list of additional arguments.
arg | the argument |
void libsbmlcs.SBMLExternalValidator.clearArguments | ( | ) |
Clear all additional arguments.
|
inherited |
Clears this validator's list of failures.
If you are validating multiple SBML documents with the same validator, call this method after you have processed the list of failures from the last validation run and before validating the next document.
SBMLValidator libsbmlcs.SBMLExternalValidator.clone | ( | ) |
Creates and returns a deep copy of this converter.
|
virtual |
Reimplemented from libsbmlcs.SBMLValidator.
string libsbmlcs.SBMLExternalValidator.getArgument | ( | long | n | ) |
Returns the argument for the given index.
n | the zero based index of the argument. |
|
inherited |
Returns the current SBML document in use by this validator.
|
inherited |
Returns the list of errors or warnings logged during parsing, consistency checking, or attempted translation of this model.
Note that this refers to the SBMLDocument object's error log (i.e., the list returned by SBMLDocument::getErrorLog()). That list of errors and warnings is separate from the validation failures tracked by this validator (i.e., the list returned by getFailures()).
|
inherited |
Returns the failure object at index n in this validator's list of failures logged during the last run.
Callers should use getNumFailures() first, to find out the number of entries in this validator's list of failures.
n | an integer indicating the index of the object to return from the failures list; index values start at 0. |
|
inherited |
Returns the Model object stored in the SBMLDocument.
It is important to note that this method does not create a Model instance. The model in the SBMLDocument must have been created at some prior time, for example using SBMLDocument::createModel() or SBMLDocument::setModel(). This method returns null
if a model does not yet exist.
long libsbmlcs.SBMLExternalValidator.getNumArguments | ( | ) |
|
inherited |
Returns the number of failures encountered in the last validation run.
This method returns the number of failures logged by this validator. This number only reflects this validator's actions; the number may not be the same as the number of errors and warnings logged on the SBMLDocument object's error log (i.e., the object returned by SBMLDocument::getErrorLog()), because other parts of libSBML may log errors and warnings beyond those found by this validator.
string libsbmlcs.SBMLExternalValidator.getOutputFileName | ( | ) |
string libsbmlcs.SBMLExternalValidator.getProgram | ( | ) |
string libsbmlcs.SBMLExternalValidator.getSBMLFileName | ( | ) |
|
inherited |
Adds the given failure to this list of Validators failures.
err | an SBMLError object representing an error or warning |
|
inherited |
Sets the current SBML document to the given SBMLDocument object.
doc | the document to use for this validation |
void libsbmlcs.SBMLExternalValidator.setOutputFileName | ( | string | outputFileName | ) |
Sets the output file name.
outputFileName | the name of the output XML file |
void libsbmlcs.SBMLExternalValidator.setProgram | ( | string | program | ) |
Sets the name of the program to run.
program | the program to be started |
void libsbmlcs.SBMLExternalValidator.setSBMLFileName | ( | string | sbmlFileName | ) |
Sets the filename for the temporary file to be created.
sbmlFileName | the temporary name |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
long libsbmlcs.SBMLExternalValidator.validate | ( | ) |
the actual conversion
|
inherited |
Validates the given SBMLDocument object.
This is identical to calling setDocument() followed by validate().
d | the SBML document to validate |
|
inherited |
Validates the SBML document located at the given filename
.
This is a convenience method that saves callers the trouble of using SBMLReader to read the document first.
filename | the path to the file to be read and validated. |
|
protectedinherited |