libSBML C# API  libSBML 5.15.2 C# API
libsbmlcs.SBMLExternalValidator Class Reference
Inheritance diagram for libsbmlcs.SBMLExternalValidator:
[legend]

Detailed Description

{core}

Public Member Functions

void addArgument (string arg)
 
void clearArguments ()
 
virtual void clearFailures ()
 Clears this validator's list of failures. More...
 
override void Dispose ()
 
string getArgument (long n)
 
virtual 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 ()
 
 SBMLExternalValidator (SBMLExternalValidator orig)
 
virtual int setDocument (SBMLDocument doc)
 Sets the current SBML document to the given SBMLDocument object. More...
 
void setOutputFileName (string outputFileName)
 
void setProgram (string program)
 
void setSBMLFileName (string sbmlFileName)
 
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 ()
 
virtual long validate (SBMLDocument d)
 Validates the given SBMLDocument object. More...
 
virtual long validate (string filename)
 Validates the SBML document located at the given filename. More...
 

Protected Attributes

bool swigCMemOwn
 

Constructor & Destructor Documentation

◆ SBMLExternalValidator() [1/2]

libsbmlcs.SBMLExternalValidator.SBMLExternalValidator ( )

◆ SBMLExternalValidator() [2/2]

libsbmlcs.SBMLExternalValidator.SBMLExternalValidator ( SBMLExternalValidator  orig)

Member Function Documentation

◆ addArgument()

void libsbmlcs.SBMLExternalValidator.addArgument ( string  arg)

◆ clearArguments()

void libsbmlcs.SBMLExternalValidator.clearArguments ( )

◆ clearFailures()

virtual void libsbmlcs.SBMLValidator.clearFailures ( )
virtualinherited

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.

◆ Dispose()

override void libsbmlcs.SBMLExternalValidator.Dispose ( )
virtual

Reimplemented from libsbmlcs.SBMLValidator.

◆ getArgument()

string libsbmlcs.SBMLExternalValidator.getArgument ( long  n)

◆ getDocument()

virtual SBMLDocument libsbmlcs.SBMLValidator.getDocument ( )
virtualinherited

Returns the current SBML document in use by this validator.

Returns
the current SBML document.
See also
setDocument()

◆ getErrorLog()

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.

◆ getFailure()

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()

◆ getModel()

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()

◆ getNumArguments()

long libsbmlcs.SBMLExternalValidator.getNumArguments ( )

◆ getNumFailures()

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.

◆ getOutputFileName()

string libsbmlcs.SBMLExternalValidator.getOutputFileName ( )

◆ getProgram()

string libsbmlcs.SBMLExternalValidator.getProgram ( )

◆ getSBMLFileName()

string libsbmlcs.SBMLExternalValidator.getSBMLFileName ( )

◆ logFailure()

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.

◆ setDocument()

virtual int libsbmlcs.SBMLValidator.setDocument ( SBMLDocument  doc)
virtualinherited

Sets the current SBML document to the given SBMLDocument object.

Parameters
docthe document to use for this validation.
Returns
integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
See also
getDocument()

◆ setOutputFileName()

void libsbmlcs.SBMLExternalValidator.setOutputFileName ( string  outputFileName)

◆ setProgram()

void libsbmlcs.SBMLExternalValidator.setProgram ( string  program)

◆ setSBMLFileName()

void libsbmlcs.SBMLExternalValidator.setSBMLFileName ( string  sbmlFileName)

◆ SwigDelegateSBMLValidator_0()

delegate IntPtr libsbmlcs.SBMLValidator.SwigDelegateSBMLValidator_0 ( )
inherited

◆ SwigDelegateSBMLValidator_1()

delegate IntPtr libsbmlcs.SBMLValidator.SwigDelegateSBMLValidator_1 ( )
inherited

◆ SwigDelegateSBMLValidator_2()

delegate IntPtr libsbmlcs.SBMLValidator.SwigDelegateSBMLValidator_2 ( )
inherited

◆ SwigDelegateSBMLValidator_3()

delegate int libsbmlcs.SBMLValidator.SwigDelegateSBMLValidator_3 ( IntPtr  doc)
inherited

◆ SwigDelegateSBMLValidator_4()

delegate uint libsbmlcs.SBMLValidator.SwigDelegateSBMLValidator_4 ( )
inherited

◆ SwigDelegateSBMLValidator_5()

delegate void libsbmlcs.SBMLValidator.SwigDelegateSBMLValidator_5 ( )
inherited

◆ validate() [1/2]

virtual long libsbmlcs.SBMLValidator.validate ( SBMLDocument  d)
virtualinherited

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().

◆ validate() [2/2]

virtual long libsbmlcs.SBMLValidator.validate ( string  filename)
virtualinherited

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

◆ swigCMemOwn

bool libsbmlcs.SBMLValidator.swigCMemOwn
protectedinherited