libSBML Perl API  libSBML 5.8.0 Perl API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SBMLExternalValidator.h File Reference

Functions

void addArgument (std::string arg)
 Adds the given argument to the list of additional arguments. More...
 
void clearArguments ()
 Clear all additional arguments. More...
 
virtual SBMLValidatorclone () const
 Creates and returns a deep copy of this converter. More...
 
std::string getArgument (unsigned int n) const
 Returns the argument for the given index. More...
 
const std::vector< std::string > & getArguments () const
 
unsigned int getNumArguments () const
 
const std::string & getOutputFileName () const
 
const std::string & getProgram () const
 
const std::string & getSBMLFileName () const
 
 SBMLExternalValidator ()
 Constructor. More...
 
 SBMLExternalValidator (const SBMLExternalValidator &)
 Copy constructor. More...
 
void setArguments (std::vector< std::string > args)
 Sets the additional arguments. More...
 
void setOutputFileName (std::string outputFileName)
 Sets the output file name. More...
 
void setProgram (std::string program)
 Sets the name of the program to run. More...
 
void setSBMLFileName (std::string sbmlFileName)
 Sets the filename for the temporary file to be created. More...
 
virtual unsigned int validate ()
 the actual conversion More...
 

Variables

std::vector< std::string > mArguments
 
std::string mOutputFileName
 
std::string mProgram
 
std::string mSBMLFileName
 

Function Documentation

void addArgument ( std::string  arg)

Adds the given argument to the list of additional arguments.

Parameters
argthe argument
void clearArguments ( )

Clear all additional arguments.

virtual SBMLValidator* clone ( ) const
virtual

Creates and returns a deep copy of this converter.

Returns
a (deep) copy of this converter.
std::string getArgument ( unsigned int  n) const

Returns the argument for the given index.

Parameters
nthe zero based index of the argument.
Returns
the argument at the given index.
const std::vector<std::string>& getArguments ( ) const
Returns
all arguments
unsigned int getNumArguments ( ) const
Returns
the number of arguments.
const std::string& getOutputFileName ( ) const
Returns
the output file name (this is the file the external program will write)
const std::string& getProgram ( ) const
Returns
the program name of the validator to be run
const std::string& getSBMLFileName ( ) const
Returns
the name of the SBML file (the document of this validator will be written to it)
SBMLExternalValidator ( )

Constructor.

SBMLExternalValidator ( const SBMLExternalValidator &  )

Copy constructor.

void setArguments ( std::vector< std::string >  args)

Sets the additional arguments.

Parameters
argsteh additional arguments
void setOutputFileName ( std::string  outputFileName)

Sets the output file name.

Parameters
outputFileNamethe name of the output XML file
void setProgram ( std::string  program)

Sets the name of the program to run.

Parameters
programthe program to be started
void setSBMLFileName ( std::string  sbmlFileName)

Sets the filename for the temporary file to be created.

Parameters
sbmlFileNamethe temporary name
virtual unsigned int validate ( )
virtual

the actual conversion

Returns
status code represeting success/failure/conversion impossible

Variable Documentation

std::vector<std::string> mArguments
std::string mOutputFileName
std::string mProgram
std::string mSBMLFileName