libSBML C# API  libSBML 5.8.0 C# API
 All Classes Namespaces Files Functions Variables Properties Pages
libsbmlcs.SBMLExternalValidator Class Reference
Inheritance diagram for libsbmlcs.SBMLExternalValidator:
[legend]

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
 

Constructor & Destructor Documentation

libsbmlcs.SBMLExternalValidator.SBMLExternalValidator ( )

Constructor.

libsbmlcs.SBMLExternalValidator.SBMLExternalValidator ( SBMLExternalValidator  arg0)

Copy constructor.

Member Function Documentation

void libsbmlcs.SBMLExternalValidator.addArgument ( string  arg)

Adds the given argument to the list of additional arguments.

Parameters
argthe argument
void libsbmlcs.SBMLExternalValidator.clearArguments ( )

Clear all additional arguments.

void libsbmlcs.SBMLValidator.clearFailures ( )
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.

Returns
a (deep) copy of this converter.
override void libsbmlcs.SBMLExternalValidator.Dispose ( )
virtual

Reimplemented from libsbmlcs.SBMLValidator.

string libsbmlcs.SBMLExternalValidator.getArgument ( long  n)

Returns the argument for the given index.

Parameters
nthe zero based index of the argument.
Returns
the argument at the given index.
SBMLDocument libsbmlcs.SBMLValidator.getDocument ( )
inherited

Returns the current SBML document in use by this validator.

Returns
the current SBML document
See Also
setDocument()
SBMLErrorLog libsbmlcs.SBMLValidator.getErrorLog ( )
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()).

Returns
the SBMLErrorLog used for the SBMLDocument
SBMLError libsbmlcs.SBMLValidator.getFailure ( long  n)
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.

Parameters
nan integer indicating the index of the object to return from the failures list; index values start at 0.
Returns
the failure at the given index number.
See Also
getNumFailures()
Model libsbmlcs.SBMLValidator.getModel ( )
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.

Returns
the Model contained in this validator's SBMLDocument object.
See Also
SBMLDocument::setModel()
SBMLDocument::createModel()
long libsbmlcs.SBMLExternalValidator.getNumArguments ( )
Returns
the number of arguments.
long libsbmlcs.SBMLValidator.getNumFailures ( )
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.

Returns
the number of errors logged by this validator.
string libsbmlcs.SBMLExternalValidator.getOutputFileName ( )
Returns
the output file name (this is the file the external program will write)
string libsbmlcs.SBMLExternalValidator.getProgram ( )
Returns
the program name of the validator to be run
string libsbmlcs.SBMLExternalValidator.getSBMLFileName ( )
Returns
the name of the SBML file (the document of this validator will be written to it)
void libsbmlcs.SBMLValidator.logFailure ( SBMLError  err)
inherited

Adds the given failure to this list of Validators failures.

Parameters
erran SBMLError object representing an error or warning
int libsbmlcs.SBMLValidator.setDocument ( SBMLDocument  doc)
inherited

Sets the current SBML document to the given SBMLDocument object.

Parameters
docthe document to use for this validation
Returns
an integer value indicating the success/failure of the validation. The possible values returned by this function are
See Also
getDocument()
void libsbmlcs.SBMLExternalValidator.setOutputFileName ( string  outputFileName)

Sets the output file name.

Parameters
outputFileNamethe name of the output XML file
void libsbmlcs.SBMLExternalValidator.setProgram ( string  program)

Sets the name of the program to run.

Parameters
programthe program to be started
void libsbmlcs.SBMLExternalValidator.setSBMLFileName ( string  sbmlFileName)

Sets the filename for the temporary file to be created.

Parameters
sbmlFileNamethe temporary name
delegate IntPtr libsbmlcs.SBMLValidator.SwigDelegateSBMLValidator_0 ( )
inherited
delegate IntPtr libsbmlcs.SBMLValidator.SwigDelegateSBMLValidator_1 ( )
inherited
delegate IntPtr libsbmlcs.SBMLValidator.SwigDelegateSBMLValidator_2 ( )
inherited
delegate int libsbmlcs.SBMLValidator.SwigDelegateSBMLValidator_3 ( IntPtr  doc)
inherited
delegate uint libsbmlcs.SBMLValidator.SwigDelegateSBMLValidator_4 ( )
inherited
delegate void libsbmlcs.SBMLValidator.SwigDelegateSBMLValidator_5 ( )
inherited
long libsbmlcs.SBMLExternalValidator.validate ( )

the actual conversion

Returns
status code represeting success/failure/conversion impossible
long libsbmlcs.SBMLValidator.validate ( SBMLDocument  d)
inherited

Validates the given SBMLDocument object.

This is identical to calling setDocument() followed by validate().

Parameters
dthe SBML document to validate
Returns
the number of validation failures that occurred. The objects describing the actual failures can be retrieved using getFailures().
long libsbmlcs.SBMLValidator.validate ( string  filename)
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.

Parameters
filenamethe path to the file to be read and validated.
Returns
the number of validation failures that occurred. The objects describing the actual failures can be retrieved using getFailures().

Member Data Documentation

bool libsbmlcs.SBMLValidator.swigCMemOwn
protectedinherited