phraSED-ML  1.0.1
phrasedml_api.h
Go to the documentation of this file.
1 
30 #ifndef PHRASEDML_API_H
31 #define PHRASEDML_API_H
32 
33 #ifndef LIBPHRASEDML_VERSION_STRING //Should be defined in the makefile (from CMakeLists.txt)
34 #define LIBPHRASEDML_VERSION_STRING "v1.0.2"
35 #endif
36 
37 #include "libutil.h"
38 #include "phrasedml-namespace.h"
39 
40 BEGIN_C_DECLS
41 
42 PHRASEDML_CPP_NAMESPACE_BEGIN
43 
62 LIB_EXTERN char* convertFile(const char* filename);
63 
82 LIB_EXTERN char* convertString(const char* model);
83 
87 LIB_EXTERN char* getLastPhrasedError();
88 
92 LIB_EXTERN int getLastPhrasedErrorLine();
93 
97 LIB_EXTERN char* getPhrasedWarnings();
98 
102 LIB_EXTERN char* getLastSEDML();
103 
107 LIB_EXTERN char* getLastPhraSEDML();
108 
114 LIB_EXTERN void setWorkingDirectory(const char* directory);
115 
124 LIB_EXTERN bool setReferencedSBML(const char* URI, const char* sbmlstring);
125 
129 LIB_EXTERN void clearReferencedSBML();
130 
134 LIB_EXTERN void addDotXMLToModelSources();
135 
142 LIB_EXTERN void freeAllPhrased();
143 
144 PHRASEDML_CPP_NAMESPACE_END
145 END_C_DECLS
146 
147 #endif //PHRASEDML_API_H
addDotXMLToModelSources
LIB_EXTERN void addDotXMLToModelSources()
Sometimes, a user may wish to input phrasedml with the name of a model, instead of an actual filename...
clearReferencedSBML
LIB_EXTERN void clearReferencedSBML()
Clears and removes all referenced SBML documents.
getPhrasedWarnings
LIB_EXTERN char * getPhrasedWarnings()
When translating some other format to phraSEDML, elements that are unable to be translated are saved ...
setWorkingDirectory
LIB_EXTERN void setWorkingDirectory(const char *directory)
Sets the working directory for phraSED-ML to look for referenced files.
convertString
LIB_EXTERN char * convertString(const char *model)
Convert a model string from phraSEDML to SEDML, or visa versa.
getLastPhrasedErrorLine
LIB_EXTERN int getLastPhrasedErrorLine()
Returns the line number of the file where the last error was obtained, if the last error was obtained...
convertFile
BEGIN_C_DECLS PHRASEDML_CPP_NAMESPACE_BEGIN LIB_EXTERN char * convertFile(const char *filename)
Convert a file from phraSEDML to SEDML, or visa versa.
getLastPhraSEDML
LIB_EXTERN char * getLastPhraSEDML()
If a previous 'convert' call was successful, the library retains an internal representation of the SE...
getLastSEDML
LIB_EXTERN char * getLastSEDML()
If a previous 'convert' call was successful, the library retains an internal representation of the SE...
getLastPhrasedError
LIB_EXTERN char * getLastPhrasedError()
When any function returns an error condition, a longer description of the problem is stored in memory...
setReferencedSBML
LIB_EXTERN bool setReferencedSBML(const char *URI, const char *sbmlstring)
Allows phrasedml to use the given SBML document as the filename, instead of looking for the file on d...
freeAllPhrased
LIB_EXTERN void freeAllPhrased()
Frees all pointers handed to you by libphraSEDML.