Functions to help and assist in the use of the Plugins framework.
More...
Functions to help and assist in the use of the Plugins framework.
| def python.telplugins_c_api.allocateWeights |
( |
|
dataHandle) | |
|
Allocate weights for tellurium data object.
- Parameters
-
| dataHandle | Handle to a tellurium data object |
- Returns
- Returns true or false indicating if allocating weights were successful or not
| def python.telplugins_c_api.createTelluriumData |
( |
|
rows, |
|
|
|
cols |
|
) |
| |
Create a TelluriumData object.
- Parameters
-
| rows | Number of rows in the data to be created |
| cols | Number of columns in the data to be created |
- Returns
- Returns a handle to Tellurium data if successful, None otherwise
- Note
- Use the freeTelluriumData to free memory allocated
| def telplugins_telluriumdata_api.createTelluriumDataFromFile |
( |
|
fName) | |
|
Create TelluriumData from a file.
- Parameters
-
| fName | Name of input file, including path. If no path is given, the file is read in current working directory |
- Returns
- Returns a handle to RoadRunner data if successful, None otherwise
- Note
- Use the freeTelluriumData to free memory allocated by the returned data
| def python.telplugins_c_api.createTelluriumDataFromFile |
( |
|
fName) | |
|
Create TelluriumData from a file.
- Parameters
-
| fName | Name of input file, including path. If no path is given, the file is read in current working directory |
- Returns
- Returns a handle to Tellurium data if successful, None otherwise
- Note
- Use the freeTelluriumData to free memory allocated by the returned data
| def telplugins_telluriumdata_api.freeTelluriumData |
( |
|
rrDataHandle) | |
|
Free TelluriumData.
- Parameters
-
| dataHandle | Handle to a roadrunner data object |
- Returns
- Returns True or false indicating result
| def python.telplugins_c_api.freeTelluriumData |
( |
|
telDataHandle) | |
|
Free TelluriumData.
- Parameters
-
| dataHandle | Handle to a tellurium data object |
- Returns
- Returns True or false indicating result
| def python.telplugins_c_api.getCopyright |
( |
) | |
|
Get Tellurium Plugins copyright.
- Returns
- Returns a string if successful, None otherwise
| def python.telplugins_c_api.getDataArray |
( |
|
matrixH) | |
|
MATRIX WRAPPERS.
Return unerlying data array for a Tellurium matrix
- Returns
- Returns a ctypes pointer to double object on success, None otherwise
| def python.telplugins_c_api.getLastError |
( |
) | |
|
Get last (API) error.
This returns the last error if any.
- Returns
- Returns a string with an error success, None otherwise
| def python.telplugins_c_api.getNumpyData |
( |
|
telDataHandle) | |
|
Convert tellurium data to Numpy data.
- Parameters
-
| telDataHandle | A handle to a tellurium data object |
- Returns
- Returns a numpy data object
| def telplugins_telluriumdata_api.getTelluriumDataColumnHeader |
( |
|
rrDataHandle) | |
|
Get column header in roadrunner data.
- Parameters
-
| rrDataHandle | A handle to a roadrunner data object |
- Returns
- Returns a numpy data object
| def python.telplugins_c_api.getTelluriumDataColumnHeader |
( |
|
telDataHandle) | |
|
Get column header in tellurium data.
- Parameters
-
| telDataHandle | A handle to a tellurium data object |
- Returns
- Returns a numpy data object
| def python.telplugins_c_api.getTelluriumDataColumnHeaderByIndex |
( |
|
telDataHandle, |
|
|
|
index |
|
) |
| |
Get column header item by index.
- Parameters
-
| telDataHandle | A handle to a tellurium data object |
| index | Index of requested column name |
- Returns
- Returns the column name on success, or None on failure
| def python.telplugins_c_api.getTelluriumDataElement |
( |
|
telDataHandle, |
|
|
|
row, |
|
|
|
col |
|
) |
| |
Get Tellurium data element at row,col.
- Parameters
-
| telDataHandle | A handle to a tellurium data object |
- Returns
- Returns the numeric value at row,col
| def telplugins_telluriumdata_api.getTelluriumDataHandle |
( |
|
rrInstance) | |
|
Retrieve a handle to RoadRunners internal data object.
- Parameters
-
| rrInstance | A RoadRunner instance, as returned from roadrunner.RoadRunner() |
- Returns
- Returns a handle to roadrunners internal data object
| def python.telplugins_c_api.getTelluriumDataNumCols |
( |
|
telDataHandle) | |
|
Get number of columns in a tellurium data object.
- Parameters
-
| telDataHandle | A handle to a tellurium data object |
- Returns
- Returns number of cols in the data object
| def python.telplugins_c_api.getTelluriumDataNumRows |
( |
|
telDataHandle) | |
|
Get number of rows in a tellurium data object.
- Parameters
-
| telDataHandle | A handle to a tellurium data object |
- Returns
- Returns number of rows in the data object
| def python.telplugins_c_api.getTelluriumDataWeight |
( |
|
telDataHandle, |
|
|
|
row, |
|
|
|
col |
|
) |
| |
Get Tellurium data element at row,col.
- Parameters
-
| telDataHandle | A handle to a tellurium data object |
- Returns
- Returns the numeric value at row,col
| def python.telplugins_c_api.getVersion |
( |
) | |
|
Get Tellurium plugin API version.
- Returns
- Returns a string if successful, None otherwise
| def python.telplugins_c_api.hasWeights |
( |
|
dataHandle) | |
|
Check if tellurium data has weights allocated.
- Parameters
-
| dataHandle | Handle to a tellurium data object |
- Returns
- Returns true or false indicating if the data object has weights or not
| def telplugins_telluriumdata_api.readTelluriumData |
( |
|
rrDataHandle, |
|
|
|
fName |
|
) |
| |
Read TelluriumData from a file.
- Parameters
-
| rrDataHandle | A handle to roadunnerdata |
| fName | Name of input file, including path. If no path is given, the file is read in current working directory |
- Returns
- Returns True or false indicating result
| def python.telplugins_c_api.readTelluriumData |
( |
|
telDataHandle, |
|
|
|
fName |
|
) |
| |
Read TelluriumData from a file.
- Parameters
-
| telDataHandle | A handle to roadunnerdata |
| fName | Name of input file, including path. If no path is given, the file is read in current working directory |
- Returns
- Returns True or false indicating result
| def python.telplugins_c_api.setTelluriumDataColumnHeader |
( |
|
telDataHandle, |
|
|
|
hdr |
|
) |
| |
Set column header in tellurium data.
- Parameters
-
| telDataHandle | A handle to a tellurium data object |
| colHeader | A string containing the column header as comma separated values (spaces allowed too) |
- Returns
- True or false indicating success
| def python.telplugins_c_api.setTelluriumDataColumnHeaderByIndex |
( |
|
telDataHandle, |
|
|
|
hdr, |
|
|
|
index |
|
) |
| |
Set column header by index in tellurium data.
- Parameters
-
| telDataHandle | A handle to a tellurium data object |
| index | Index for column name to change |
| colName | A string containing the column name |
- Returns
- True or false indicating success
| def python.telplugins_c_api.setTelluriumDataElement |
( |
|
telDataHandle, |
|
|
|
row, |
|
|
|
col, |
|
|
|
number |
|
) |
| |
Set Tellurium data element at row,col.
- Parameters
-
| telDataHandle | A handle to a tellurium data object |
- Returns
- Returns the numeric value at row,col
| def python.telplugins_c_api.setTelluriumDataWeight |
( |
|
telDataHandle, |
|
|
|
row, |
|
|
|
col, |
|
|
|
number |
|
) |
| |
Set Tellurium data element at row,col.
- Parameters
-
| telDataHandle | A handle to a tellurium data object |
- Returns
- Returns the numeric value at row,col
| def telplugins_telluriumdata_api.writeTelluriumData |
( |
|
rrDataHandle, |
|
|
|
fName |
|
) |
| |
Write TelluriumData to a file.
- Parameters
-
| rrDataHandle | A handle to roadunnerdata |
| fName | Name of output file, including path. If no path is given, the file is written to the current working directory |
- Returns
- Returns True or false indicating result
| def python.telplugins_c_api.writeTelluriumData |
( |
|
telDataHandle, |
|
|
|
fName |
|
) |
| |
Write TelluriumData to a file.
- Parameters
-
| telDataHandle | A handle to roadunnerdata |
| fName | Name of output file, including path. If no path is given, the file is written to the current working directory |
- Returns
- Returns True or false indicating result
1.8.4
