FRAMES2API
Class DataSet

java.lang.Object
  FRAMES2API.DataSet

public class DataSet
extends java.lang.Object

Nested Class Summary

static class	DataSet.ByReferenceBoolean
static class	DataSet.ByReferenceDouble
static class	DataSet.ByReferenceInteger
static class	DataSet.ByReferenceLong
static class	DataSet.ByReferenceString

Constructor Summary

DataSet()

Method Summary

int	ClearVariable(int PID, java.lang.String dataset, java.lang.String variable, int[] indices) Documentation for: ClearVariable Deletes all values associated with a variable.
void	CloseIO(int PID, int cancel) Documentation for: CloseIO This functions closes the INI file and cleans all resources associated with SystemIO.dll.
int	GetDicId(int PID, java.lang.String dataset, DataSet.ByReferenceString dictionary) Documentation for: GetDicId Gets dictionary for specified dataset.
int	GetFloat(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int[] indices, DataSet.ByReferenceDouble value) Documentation for: GetFloat Get an Float from a dataset given the variable name, units and a set of indices.
int	GetIDataSet(int PID, java.lang.String moduleId, java.lang.String inputModuleId, int index, DataSet.ByReferenceString inputDataset) Documentation for: GetIDataSet Get the input dataset name at _idx returned via _set.
int	GetIDicDataSet(int PID, java.lang.String moduleId, java.lang.String dictionary, int index, DataSet.ByReferenceString inputDataset) Documentation for: GetIDicDataSet Get the input dataset name at _idx returned via _set.
int	GetIDicList(int PID, java.lang.String moduleId, java.lang.String fromId, java.lang.String delimiter, DataSet.ByReferenceString list) Documentation for: GetIDicList List of input module dictionaries.
int	GetIDictionary(int PID, java.lang.String moduleId, java.lang.String inputModuleId, int index, DataSet.ByReferenceString inputDictionary) Documentation for: GetIDictionary Get an input dictionary name at _idx returned via _dic.
int	GetIModId(int PID, java.lang.String moduleId, int index, DataSet.ByReferenceString inputModuleId) Documentation for: GetIModId Get an input modules ID at _idx returned via _modId, _idx from 1 to _NumIMod.
int	GetIModList(int PID, java.lang.String moduleId, java.lang.String delimiter, DataSet.ByReferenceString list) Documentation for: GetIModList List of input module names.
int	GetInteger(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int[] indices, DataSet.ByReferenceInteger value) Documentation for: GetInteger Get an Integer from a dataset given the variable name, units and a set of indices.
int	GetISetList(int PID, java.lang.String moduleId, java.lang.String fromId, java.lang.String delimiter, DataSet.ByReferenceString list) Documentation for: GetISetList List of input module dataset names.
int	GetLogical(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int[] indices, DataSet.ByReferenceInteger value) Documentation for: GetLogical Get an Boolean(Logical) from a dataset given the variable name, units and a set of indices.
int	GetODataSet(int PID, java.lang.String moduleId, java.lang.String outputModuleId, int index, DataSet.ByReferenceString outputDataset) Documentation for: GetODataSet Get the output dataset name at _idx returned via _set.
int	GetODicDataSet(int PID, java.lang.String moduleId, java.lang.String dictionary, int index, DataSet.ByReferenceString outputDataset) Documentation for: GetODicDataSet Get the output dataset name at _idx returned via _set.
int	GetODicList(int PID, java.lang.String moduleId, java.lang.String toId, java.lang.String delimiter, DataSet.ByReferenceString list) Documentation for: GetODicList List of output module dictionaries.
int	GetODictionary(int PID, java.lang.String moduleId, java.lang.String outputModuleId, int index, DataSet.ByReferenceString outputDictionary) Documentation for: GetODictionary Get an output dictionary name at _idx returned via _dic.
int	GetOModId(int PID, java.lang.String moduleId, int index, DataSet.ByReferenceString outputModuleId) Documentation for: GetOModId Get an output modules ID at _idx returned via _modId, _idx from 1 to _NumOMod.
int	GetOModList(int PID, java.lang.String moduleId, java.lang.String delimiter, DataSet.ByReferenceString list) Documentation for: GetOModList List of output module names.
int	GetOSetList(int PID, java.lang.String moduleId, java.lang.String toId, java.lang.String delimiter, DataSet.ByReferenceString list) Documentation for: GetOSetList List of output module dataset names.
int	GetString(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int[] indices, DataSet.ByReferenceString value) Documentation for: GetString Get an String(Character(*)) from a dataset given the variable name, units and a set of indices.
int	GetVarDescription(int PID, java.lang.String dictionary, java.lang.String variable, DataSet.ByReferenceString description) Documentation for: GetVarDescription Get the variable description.
int	GetVarDimension(int PID, java.lang.String dictionary, java.lang.String variable, DataSet.ByReferenceInteger dimension) Documentation for: GetVarDimension Get the variables scalar flag.
int	GetVarDimSize(int PID, java.lang.String dataset, java.lang.String variable, int[] indices, DataSet.ByReferenceInteger count) Documentation for: GetVarDimSize Gets the size of the specified dimensions.
int	GetVarMax(int PID, java.lang.String dictionary, java.lang.String variable, DataSet.ByReferenceDouble max) Documentation for: GetVarMax Get the max value for ints and doubles, length for strings, empty for logicals.
int	GetVarMeasure(int PID, java.lang.String dictionary, java.lang.String variable, DataSet.ByReferenceString measure) Documentation for: GetVarMeasure Get the variable measurement type.
int	GetVarMin(int PID, java.lang.String dictionary, java.lang.String variable, DataSet.ByReferenceDouble min) Documentation for: GetVarMin Get the min value for ints and doubles, length for strings, empty for logicals.
int	GetVarPreposition(int PID, java.lang.String dictionary, java.lang.String variable, DataSet.ByReferenceString preposition) Documentation for: GetVarPreposition Get the variables preposition.
int	GetVarPrimaryKey(int PID, java.lang.String dictionary, java.lang.String variable, DataSet.ByReferenceInteger flag) Documentation for: GetVarPrimaryKey Get the variables primarykey flag.
int	GetVarScalar(int PID, java.lang.String dictionary, java.lang.String variable, DataSet.ByReferenceInteger flag) Documentation for: GetVarScalar Get the variables scalar flag.
int	GetVarStochastic(int PID, java.lang.String dictionary, java.lang.String variable, DataSet.ByReferenceInteger flag) Documentation for: GetVarStochastic Get the variables stochastic flag.
int	GetVarType(int PID, java.lang.String dictionary, java.lang.String variable, DataSet.ByReferenceString vtype) Documentation for: GetVarType Get the varible data type.
int	GetVarUnit(int PID, java.lang.String dictionary, java.lang.String variable, DataSet.ByReferenceString unit) Documentation for: GetVarUnit Get the variable unit of measure.
int	IOOk(int PID) Documentation for: IOOk This function checks to see if the status of the Input/Output system.
int	NumIDicDataSet(int PID, java.lang.String moduleId, java.lang.String dictionary, DataSet.ByReferenceInteger count) Documentation for: NumIDicDataSet Get the number of datasets related to this input dictionary.
int	NumIMod(int PID, java.lang.String moduleId, DataSet.ByReferenceInteger count) Documentation for: NumIMod Get the number of modules this module is consuming
int	NumIModSet(int PID, java.lang.String moduleId, java.lang.String inputModuleId, DataSet.ByReferenceInteger count) Documentation for: NumIModSet Get the number of input datasets from _modId.
int	NumODicDataSet(int PID, java.lang.String moduleId, java.lang.String dictionary, DataSet.ByReferenceInteger count) Documentation for: NumODicDataSet Get the number of datasets related to this output dictionary.
int	NumOMod(int PID, java.lang.String moduleId, DataSet.ByReferenceInteger count) Documentation for: NumOMod Get the number of modules this module is producing to
int	NumOModSet(int PID, java.lang.String moduleId, java.lang.String outputModuleId, DataSet.ByReferenceInteger count) Documentation for: NumOModSet Get the number of output datasets from _modId.
int	OpenIO(java.lang.String path, java.lang.String simulation, java.lang.String moduleId) Documentation for: OpenIO OpenIO returns the modules Process IDentification (PID).
int	PutFloat(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int[] indices, double value) Documentation for: PutFloat Put an Floating Point (Real) in a dataset given the variable name, units and a set of indices.
int	PutInteger(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int[] indices, int value) Documentation for: PutInteger Put an Integer in a dataset given the variable name, units and a set of indices.
int	PutLogical(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int[] indices, int value) Documentation for: PutLogical Put an Boolean(Logical) in a dataset given the variable name, units and a set of indices.
int	PutString(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int[] indices, java.lang.String value) Documentation for: PutString Put an String(Character(*)) in a dataset given the variable name, units and a set of indices.
int	ReadInt(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit) Documentation for: ReadInt Read an Integer in a dataset given the variable name, units.
int	ReadInt1(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1) Documentation for: ReadInt1 Read an Integer in a dataset given the variable name, units.
int	ReadInt2(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2) Documentation for: ReadInt2 Read an Integer in a dataset given the variable name, units.
int	ReadInt3(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3) Documentation for: ReadInt3 Read an Integer in a dataset given the variable name, units.
int	ReadInt4(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4) Documentation for: ReadInt4 Read an Integer in a dataset given the variable name, units.
int	ReadInt5(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int index5) Documentation for: ReadInt5 Read an Integer in a dataset given the variable name, units.
int	ReadInt6(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int index5, int index6) Documentation for: ReadInt6 Read an Integer in a dataset given the variable name, units.
int	ReadLog(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit) Documentation for: ReadLog Read an Logical in a dataset given the variable name, units.
int	ReadLog1(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1) Documentation for: ReadLog1 Read an Logical in a dataset given the variable name, units.
int	ReadLog2(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2) Documentation for: ReadLog2 Read an Logical in a dataset given the variable name, units.
int	ReadLog3(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3) Documentation for: ReadLog3 Read an Logical in a dataset given the variable name, units.
int	ReadLog4(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4) Documentation for: ReadLog4 Read an Logical in a dataset given the variable name, units.
int	ReadLog5(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int index5) Documentation for: ReadLog5 Read an Logical in a dataset given the variable name, units.
int	ReadLog6(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int index5, int index6) Documentation for: ReadLog6 Read an Logical in a dataset given the variable name, units.
double	ReadReal(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit) Documentation for: ReadReal Read a real(float) in a dataset given the variable name, units.
double	ReadReal1(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1) Documentation for: ReadReal1 Read a real(float) in a dataset given the variable name, units.
double	ReadReal2(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2) Documentation for: ReadReal2 Read a real(float) in a dataset given the variable name, units.
double	ReadReal3(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3) Documentation for: ReadReal3 Read a real(float) in a dataset given the variable name, units.
double	ReadReal4(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4) Documentation for: ReadReal4 Read a real(float) in a dataset given the variable name, units.
double	ReadReal5(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int index5) Documentation for: ReadReal5 Read a real(float) in a dataset given the variable name, units.
double	ReadReal6(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int index5, int index6) Documentation for: ReadReal6 Read a real(float) in a dataset given the variable name, units.
void	ReadString(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, DataSet.ByReferenceString value) Documentation for: ReadString The space for strings (char *) is expected to be managed by the calling program.
void	ReadString1(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, DataSet.ByReferenceString value) Documentation for: ReadString1 Read a string in a dataset given the variable name, units.
void	ReadString2(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, DataSet.ByReferenceString value) Documentation for: ReadString2 Read a string in a dataset given the variable name, units.
void	ReadString3(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, DataSet.ByReferenceString value) Documentation for: ReadString3 Read a string in a dataset given the variable name, units.
void	ReadString4(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, DataSet.ByReferenceString value) Documentation for: ReadString4 Read a string in a dataset given the variable name, units.
void	ReadString5(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int index5, DataSet.ByReferenceString value) Documentation for: ReadString5 Read a string in a dataset given the variable name, units.
void	ReadString6(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int index5, int index6, DataSet.ByReferenceString value) Documentation for: ReadString6 Read a string in a dataset given the variable name, units.
int	VarLookUp(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String value, DataSet.ByReferenceInteger indices) Documentation for: VarLookUp Lookup an index into the array.
void	WriteInt(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int value) Documentation for: WriteInt Write an Integer in a dataset given the variable name, units.
void	WriteInt1(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int value) Documentation for: WriteInt1 Write an Integer in a dataset given the variable name, units.
void	WriteInt2(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int value) Documentation for: WriteInt2 Write an Integer in a dataset given the variable name, units.
void	WriteInt3(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int value) Documentation for: WriteInt3 Write an Integer in a dataset given the variable name, units.
void	WriteInt4(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int value) Documentation for: WriteInt4 Write an Integer in a dataset given the variable name, units.
void	WriteInt5(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int index5, int value) Documentation for: WriteInt5 Write an Integer in a dataset given the variable name, units.
void	WriteInt6(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int index5, int index6, int value) Documentation for: WriteInt6 Write an Integer in a dataset given the variable name, units.
void	WriteLog(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int value) Documentation for: WriteLog Write an Logical in a dataset given the variable name, units.
void	WriteLog1(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int value) Documentation for: WriteLog1 Write an Logical in a dataset given the variable name, units.
void	WriteLog2(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int value) Documentation for: WriteLog2 Write an Logical in a dataset given the variable name, units.
void	WriteLog3(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int value) Documentation for: WriteLog3 Write an Logical in a dataset given the variable name, units.
void	WriteLog4(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int value) Documentation for: WriteLog4 Write an Logical in a dataset given the variable name, units.
void	WriteLog5(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int index5, int value) Documentation for: WriteLog5 Write an Logical in a dataset given the variable name, units.
void	WriteLog6(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int index5, int index6, int value) Documentation for: WriteLog6 Write an Logical in a dataset given the variable name, units.
void	WriteReal(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, double value) Documentation for: WriteReal Write a real(float) to a dataset given the variable name, units.
void	WriteReal1(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, double value) Documentation for: WriteReal1 Write a real(float) to a dataset given the variable name, units.
void	WriteReal2(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, double value) Documentation for: WriteReal2 Write a real(float) to a dataset given the variable name, units.
void	WriteReal3(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, double value) Documentation for: WriteReal3 Write a real(float) to a dataset given the variable name, units.
void	WriteReal4(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, double value) Documentation for: WriteReal4 Write a real(float) to a dataset given the variable name, units.
void	WriteReal5(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int index5, double value) Documentation for: WriteReal5 Write a real(float) to a dataset given the variable name, units.
void	WriteReal6(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int index5, int index6, double value) Documentation for: WriteReal6 Write a real(float) to a dataset given the variable name, units.
void	WriteString(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, java.lang.String value) Documentation for: WriteString Write a string to a dataset given the variable name, units.
void	WriteString1(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, java.lang.String value) Documentation for: WriteString1 Write a string to a dataset given the variable name, units.
void	WriteString2(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, java.lang.String value) Documentation for: WriteString2 Write a string to a dataset given the variable name, units.
void	WriteString3(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, java.lang.String value) Documentation for: WriteString3 Write a string to a dataset given the variable name, units.
void	WriteString4(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, java.lang.String value) Documentation for: WriteString4 Write a string to a dataset given the variable name, units.
void	WriteString5(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int index5, java.lang.String value) Documentation for: WriteString5 Write a string to a dataset given the variable name, units.
void	WriteString6(int PID, java.lang.String dataset, java.lang.String variable, java.lang.String unit, int index1, int index2, int index3, int index4, int index5, int index6, java.lang.String value) Documentation for: WriteString6 Write a string to a dataset given the variable name, units.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataSet

public DataSet()

Method Detail

IOOk

public int IOOk(int PID)

Documentation for: IOOk This function checks to see if the status of the Input/Output system. A value of SUCCESS is returned if the system is "Ok".

Parameters:

PID - The ProcessID from OpenIO or OpenINI

OpenIO

public int OpenIO(java.lang.String path,
                  java.lang.String simulation,
                  java.lang.String moduleId)

Documentation for: OpenIO OpenIO returns the modules Process IDentification (PID). If the returned pid is less than zero an error occurred. The path\name arguments are to the project file the PID, path, name and modId are given to the module via the command line. For nearly all functions in the API an integer value is returned. The integer value represents whether the function called succeeded or not. A value of SUCCESS indicates that the function did succeed. In error cases a negative value is returned that defines the error. There are functions available to discovery what the error code means.

Parameters:

path - A simulation path

simulation - A simulation name

moduleId - A valid module id

CloseIO

public void CloseIO(int PID,
                    int cancel)

Documentation for: CloseIO This functions closes the INI file and cleans all resources associated with SystemIO.dll. If cancel is 0 then the updated datasets are saved otherwise the updated datasets are thrown away.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

cancel - Cancel update to datasets

NumIMod

public int NumIMod(int PID,
                   java.lang.String moduleId,
                   DataSet.ByReferenceInteger count)

Documentation for: NumIMod Get the number of modules this module is consuming

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

count - The number of input modules

NumOMod

public int NumOMod(int PID,
                   java.lang.String moduleId,
                   DataSet.ByReferenceInteger count)

Documentation for: NumOMod Get the number of modules this module is producing to

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

count - The number of output modules

NumIModSet

public int NumIModSet(int PID,
                      java.lang.String moduleId,
                      java.lang.String inputModuleId,
                      DataSet.ByReferenceInteger count)

Documentation for: NumIModSet Get the number of input datasets from _modId.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

inputModuleId - The input module Id

count - The number of input dataset

NumOModSet

public int NumOModSet(int PID,
                      java.lang.String moduleId,
                      java.lang.String outputModuleId,
                      DataSet.ByReferenceInteger count)

Documentation for: NumOModSet Get the number of output datasets from _modId.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

outputModuleId - The output module Id

count - The number of output dataset

NumIDicDataSet

public int NumIDicDataSet(int PID,
                          java.lang.String moduleId,
                          java.lang.String dictionary,
                          DataSet.ByReferenceInteger count)

Documentation for: NumIDicDataSet Get the number of datasets related to this input dictionary.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

dictionary - The input dictionary

count - The number of input datasets

NumODicDataSet

public int NumODicDataSet(int PID,
                          java.lang.String moduleId,
                          java.lang.String dictionary,
                          DataSet.ByReferenceInteger count)

Documentation for: NumODicDataSet Get the number of datasets related to this output dictionary.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

dictionary - The output dictionary

count - The number of output datasets

GetIDicDataSet

public int GetIDicDataSet(int PID,
                          java.lang.String moduleId,
                          java.lang.String dictionary,
                          int index,
                          DataSet.ByReferenceString inputDataset)

Documentation for: GetIDicDataSet Get the input dataset name at _idx returned via _set.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

dictionary - The input module Id

index - The index of the input module dataset

inputDataset - The name of the input dataset

GetODicDataSet

public int GetODicDataSet(int PID,
                          java.lang.String moduleId,
                          java.lang.String dictionary,
                          int index,
                          DataSet.ByReferenceString outputDataset)

Documentation for: GetODicDataSet Get the output dataset name at _idx returned via _set.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

dictionary - The output module Id

index - The index of the output module dataset

outputDataset - The name of the output dataset

GetIModId

public int GetIModId(int PID,
                     java.lang.String moduleId,
                     int index,
                     DataSet.ByReferenceString inputModuleId)

Documentation for: GetIModId Get an input modules ID at _idx returned via _modId, _idx from 1 to _NumIMod.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

index - The index of the input module

inputModuleId - The input module Id

GetOModId

public int GetOModId(int PID,
                     java.lang.String moduleId,
                     int index,
                     DataSet.ByReferenceString outputModuleId)

Documentation for: GetOModId Get an output modules ID at _idx returned via _modId, _idx from 1 to _NumOMod.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

index - The index of the output module

outputModuleId - The output module Id

GetIDictionary

public int GetIDictionary(int PID,
                          java.lang.String moduleId,
                          java.lang.String inputModuleId,
                          int index,
                          DataSet.ByReferenceString inputDictionary)

Documentation for: GetIDictionary Get an input dictionary name at _idx returned via _dic.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

inputModuleId - The input module Id

index - The index of the input module dataset

inputDictionary - The name of the input dictionary

GetODictionary

public int GetODictionary(int PID,
                          java.lang.String moduleId,
                          java.lang.String outputModuleId,
                          int index,
                          DataSet.ByReferenceString outputDictionary)

Documentation for: GetODictionary Get an output dictionary name at _idx returned via _dic.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

outputModuleId - The output module Id

index - The index of the output module dataset

outputDictionary - The name of the output dictionary

GetDicId

public int GetDicId(int PID,
                    java.lang.String dataset,
                    DataSet.ByReferenceString dictionary)

Documentation for: GetDicId Gets dictionary for specified dataset.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

dictionary - The associated dictionary name

GetIDataSet

public int GetIDataSet(int PID,
                       java.lang.String moduleId,
                       java.lang.String inputModuleId,
                       int index,
                       DataSet.ByReferenceString inputDataset)

Documentation for: GetIDataSet Get the input dataset name at _idx returned via _set.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

inputModuleId - The input module Id

index - The index of the input module dataset

inputDataset - The name of the input dataset

GetODataSet

public int GetODataSet(int PID,
                       java.lang.String moduleId,
                       java.lang.String outputModuleId,
                       int index,
                       DataSet.ByReferenceString outputDataset)

Documentation for: GetODataSet Get the output dataset name at _idx returned via _set.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

outputModuleId - The output module Id

index - The index of the output module dataset

outputDataset - The name of the output dataset

GetIModList

public int GetIModList(int PID,
                       java.lang.String moduleId,
                       java.lang.String delimiter,
                       DataSet.ByReferenceString list)

Documentation for: GetIModList List of input module names.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

delimiter - The delimiter to be used between names of modules. Such as (",",";" etc)

list - A single string containing all the modules in a delimited list.

GetOModList

public int GetOModList(int PID,
                       java.lang.String moduleId,
                       java.lang.String delimiter,
                       DataSet.ByReferenceString list)

Documentation for: GetOModList List of output module names.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

delimiter - The delimiter to be used between values. Such as (",",";" etc)

list - A single string containing all the modules in a delimited list.

GetIDicList

public int GetIDicList(int PID,
                       java.lang.String moduleId,
                       java.lang.String fromId,
                       java.lang.String delimiter,
                       DataSet.ByReferenceString list)

Documentation for: GetIDicList List of input module dictionaries.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

fromId - A valid module id

delimiter - The delimiter to be used between values. Such as (",",";" etc)

list - A single string containing all the dictionaries in a delimited list.

GetODicList

public int GetODicList(int PID,
                       java.lang.String moduleId,
                       java.lang.String toId,
                       java.lang.String delimiter,
                       DataSet.ByReferenceString list)

Documentation for: GetODicList List of output module dictionaries.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

toId - A valid module id

delimiter - The delimiter to be used between values. Such as (",",";" etc)

list - A single string containing all the dictionaries in a delimited list.

GetISetList

public int GetISetList(int PID,
                       java.lang.String moduleId,
                       java.lang.String fromId,
                       java.lang.String delimiter,
                       DataSet.ByReferenceString list)

Documentation for: GetISetList List of input module dataset names.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

fromId - A valid module id

delimiter - The delimiter to be used between values. Such as (",",";" etc)

list - A single string containing all the datasets in a delimited list.

GetOSetList

public int GetOSetList(int PID,
                       java.lang.String moduleId,
                       java.lang.String toId,
                       java.lang.String delimiter,
                       DataSet.ByReferenceString list)

Documentation for: GetOSetList List of output module dataset names.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

moduleId - A valid module id

toId - A valid module id

delimiter - The delimiter to be used between values. Such as (",",";" etc)

list - A single string containing all the datasets in a delimited list.

GetVarDescription

public int GetVarDescription(int PID,
                             java.lang.String dictionary,
                             java.lang.String variable,
                             DataSet.ByReferenceString description)

Documentation for: GetVarDescription Get the variable description.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dictionary - A valid dictionary name

variable - A variable from the dictionary

description - The variable's description

GetVarType

public int GetVarType(int PID,
                      java.lang.String dictionary,
                      java.lang.String variable,
                      DataSet.ByReferenceString vtype)

Documentation for: GetVarType Get the varible data type. The returned string will be "Integer","String","Real", or "Logical"

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dictionary - A valid dictionary name

variable - A variable from the dictionary

vtype - The variable's type

GetVarScalar

public int GetVarScalar(int PID,
                        java.lang.String dictionary,
                        java.lang.String variable,
                        DataSet.ByReferenceInteger flag)

Documentation for: GetVarScalar Get the variables scalar flag.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dictionary - A valid dictionary name

variable - A variable from the dictionary

flag - The variable's scalar flag

GetVarMin

public int GetVarMin(int PID,
                     java.lang.String dictionary,
                     java.lang.String variable,
                     DataSet.ByReferenceDouble min)

Documentation for: GetVarMin Get the min value for ints and doubles, length for strings, empty for logicals.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dictionary - A valid dictionary name

variable - A variable from the dictionary

min - The variable's minimum value or length

GetVarMax

public int GetVarMax(int PID,
                     java.lang.String dictionary,
                     java.lang.String variable,
                     DataSet.ByReferenceDouble max)

Documentation for: GetVarMax Get the max value for ints and doubles, length for strings, empty for logicals.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dictionary - A valid dictionary name

variable - A variable from the dictionary

max - The variable's maximum value or length

GetVarMeasure

public int GetVarMeasure(int PID,
                         java.lang.String dictionary,
                         java.lang.String variable,
                         DataSet.ByReferenceString measure)

Documentation for: GetVarMeasure Get the variable measurement type.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dictionary - A valid dictionary name

variable - A variable from the dictionary

measure - The variable's measure

GetVarUnit

public int GetVarUnit(int PID,
                      java.lang.String dictionary,
                      java.lang.String variable,
                      DataSet.ByReferenceString unit)

Documentation for: GetVarUnit Get the variable unit of measure.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dictionary - A valid dictionary name

variable - A variable from the dictionary

unit - The variable's units of measure

GetVarStochastic

public int GetVarStochastic(int PID,
                            java.lang.String dictionary,
                            java.lang.String variable,
                            DataSet.ByReferenceInteger flag)

Documentation for: GetVarStochastic Get the variables stochastic flag. This flag signifies if the parameter can be modified by an another program and not invalidate any calibration. This allows other programs such and Sensativity/Uncertainty or Parameter estimation programs to modify these parameters.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dictionary - A valid dictionary name

variable - A variable from the dictionary

flag - The variable's stochastic flag

GetVarPreposition

public int GetVarPreposition(int PID,
                             java.lang.String dictionary,
                             java.lang.String variable,
                             DataSet.ByReferenceString preposition)

Documentation for: GetVarPreposition Get the variables preposition. This is the word that would best be used to write a description of this parameters as an index for another. For example the chemical parameter would use "for" as a preposition to make statements such as Concentration for benzene. The preposition greatly facilitates writing descriptive text associated with results.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dictionary - A valid dictionary name

variable - A variable from the dictionary

preposition - The variable's preposition

GetVarPrimaryKey

public int GetVarPrimaryKey(int PID,
                            java.lang.String dictionary,
                            java.lang.String variable,
                            DataSet.ByReferenceInteger flag)

Documentation for: GetVarPrimaryKey Get the variables primarykey flag. Is this parameter a key to information on other parameters. This is used in both databases and in the representation of the data. For example a variable being used to index other variables frequently (like chemical) would indicate that chemical should be a primary key. The typical meaning of primary key from Database design is not incorrect when used here.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dictionary - A valid dictionary name

variable - A variable from the dictionary

flag - The variable's primary key flag

GetVarDimension

public int GetVarDimension(int PID,
                           java.lang.String dictionary,
                           java.lang.String variable,
                           DataSet.ByReferenceInteger dimension)

Documentation for: GetVarDimension Get the variables scalar flag.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dictionary - A valid dictionary name

variable - A variable from the dictionary

dimension - The variable's dimension

GetVarDimSize

public int GetVarDimSize(int PID,
                         java.lang.String dataset,
                         java.lang.String variable,
                         int[] indices,
                         DataSet.ByReferenceInteger count)

Documentation for: GetVarDimSize Gets the size of the specified dimensions. The indices parameters define an array of integers that define the index values that are to be used.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

indices - The set of indexs from which to get the size

count - The number of elements at the specified indexs

VarLookUp

public int VarLookUp(int PID,
                     java.lang.String dataset,
                     java.lang.String variable,
                     java.lang.String value,
                     DataSet.ByReferenceInteger indices)

Documentation for: VarLookUp Lookup an index into the array. The indices parameters define an array of integers that define the index values that are to be used. The specified string value is searched in the variable for the given index values and the last index value is set. A negative number indicates the element could not be found.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

value - The string to find in the vector at the specified indexs

indices - The index within the vector of the element.

ClearVariable

public int ClearVariable(int PID,
                         java.lang.String dataset,
                         java.lang.String variable,
                         int[] indices)

Documentation for: ClearVariable Deletes all values associated with a variable.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

indices - The index within the vector of the element.

GetInteger

public int GetInteger(int PID,
                      java.lang.String dataset,
                      java.lang.String variable,
                      java.lang.String unit,
                      int[] indices,
                      DataSet.ByReferenceInteger value)

Documentation for: GetInteger Get an Integer from a dataset given the variable name, units and a set of indices.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

indices - An array of integers that contains the indexs

value - The integer that was retrieved

GetFloat

public int GetFloat(int PID,
                    java.lang.String dataset,
                    java.lang.String variable,
                    java.lang.String unit,
                    int[] indices,
                    DataSet.ByReferenceDouble value)

Documentation for: GetFloat Get an Float from a dataset given the variable name, units and a set of indices.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

indices - An array of integers that contains the indexs

value - The float(real) that was retrieved

GetLogical

public int GetLogical(int PID,
                      java.lang.String dataset,
                      java.lang.String variable,
                      java.lang.String unit,
                      int[] indices,
                      DataSet.ByReferenceInteger value)

Documentation for: GetLogical Get an Boolean(Logical) from a dataset given the variable name, units and a set of indices. Booleans are treated as integers with either a value of 1 or 0.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

indices - An array of integers that contains the indexs

value - The boolean(logical) that was retrieved

GetString

public int GetString(int PID,
                     java.lang.String dataset,
                     java.lang.String variable,
                     java.lang.String unit,
                     int[] indices,
                     DataSet.ByReferenceString value)

Documentation for: GetString Get an String(Character(*)) from a dataset given the variable name, units and a set of indices.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

indices - An array of integers that contains the indexs

value - The string that was retrieved

PutInteger

public int PutInteger(int PID,
                      java.lang.String dataset,
                      java.lang.String variable,
                      java.lang.String unit,
                      int[] indices,
                      int value)

Documentation for: PutInteger Put an Integer in a dataset given the variable name, units and a set of indices.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

indices - An array of integers that contains the indexs

value - The integer to be stored

PutFloat

public int PutFloat(int PID,
                    java.lang.String dataset,
                    java.lang.String variable,
                    java.lang.String unit,
                    int[] indices,
                    double value)

Documentation for: PutFloat Put an Floating Point (Real) in a dataset given the variable name, units and a set of indices.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

indices - An array of integers that contains the indexs

value - The float(real) to be stored

PutLogical

public int PutLogical(int PID,
                      java.lang.String dataset,
                      java.lang.String variable,
                      java.lang.String unit,
                      int[] indices,
                      int value)

Documentation for: PutLogical Put an Boolean(Logical) in a dataset given the variable name, units and a set of indices. Booleans are treated as integers with either a value of 1 or 0.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

indices - An array of integers that contains the indexs

value - The boolean(logical) to be stored

PutString

public int PutString(int PID,
                     java.lang.String dataset,
                     java.lang.String variable,
                     java.lang.String unit,
                     int[] indices,
                     java.lang.String value)

Documentation for: PutString Put an String(Character(*)) in a dataset given the variable name, units and a set of indices.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

indices - An array of integers that contains the indexs

value - The string to be stored

ReadInt

public int ReadInt(int PID,
                   java.lang.String dataset,
                   java.lang.String variable,
                   java.lang.String unit)

Documentation for: ReadInt Read an Integer in a dataset given the variable name, units. The return value is the integer.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

ReadInt1

public int ReadInt1(int PID,
                    java.lang.String dataset,
                    java.lang.String variable,
                    java.lang.String unit,
                    int index1)

Documentation for: ReadInt1 Read an Integer in a dataset given the variable name, units. The return value is the integer.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

ReadInt2

public int ReadInt2(int PID,
                    java.lang.String dataset,
                    java.lang.String variable,
                    java.lang.String unit,
                    int index1,
                    int index2)

Documentation for: ReadInt2 Read an Integer in a dataset given the variable name, units. The return value is the integer.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

ReadInt3

public int ReadInt3(int PID,
                    java.lang.String dataset,
                    java.lang.String variable,
                    java.lang.String unit,
                    int index1,
                    int index2,
                    int index3)

Documentation for: ReadInt3 Read an Integer in a dataset given the variable name, units. The return value is the integer.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

ReadInt4

public int ReadInt4(int PID,
                    java.lang.String dataset,
                    java.lang.String variable,
                    java.lang.String unit,
                    int index1,
                    int index2,
                    int index3,
                    int index4)

Documentation for: ReadInt4 Read an Integer in a dataset given the variable name, units. The return value is the integer.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

ReadInt5

public int ReadInt5(int PID,
                    java.lang.String dataset,
                    java.lang.String variable,
                    java.lang.String unit,
                    int index1,
                    int index2,
                    int index3,
                    int index4,
                    int index5)

Documentation for: ReadInt5 Read an Integer in a dataset given the variable name, units. The return value is the integer.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

index5 - An index

ReadInt6

public int ReadInt6(int PID,
                    java.lang.String dataset,
                    java.lang.String variable,
                    java.lang.String unit,
                    int index1,
                    int index2,
                    int index3,
                    int index4,
                    int index5,
                    int index6)

Documentation for: ReadInt6 Read an Integer in a dataset given the variable name, units. The return value is the integer.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

index5 - An index

index6 - An index

ReadReal

public double ReadReal(int PID,
                       java.lang.String dataset,
                       java.lang.String variable,
                       java.lang.String unit)

Documentation for: ReadReal Read a real(float) in a dataset given the variable name, units. The return value is the real(float).

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

ReadReal1

public double ReadReal1(int PID,
                        java.lang.String dataset,
                        java.lang.String variable,
                        java.lang.String unit,
                        int index1)

Documentation for: ReadReal1 Read a real(float) in a dataset given the variable name, units. The return value is the real(float).

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

ReadReal2

public double ReadReal2(int PID,
                        java.lang.String dataset,
                        java.lang.String variable,
                        java.lang.String unit,
                        int index1,
                        int index2)

Documentation for: ReadReal2 Read a real(float) in a dataset given the variable name, units. The return value is the real(float).

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

ReadReal3

public double ReadReal3(int PID,
                        java.lang.String dataset,
                        java.lang.String variable,
                        java.lang.String unit,
                        int index1,
                        int index2,
                        int index3)

Documentation for: ReadReal3 Read a real(float) in a dataset given the variable name, units. The return value is the real(float).

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

ReadReal4

public double ReadReal4(int PID,
                        java.lang.String dataset,
                        java.lang.String variable,
                        java.lang.String unit,
                        int index1,
                        int index2,
                        int index3,
                        int index4)

Documentation for: ReadReal4 Read a real(float) in a dataset given the variable name, units. The return value is the real(float).

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

ReadReal5

public double ReadReal5(int PID,
                        java.lang.String dataset,
                        java.lang.String variable,
                        java.lang.String unit,
                        int index1,
                        int index2,
                        int index3,
                        int index4,
                        int index5)

Documentation for: ReadReal5 Read a real(float) in a dataset given the variable name, units. The return value is the real(float).

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

index5 - An index

ReadReal6

public double ReadReal6(int PID,
                        java.lang.String dataset,
                        java.lang.String variable,
                        java.lang.String unit,
                        int index1,
                        int index2,
                        int index3,
                        int index4,
                        int index5,
                        int index6)

Documentation for: ReadReal6 Read a real(float) in a dataset given the variable name, units. The return value is the real(float).

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

index5 - An index

index6 - An index

ReadLog

public int ReadLog(int PID,
                   java.lang.String dataset,
                   java.lang.String variable,
                   java.lang.String unit)

Documentation for: ReadLog Read an Logical in a dataset given the variable name, units. The return value is the integer.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

ReadLog1

public int ReadLog1(int PID,
                    java.lang.String dataset,
                    java.lang.String variable,
                    java.lang.String unit,
                    int index1)

Documentation for: ReadLog1 Read an Logical in a dataset given the variable name, units. The return value is the integer.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

ReadLog2

public int ReadLog2(int PID,
                    java.lang.String dataset,
                    java.lang.String variable,
                    java.lang.String unit,
                    int index1,
                    int index2)

Documentation for: ReadLog2 Read an Logical in a dataset given the variable name, units. The return value is the integer.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

ReadLog3

public int ReadLog3(int PID,
                    java.lang.String dataset,
                    java.lang.String variable,
                    java.lang.String unit,
                    int index1,
                    int index2,
                    int index3)

Documentation for: ReadLog3 Read an Logical in a dataset given the variable name, units. The return value is the integer.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

ReadLog4

public int ReadLog4(int PID,
                    java.lang.String dataset,
                    java.lang.String variable,
                    java.lang.String unit,
                    int index1,
                    int index2,
                    int index3,
                    int index4)

Documentation for: ReadLog4 Read an Logical in a dataset given the variable name, units. The return value is the integer.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

ReadLog5

public int ReadLog5(int PID,
                    java.lang.String dataset,
                    java.lang.String variable,
                    java.lang.String unit,
                    int index1,
                    int index2,
                    int index3,
                    int index4,
                    int index5)

Documentation for: ReadLog5 Read an Logical in a dataset given the variable name, units. The return value is the integer.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

index5 - An index

ReadLog6

public int ReadLog6(int PID,
                    java.lang.String dataset,
                    java.lang.String variable,
                    java.lang.String unit,
                    int index1,
                    int index2,
                    int index3,
                    int index4,
                    int index5,
                    int index6)

Documentation for: ReadLog6 Read an Logical in a dataset given the variable name, units. The return value is the integer.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

index5 - An index

index6 - An index

ReadString

public void ReadString(int PID,
                       java.lang.String dataset,
                       java.lang.String variable,
                       java.lang.String unit,
                       DataSet.ByReferenceString value)

Documentation for: ReadString The space for strings (char *) is expected to be managed by the calling program. If dynamic allocation is used the calling program is responsible for deallocating that space. Read a string in a dataset given the variable name, units. The return value is the string.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

value - The value to that was retrieved

ReadString1

public void ReadString1(int PID,
                        java.lang.String dataset,
                        java.lang.String variable,
                        java.lang.String unit,
                        int index1,
                        DataSet.ByReferenceString value)

Documentation for: ReadString1 Read a string in a dataset given the variable name, units. The return value is the string.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

value - The value to that was retrieved

ReadString2

public void ReadString2(int PID,
                        java.lang.String dataset,
                        java.lang.String variable,
                        java.lang.String unit,
                        int index1,
                        int index2,
                        DataSet.ByReferenceString value)

Documentation for: ReadString2 Read a string in a dataset given the variable name, units. The return value is the string.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

value - The value to that was retrieved

ReadString3

public void ReadString3(int PID,
                        java.lang.String dataset,
                        java.lang.String variable,
                        java.lang.String unit,
                        int index1,
                        int index2,
                        int index3,
                        DataSet.ByReferenceString value)

Documentation for: ReadString3 Read a string in a dataset given the variable name, units. The return value is the string.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

value - The value to that was retrieved

ReadString4

public void ReadString4(int PID,
                        java.lang.String dataset,
                        java.lang.String variable,
                        java.lang.String unit,
                        int index1,
                        int index2,
                        int index3,
                        int index4,
                        DataSet.ByReferenceString value)

Documentation for: ReadString4 Read a string in a dataset given the variable name, units. The return value is the string.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

value - The value to that was retrieved

ReadString5

public void ReadString5(int PID,
                        java.lang.String dataset,
                        java.lang.String variable,
                        java.lang.String unit,
                        int index1,
                        int index2,
                        int index3,
                        int index4,
                        int index5,
                        DataSet.ByReferenceString value)

Documentation for: ReadString5 Read a string in a dataset given the variable name, units. The return value is the string.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

index5 - An index

value - The value to that was retrieved

ReadString6

public void ReadString6(int PID,
                        java.lang.String dataset,
                        java.lang.String variable,
                        java.lang.String unit,
                        int index1,
                        int index2,
                        int index3,
                        int index4,
                        int index5,
                        int index6,
                        DataSet.ByReferenceString value)

Documentation for: ReadString6 Read a string in a dataset given the variable name, units. The return value is the string.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

index5 - An index

index6 - An index

value - The value to that was retrieved

WriteInt

public void WriteInt(int PID,
                     java.lang.String dataset,
                     java.lang.String variable,
                     java.lang.String unit,
                     int value)

Documentation for: WriteInt Write an Integer in a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

value - The value to be stored

WriteInt1

public void WriteInt1(int PID,
                      java.lang.String dataset,
                      java.lang.String variable,
                      java.lang.String unit,
                      int index1,
                      int value)

Documentation for: WriteInt1 Write an Integer in a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

value - The value to be stored

WriteInt2

public void WriteInt2(int PID,
                      java.lang.String dataset,
                      java.lang.String variable,
                      java.lang.String unit,
                      int index1,
                      int index2,
                      int value)

Documentation for: WriteInt2 Write an Integer in a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

value - The value to be stored

WriteInt3

public void WriteInt3(int PID,
                      java.lang.String dataset,
                      java.lang.String variable,
                      java.lang.String unit,
                      int index1,
                      int index2,
                      int index3,
                      int value)

Documentation for: WriteInt3 Write an Integer in a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

value - The value to be stored

WriteInt4

public void WriteInt4(int PID,
                      java.lang.String dataset,
                      java.lang.String variable,
                      java.lang.String unit,
                      int index1,
                      int index2,
                      int index3,
                      int index4,
                      int value)

Documentation for: WriteInt4 Write an Integer in a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

value - The value to be stored

WriteInt5

public void WriteInt5(int PID,
                      java.lang.String dataset,
                      java.lang.String variable,
                      java.lang.String unit,
                      int index1,
                      int index2,
                      int index3,
                      int index4,
                      int index5,
                      int value)

Documentation for: WriteInt5 Write an Integer in a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

index5 - An index

value - The value to be stored

WriteInt6

public void WriteInt6(int PID,
                      java.lang.String dataset,
                      java.lang.String variable,
                      java.lang.String unit,
                      int index1,
                      int index2,
                      int index3,
                      int index4,
                      int index5,
                      int index6,
                      int value)

Documentation for: WriteInt6 Write an Integer in a dataset given the variable name, units. The return value is the integer.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

index5 - An index

index6 - An index

value - The value to be stored

WriteReal

public void WriteReal(int PID,
                      java.lang.String dataset,
                      java.lang.String variable,
                      java.lang.String unit,
                      double value)

Documentation for: WriteReal Write a real(float) to a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

value - The value to be stored

WriteReal1

public void WriteReal1(int PID,
                       java.lang.String dataset,
                       java.lang.String variable,
                       java.lang.String unit,
                       int index1,
                       double value)

Documentation for: WriteReal1 Write a real(float) to a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

value - The value to be stored

WriteReal2

public void WriteReal2(int PID,
                       java.lang.String dataset,
                       java.lang.String variable,
                       java.lang.String unit,
                       int index1,
                       int index2,
                       double value)

Documentation for: WriteReal2 Write a real(float) to a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

value - The value to be stored

WriteReal3

public void WriteReal3(int PID,
                       java.lang.String dataset,
                       java.lang.String variable,
                       java.lang.String unit,
                       int index1,
                       int index2,
                       int index3,
                       double value)

Documentation for: WriteReal3 Write a real(float) to a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

value - The value to be stored

WriteReal4

public void WriteReal4(int PID,
                       java.lang.String dataset,
                       java.lang.String variable,
                       java.lang.String unit,
                       int index1,
                       int index2,
                       int index3,
                       int index4,
                       double value)

Documentation for: WriteReal4 Write a real(float) to a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

value - The value to be stored

WriteReal5

public void WriteReal5(int PID,
                       java.lang.String dataset,
                       java.lang.String variable,
                       java.lang.String unit,
                       int index1,
                       int index2,
                       int index3,
                       int index4,
                       int index5,
                       double value)

Documentation for: WriteReal5 Write a real(float) to a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

index5 - An index

value - The value to be stored

WriteReal6

public void WriteReal6(int PID,
                       java.lang.String dataset,
                       java.lang.String variable,
                       java.lang.String unit,
                       int index1,
                       int index2,
                       int index3,
                       int index4,
                       int index5,
                       int index6,
                       double value)

Documentation for: WriteReal6 Write a real(float) to a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

index5 - An index

index6 - An index

value - The value to be stored

WriteLog

public void WriteLog(int PID,
                     java.lang.String dataset,
                     java.lang.String variable,
                     java.lang.String unit,
                     int value)

Documentation for: WriteLog Write an Logical in a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

value - The value to be stored

WriteLog1

public void WriteLog1(int PID,
                      java.lang.String dataset,
                      java.lang.String variable,
                      java.lang.String unit,
                      int index1,
                      int value)

Documentation for: WriteLog1 Write an Logical in a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

value - The value to be stored

WriteLog2

public void WriteLog2(int PID,
                      java.lang.String dataset,
                      java.lang.String variable,
                      java.lang.String unit,
                      int index1,
                      int index2,
                      int value)

Documentation for: WriteLog2 Write an Logical in a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

value - The value to be stored

WriteLog3

public void WriteLog3(int PID,
                      java.lang.String dataset,
                      java.lang.String variable,
                      java.lang.String unit,
                      int index1,
                      int index2,
                      int index3,
                      int value)

Documentation for: WriteLog3 Write an Logical in a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

value - The value to be stored

WriteLog4

public void WriteLog4(int PID,
                      java.lang.String dataset,
                      java.lang.String variable,
                      java.lang.String unit,
                      int index1,
                      int index2,
                      int index3,
                      int index4,
                      int value)

Documentation for: WriteLog4 Write an Logical in a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

value - The value to be stored

WriteLog5

public void WriteLog5(int PID,
                      java.lang.String dataset,
                      java.lang.String variable,
                      java.lang.String unit,
                      int index1,
                      int index2,
                      int index3,
                      int index4,
                      int index5,
                      int value)

Documentation for: WriteLog5 Write an Logical in a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

index5 - An index

value - The value to be stored

WriteLog6

public void WriteLog6(int PID,
                      java.lang.String dataset,
                      java.lang.String variable,
                      java.lang.String unit,
                      int index1,
                      int index2,
                      int index3,
                      int index4,
                      int index5,
                      int index6,
                      int value)

Documentation for: WriteLog6 Write an Logical in a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

index5 - An index

index6 - An index

value - The value to be stored

WriteString

public void WriteString(int PID,
                        java.lang.String dataset,
                        java.lang.String variable,
                        java.lang.String unit,
                        java.lang.String value)

Documentation for: WriteString Write a string to a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

value - The value to be stored

WriteString1

public void WriteString1(int PID,
                         java.lang.String dataset,
                         java.lang.String variable,
                         java.lang.String unit,
                         int index1,
                         java.lang.String value)

Documentation for: WriteString1 Write a string to a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

value - The value to be stored

WriteString2

public void WriteString2(int PID,
                         java.lang.String dataset,
                         java.lang.String variable,
                         java.lang.String unit,
                         int index1,
                         int index2,
                         java.lang.String value)

Documentation for: WriteString2 Write a string to a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

value - The value to be stored

WriteString3

public void WriteString3(int PID,
                         java.lang.String dataset,
                         java.lang.String variable,
                         java.lang.String unit,
                         int index1,
                         int index2,
                         int index3,
                         java.lang.String value)

Documentation for: WriteString3 Write a string to a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

value - The value to be stored

WriteString4

public void WriteString4(int PID,
                         java.lang.String dataset,
                         java.lang.String variable,
                         java.lang.String unit,
                         int index1,
                         int index2,
                         int index3,
                         int index4,
                         java.lang.String value)

Documentation for: WriteString4 Write a string to a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

value - The value to be stored

WriteString5

public void WriteString5(int PID,
                         java.lang.String dataset,
                         java.lang.String variable,
                         java.lang.String unit,
                         int index1,
                         int index2,
                         int index3,
                         int index4,
                         int index5,
                         java.lang.String value)

Documentation for: WriteString5 Write a string to a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

index5 - An index

value - The value to be stored

WriteString6

public void WriteString6(int PID,
                         java.lang.String dataset,
                         java.lang.String variable,
                         java.lang.String unit,
                         int index1,
                         int index2,
                         int index3,
                         int index4,
                         int index5,
                         int index6,
                         java.lang.String value)

Documentation for: WriteString6 Write a string to a dataset given the variable name, units.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

dataset - The name of a dataset

variable - The name of a variable

unit - A unit within the same measure

index1 - An index

index2 - An index

index3 - An index

index4 - An index

index5 - An index

index6 - An index

value - The value to be stored