FRAMES2API
Class SystemDev

java.lang.Object
  FRAMES2API.SystemDev

public class SystemDev
extends java.lang.Object

Nested Class Summary

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

Constructor Summary

SystemDev()

Method Summary

int	AddClass(int PID, java.lang.String domainName, java.lang.String className) Documentation for: AddClass For future use - not presently active.
int	AddDomain(int PID, java.lang.String domainName) Documentation for: AddDomain Automatically adds the four class types to the domain.
int	AddGroup(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group) Documentation for: AddGroup The AddGroup function call is made with a process id, a domain name string, a class name string, and a group name string as input to add a group to a domain and class.
int	AddGroupModule(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group, java.lang.String module) Documentation for: AddGroupModule Add a module at the group level.
int	AddIcon(int PID, int scope, java.lang.String domainName, java.lang.String className, java.lang.String group, java.lang.String subgroup, SystemDev.ByReferenceString id) Documentation for: AddIcon Returns the module ID added to the simulation.
int	AddLink(int PID, java.lang.String idfrom, java.lang.String idto) Documentation for: AddLink Returns SUCCESS if the connection is made in the simulation.
int	AddNewDataSet(int PID, java.lang.String dictionary, java.lang.String path, java.lang.String dset) Documentation for: AddNewDataSet Create a new dataset using a registered dictionary.
int	AddNewDictionary(int PID, java.lang.String path, java.lang.String dictionary) Documentation for: AddNewDictionary Create and add dictionary in registry, dictionary name will be set to the parameter dictionary.
int	AddNewModule(int PID, java.lang.String path, java.lang.String module) Documentation for: AddNewModule Create and add a module description in registry module name passed in.
int	AddOpenDataSet(int PID, java.lang.String dictionary, java.lang.String path, SystemDev.ByReferenceString dset) Documentation for: AddOpenDataSet Open a dataset, dataset file must exist or an error will occur.
int	AddOpenDictionary(int PID, java.lang.String path, SystemDev.ByReferenceString dictionary) Documentation for: AddOpenDictionary Open and add dictionary in registry, dictionary returns the dictionary name.
int	AddOpenModule(int PID, java.lang.String path, SystemDev.ByReferenceString module) Documentation for: AddOpenModule Open and add a module description in registry module name passed out.
int	AddScheme(int PID, java.lang.String module, java.lang.String scheme) Documentation for: AddScheme Add a scheme to a module.
int	AddSchemeIDic(int PID, java.lang.String module, java.lang.String scheme, java.lang.String dictionary) Documentation for: AddSchemeIDic Add a dictionary to a scheme for a module.
int	AddSchemeODic(int PID, java.lang.String module, java.lang.String scheme, java.lang.String dictionary) Documentation for: AddSchemeODic Add an output dictionary to a scheme for a module.
int	AddSubGroup(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group, java.lang.String subgroup) Documentation for: AddSubGroup The AddSubGroup function call is made with a process id, a domain name string, a class name string, a group name string, and a subgroup name string as input to add a subgroup to a domain, class, and group.
int	AddSubGrpModule(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group, java.lang.String subgroup, java.lang.String module) Documentation for: AddSubGrpModule Add a module at the subgroup level.
int	AddVariable(int PID, java.lang.String dictionary, java.lang.String variable) Documentation for: AddVariable The AddVariable function call is made with a process id, a dictionary name string, and a variable string as input to add a variable to a dictionary.
int	AddVarIndex(int PID, java.lang.String dictionary, java.lang.String variable, java.lang.String reference, java.lang.String index) Documentation for: AddVarIndex Add a variable index or label index to a variable.
int	CloseINI(int PID, int cancel) Documentation for: CloseINI Closes the entire frames session.
int	CloseSim(int PID) Documentation for: CloseSim Close the simulation without saving.
int	DelClass(int PID, java.lang.String domainName, java.lang.String className) Documentation for: DelClass For future use - not presently active.
int	DelDataSet(int PID, java.lang.String dset) Documentation for: DelDataSet Delete a dataset.
int	DelDictionary(int PID, java.lang.String dictionary) Documentation for: DelDictionary Delete a dictionary from FRAMES 2.0 Startup.ini.
int	DelDomain(int PID, java.lang.String domainName) Documentation for: DelDomain Deletes the domain and it tree.
int	DelGroup(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group) Documentation for: DelGroup The DelGroup function call is made with a process id, a domain name string, a class name string, and a group name string as input to delete a group from a domain and class, including its subgroups and modules.
int	DelGroupModule(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group, java.lang.String module) Documentation for: DelGroupModule Remove a module at the group level.
int	DelIcon(int PID, java.lang.String id) Documentation for: DelIcon Deletes the module ID from the simulation.
int	DelLink(int PID, java.lang.String fromid, java.lang.String toid) Documentation for: DelLink Returns SUCCESS if the connection is dropped in the simulation.
int	DelModule(int PID, java.lang.String module) Documentation for: DelModule Delete a module description dataset from registry.
int	DelScheme(int PID, java.lang.String module, java.lang.String scheme) Documentation for: DelScheme Delete a scheme from a module.
int	DelSchemeIDic(int PID, java.lang.String module, java.lang.String scheme, java.lang.String dictionary) Documentation for: DelSchemeIDic Delete a dictionary from a scheme for a module.
int	DelSchemeODic(int PID, java.lang.String module, java.lang.String scheme, java.lang.String dictionary) Documentation for: DelSchemeODic Delete an output dictionary from a scheme for a module.
int	DelSubGroup(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group, java.lang.String subgroup) Documentation for: DelSubGroup The DelSubGroup function call is made with a process id, a domain name string, a class name string, a group name string, and a subgroup name string as input to delete a subgroup from a domain, class, and group, including its modules.
int	DelSubGrpModule(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group, java.lang.String subgroup, java.lang.String module) Documentation for: DelSubGrpModule Remove a module at the subgroup level.
int	DelVariable(int PID, java.lang.String dictionary, java.lang.String variable) Documentation for: DelVariable Delete a variable from a dictionary.
int	DelVarIndex(int PID, java.lang.String dictionary, java.lang.String variable, java.lang.String reference, java.lang.String index) Documentation for: DelVarIndex Delete an indice from a variable.
int	DemoteVarIndex(int PID, java.lang.String dictionary, java.lang.String variable, java.lang.String reference, java.lang.String index) Documentation for: DemoteVarIndex Move and index down one level in the order of referred indices.
int	DictionaryCount(int PID, SystemDev.ByReferenceInteger count) Documentation for: DictionaryCount Get the count of all dictionaries in registry.
int	DictionaryList(int PID, java.lang.String delimiter, SystemDev.ByReferenceString list) Documentation for: DictionaryList Get the list of all dictionaries in registry in a single delimited string.
int	GetClassCount(int PID, java.lang.String domainName, SystemDev.ByReferenceInteger count) Documentation for: GetClassCount Get the number of classes in a domain.
int	GetClassIcon(int PID, java.lang.String domainName, java.lang.String className, SystemDev.ByReferenceString icon) Documentation for: GetClassIcon Get the icon associated with a class in a domain.
int	GetClassList(int PID, java.lang.String domainName, java.lang.String delimiter, SystemDev.ByReferenceString list) Documentation for: GetClassList The GetClassList function call is made with a process id, a domain name string, and a delimiter string as input, and an empty list string to output a comma-separated list of all classes in a domain.
int	GetDataSetList(int PID, java.lang.String delimiter, SystemDev.ByReferenceString list) Documentation for: GetDataSetList Get the list of all the datasets for simulation.
int	GetDataSetPath(int PID, java.lang.String dataset, SystemDev.ByReferenceString path) Documentation for: GetDataSetPath Get the path associated with a dictionary.
int	GetDicDescription(int PID, java.lang.String dictionary, SystemDev.ByReferenceString description) Documentation for: GetDicDescription Get the description of a dictionary.
int	GetDicPath(int PID, java.lang.String dictionary, SystemDev.ByReferenceString path) Documentation for: GetDicPath Get the path associated with a dictionary.
int	GetDicPrivilege(int PID, java.lang.String dictionary, SystemDev.ByReferenceInteger privilege) Documentation for: GetDicPrivilege Get the privilege of a dictionary.
int	GetDicUpdate(int PID, java.lang.String dictionary, SystemDev.ByReferenceInteger update) Documentation for: GetDicUpdate If the state of a dictionary has changed then update flag will be non-zero.
int	GetDicVersion(int PID, java.lang.String dictionary, SystemDev.ByReferenceInteger version) Documentation for: GetDicVersion Get the version of a dictionary.
int	GetDomainCount(int PID, SystemDev.ByReferenceInteger count) Documentation for: GetDomainCount Get the number of domains in the registery.
int	GetDomainIcon(int PID, java.lang.String domainName, SystemDev.ByReferenceString icon) Documentation for: GetDomainIcon Get the icon associated with a domain.
int	GetDomainList(int PID, java.lang.String delimiter, SystemDev.ByReferenceString list) Documentation for: GetDomainList The GetDomainList function call is made with a process id and a delimiter string as input, and an empty list string to output a comma-separated list of all domains in the registry.
int	GetGroupCount(int PID, java.lang.String domainName, java.lang.String className, SystemDev.ByReferenceInteger count) Documentation for: GetGroupCount Get the number of groups in a class, and domain.
int	GetGroupIcon(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group, SystemDev.ByReferenceString icon) Documentation for: GetGroupIcon Get the icon associated with a class in a domain.
int	GetGroupList(int PID, java.lang.String domainName, java.lang.String className, java.lang.String delimiter, SystemDev.ByReferenceString list) Documentation for: GetGroupList The GetGroupList function call is made with a process id, a domain name string, a class name string, and a delimiter string as input, and an empty list string to output a comma-separated list of all groups in a domain and class.
int	GetGroupModCount(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group, SystemDev.ByReferenceInteger count) Documentation for: GetGroupModCount Get the number of modules at the group level for a group, class, and domain.
int	GetGroupModList(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group, java.lang.String delimiter, SystemDev.ByReferenceString list) Documentation for: GetGroupModList The GetGroupModList function call is made with a process id, a domain name string, a class name string, a group name string, and a delimiter string as input, and an empty list string to output a comma-separated list of all subgroups in a domain, class, and group.
int	GetIconMod(int PID, java.lang.String id, SystemDev.ByReferenceString module, SystemDev.ByReferenceString scheme) Documentation for: GetIconMod Sets module and scheme associated with an icon.
int	GetIconModelArgs(int PID, java.lang.String id, SystemDev.ByReferenceString path, SystemDev.ByReferenceString cmdline) Documentation for: GetIconModelArgs The passive part of the icon is the model itself that requires NO user to be active during its execution.
int	GetIconUIArgs(int PID, java.lang.String id, SystemDev.ByReferenceString path, SystemDev.ByReferenceString cmdline) Documentation for: GetIconUIArgs Get the commandline arguments for a given id.
int	GetIconUIDic(int PID, java.lang.String id, SystemDev.ByReferenceString dictionary) Documentation for: GetIconUIDic Returns the dic for the module icon returns "" when no set exists.
int	GetIconUISet(int PID, java.lang.String id, SystemDev.ByReferenceString dataset) Documentation for: GetIconUISet Returns the set for the module icon returns "" when no set exists.
int	GetModDimSize(int PID, java.lang.String id, java.lang.String variable, int[] indices, SystemDev.ByReferenceInteger count) Documentation for: GetModDimSize Get the dimension size for the dataset information about modules.
int	GetModDouble(int PID, java.lang.String id, java.lang.String variable, java.lang.String unit, int[] indices, SystemDev.ByReferenceDouble value) Documentation for: GetModDouble Get an integer from meta data about a module.
int	GetModInteger(int PID, java.lang.String id, java.lang.String variable, java.lang.String unit, int[] indices, SystemDev.ByReferenceInteger value) Documentation for: GetModInteger Get an integer from meta data about a module.
int	GetModLogical(int PID, java.lang.String id, java.lang.String variable, java.lang.String unit, int[] indices, SystemDev.ByReferenceInteger value) Documentation for: GetModLogical Get an integer from meta data about a module.
int	GetModPath(int PID, java.lang.String module, SystemDev.ByReferenceString path) Documentation for: GetModPath Get module path associated with a module.
int	GetModString(int PID, java.lang.String id, java.lang.String variable, java.lang.String unit, int[] indices, SystemDev.ByReferenceString value) Documentation for: GetModString Get an integer from meta data about a module.
int	GetSim(int PID, SystemDev.ByReferenceString path, SystemDev.ByReferenceString simulation) Documentation for: GetSim Get current simulation name for which all simulation functions will use for this PID.
int	GetSimList(int PID, java.lang.String delimiter, SystemDev.ByReferenceString list) Documentation for: GetSimList Get the list of all simulations loaded in the environment.
int	GetSubGrpCount(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group, SystemDev.ByReferenceInteger count) Documentation for: GetSubGrpCount Get the number of subgroups in a group, class and domain.The GetSubGrpCount function call is made with a process id, a domain name string, a class name string, and a group name string as input, and an empty count integer to output a count of all subgroups in a domain, class, and group.
int	GetSubGrpIcon(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group, java.lang.String subgroup, SystemDev.ByReferenceString icon) Documentation for: GetSubGrpIcon Get the icon associated with a class in a domain.
int	GetSubGrpList(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group, java.lang.String delimiter, SystemDev.ByReferenceString list) Documentation for: GetSubGrpList The GetSubGrpList function call is made with a process id, a domain name string, a class name string, a group name string, and a delimiter string as input, and an empty list string to output a comma-separated list of all subgroups in a domain, class, and group.
int	GetSubGrpModCount(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group, java.lang.String subgroup, SystemDev.ByReferenceInteger count) Documentation for: GetSubGrpModCount Get the number of modules at the subgroup level for a subgroup, group, class, and domain.
int	GetSubGrpModList(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group, java.lang.String subgroup, java.lang.String delimiter, SystemDev.ByReferenceString list) Documentation for: GetSubGrpModList The GetSubGrpModList function call is made with a process id, a domain name string, a class name string, a group name string, a subgroup name string, and a delimiter string as input, and an empty list string to output a comma-separated list of all subgroups in a domain, class, and group.
int	GetVarCount(int PID, java.lang.String dictionary, SystemDev.ByReferenceInteger count) Documentation for: GetVarCount Gets the varible count of a dictionary.
int	GetVarIndexCount(int PID, java.lang.String dictionary, java.lang.String variable, SystemDev.ByReferenceInteger count) Documentation for: GetVarIndexCount Get the count of indices for a variable.
int	GetVarList(int PID, java.lang.String dictionary, java.lang.String delimiter, SystemDev.ByReferenceString list) Documentation for: GetVarList Gets the delimited list of all variable names in a dictionary.
int	GetVarName(int PID, java.lang.String dictionary, int index, SystemDev.ByReferenceString variable) Documentation for: GetVarName Gets the name of the nth (index) variable in the dictionary.
int	IsIconInfoOk(int PID, java.lang.String id) Documentation for: IsIconInfoOk Returns SUCCESS if no error if the information for the module is complete (i.e.
int	IsIconModelOk(int PID, java.lang.String id) Documentation for: IsIconModelOk Returns SUCCESS if no error during the execution of the model.
int	IsIconUIOk(int PID, java.lang.String id) Documentation for: IsIconUIOk Returns SUCCESS if no error during the execution of the user interface.
int	Launcher(java.lang.String path, java.lang.String cmdline, int wait) Documentation for: Launcher Launches the specified module.
int	LaunchTool(int PID, java.lang.String moduleName, int isSystemTool, java.lang.String iconId) Documentation for: LaunchTool Launches the specified module.
int	ModuleCount(int PID, SystemDev.ByReferenceInteger count) Documentation for: ModuleCount Get the count of all modules in registry.
int	ModuleList(int PID, java.lang.String delimiter, SystemDev.ByReferenceString list) Documentation for: ModuleList Get the list of all module desriptions in registry.
int	NewSim(int PID, java.lang.String path, java.lang.String simulation) Documentation for: NewSim Open a new simulation return a simulation dataset name.
int	OpenINI(java.lang.String path) Documentation for: OpenINI Open the INI and returns a PID.
int	OpenSim(int PID, java.lang.String path, SystemDev.ByReferenceString simulation) Documentation for: OpenSim Open an existing simulation return a simulation dataset name.
int	PromoteVarIndex(int PID, java.lang.String dictionary, java.lang.String variable, java.lang.String reference, java.lang.String index) Documentation for: PromoteVarIndex Move and index up one level in the order of referred indices.
int	PutModDouble(int PID, java.lang.String id, java.lang.String variable, java.lang.String unit, int[] indices, double value) Documentation for: PutModDouble Put a double of meta data about a module.
int	PutModInteger(int PID, java.lang.String id, java.lang.String variable, java.lang.String unit, int[] indices, int value) Documentation for: PutModInteger Put an integer of meta data about a module.
int	PutModLogical(int PID, java.lang.String id, java.lang.String variable, java.lang.String unit, int[] indices, int value) Documentation for: PutModLogical Put an logical of meta data about a module.
int	PutModString(int PID, java.lang.String id, java.lang.String variable, java.lang.String unit, int[] indices, java.lang.String value) Documentation for: PutModString Put a string of meta data about a module.
int	RunBetween(int PID, java.lang.String idBegin, java.lang.String idEnd) Documentation for: RunBetween Returns SUCCESS if no error.
int	RunIconModel(int PID, java.lang.String id, java.lang.String path, java.lang.String cmdline, java.lang.String wrnfile, java.lang.String errfile) Documentation for: RunIconModel The passive part of the icon is the model itself that requires NO user to be active during its execution.
int	RunIconUI(int PID, java.lang.String id, java.lang.String path, java.lang.String cmdline, java.lang.String wrnfile, java.lang.String errfile) Documentation for: RunIconUI The active part of the icon is the user interface that requires the user to be active during its execution.
int	SaveDataSet(int PID, java.lang.String dset) Documentation for: SaveDataSet Save the dataset.
int	SaveDataSetAs(int PID, java.lang.String dset, java.lang.String path, java.lang.String newset) Documentation for: SaveDataSetAs Save the dataset with a different name.
int	SaveDictionary(int PID, java.lang.String dictionary) Documentation for: SaveDictionary Saves the contents for a dictionary to disk.
int	SaveDictionaryAs(int PID, java.lang.String dictionary, java.lang.String path, java.lang.String newname) Documentation for: SaveDictionaryAs Save as dictionary to disk but does not included it in the registry.
int	SaveModule(int PID, java.lang.String module) Documentation for: SaveModule Save the module description dataset to registry.
int	SaveModuleAs(int PID, java.lang.String module, java.lang.String path, SystemDev.ByReferenceString newmodule) Documentation for: SaveModuleAs Save the module description as another dataset to registry.
int	SaveSim(int PID) Documentation for: SaveSim Save the simulation present state.
int	SaveSimAs(int PID, java.lang.String path, java.lang.String simulation) Documentation for: SaveSimAs Open an exsisting simulation return a simId.
int	SchemeCount(int PID, java.lang.String module, SystemDev.ByReferenceInteger count) Documentation for: SchemeCount Get the number of the schemes for a module.
int	SchemeIDicCount(int PID, java.lang.String module, java.lang.String scheme, SystemDev.ByReferenceInteger count) Documentation for: SchemeIDicCount Get the number of input dictionaries associated with a scheme for a module.
int	SchemeIDicList(int PID, java.lang.String module, java.lang.String scheme, java.lang.String delimiter, SystemDev.ByReferenceString list) Documentation for: SchemeIDicList Get a single string that contains all the names of the input dictionaries associated with a scheme for a module.
int	SchemeList(int PID, java.lang.String module, java.lang.String delimiter, SystemDev.ByReferenceString list) Documentation for: SchemeList Get the number of the schemes for a module.
int	SchemeODicCount(int PID, java.lang.String module, java.lang.String scheme, SystemDev.ByReferenceInteger count) Documentation for: SchemeODicCount Get the number of output dictionaries associated with a scheme for a module.
int	SchemeODicList(int PID, java.lang.String module, java.lang.String scheme, java.lang.String delimiter, SystemDev.ByReferenceString list) Documentation for: SchemeODicList Get a single string that contains all the names of the output dictionaries associated with a scheme for a module.
int	SetClassIcon(int PID, java.lang.String domainName, java.lang.String className, java.lang.String icon) Documentation for: SetClassIcon Set the icon associated with a class in a domain.
int	SetDicDescription(int PID, java.lang.String dictionary, java.lang.String description) Documentation for: SetDicDescription Set the description of a dictionary.
int	SetDicPrivilege(int PID, java.lang.String dictionary, int privilege) Documentation for: SetDicPrivilege Set the privilege of a dictionary.
int	SetDicVersion(int PID, java.lang.String dictionary, int version) Documentation for: SetDicVersion Set the version of a dictionary.
int	SetDomainIcon(int PID, java.lang.String domainName, java.lang.String icon) Documentation for: SetDomainIcon Set the icon associated with a domain.
int	SetGroupIcon(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group, java.lang.String icon) Documentation for: SetGroupIcon Set the icon associated with a class in a domain.
int	SetIconMod(int PID, java.lang.String id, java.lang.String module, java.lang.String scheme, java.lang.String delimiter, java.lang.String list) Documentation for: SetIconMod Sets module and scheme associated with an icon.
int	SetSim(int PID, java.lang.String simulation) Documentation for: SetSim Set current simulation name for which all simulation functions will use for this PID.
int	SetState(int PID, java.lang.String id, int state, int downstate) Documentation for: SetState Abitrarily set the state of an icon.
int	SetSubGrpIcon(int PID, java.lang.String domainName, java.lang.String className, java.lang.String group, java.lang.String subgroup, java.lang.String icon) Documentation for: SetSubGrpIcon Set the icon associated with a class in a domain.
int	SetVarDescription(int PID, java.lang.String dictionary, java.lang.String variable, java.lang.String description) Documentation for: SetVarDescription Set the variable's description.
int	SetVarMax(int PID, java.lang.String dictionary, java.lang.String variable, double max) Documentation for: SetVarMax Set the variable's maximum value.
int	SetVarMeasure(int PID, java.lang.String dictionary, java.lang.String variable, java.lang.String measure) Documentation for: SetVarMeasure Set the variable's measure.
int	SetVarMin(int PID, java.lang.String dictionary, java.lang.String variable, double min) Documentation for: SetVarMin Set the variable's minimum value.
int	SetVarName(int PID, java.lang.String dictionary, java.lang.String oldvariable, java.lang.String newvariable) Documentation for: SetVarName Set the variable name (rename).The SetVarName function call is made with a process id, a dictionary name string, an existing variable name string, and a variable name string as input to change the variable name.
int	SetVarPreposition(int PID, java.lang.String dictionary, java.lang.String variable, java.lang.String preposition) Documentation for: SetVarPreposition Set the preposition, this helps in describing parameters in a human readable form.
int	SetVarPrimaryKey(int PID, java.lang.String dictionary, java.lang.String variable, int flag) Documentation for: SetVarPrimaryKey Set the variable primarykey flag.
int	SetVarScalar(int PID, java.lang.String dictionary, java.lang.String variable, int flag) Documentation for: SetVarScalar Set the variable's scalar flag.
int	SetVarStochastic(int PID, java.lang.String dictionary, java.lang.String variable, int flag) Documentation for: SetVarStochastic Set the variable's stochastic flag.
int	SetVarType(int PID, java.lang.String dictionary, java.lang.String variable, java.lang.String type) Documentation for: SetVarType Set the variable's type.
int	SetVarUnit(int PID, java.lang.String dictionary, java.lang.String variable, java.lang.String unit) Documentation for: SetVarUnit Set the variable's unit for its given measure.
int	VarIndexList(int PID, java.lang.String dictionary, java.lang.String variable, java.lang.String delimiter, SystemDev.ByReferenceString list) Documentation for: VarIndexList Get the list of all indices for a variable.

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemDev

public SystemDev()

Method Detail

OpenINI

public int OpenINI(java.lang.String path)

Documentation for: OpenINI Open the INI and returns a PID. If the Startup.ini file does not exist path is the location where it will be created. The OpenINI function call is the first call made; if OpenINI is never called, all API calls are ignored. All changes to INI are persistent. The OpenINI function call is made with the file path as input (from command line), opens the INI, and returns the process id.

Parameters:

path - Fully qualified path to the location of the Startup.ini file.

CloseINI

public int CloseINI(int PID,
                    int cancel)

Documentation for: CloseINI Closes the entire frames session. If cancel is 0 all Startup.ini changes will be written. If cancel is 1 then no changes are written. The CloseINI function call is made with a process id as input and closes the entire FRAMES session.

Parameters:

PID - PID from OpenINI call.

cancel - Cancel provides the ability to not save changes. Default is 0

AddNewDictionary

public int AddNewDictionary(int PID,
                            java.lang.String path,
                            java.lang.String dictionary)

Documentation for: AddNewDictionary Create and add dictionary in registry, dictionary name will be set to the parameter dictionary. The dictionary file is expected to be empty. The AddNewDictionary function call is made with a process id and path string as input, and an empty dic string to output the dictionary name. This function will create and add a dictionary.

Parameters:

PID - PID from OpenINI call.

path - Fully qualified path to dictionary name.

dictionary - Name of the dictionary.

AddOpenDictionary

public int AddOpenDictionary(int PID,
                             java.lang.String path,
                             SystemDev.ByReferenceString dictionary)

Documentation for: AddOpenDictionary Open and add dictionary in registry, dictionary returns the dictionary name. The dictionary file is expected to be complete for this function to reach success (return a 0). The AddOpenDictionary function call is made with a process id and path string as input, and an empty dic string to output the dictionary name. This function will add a dictionary to the registry.

Parameters:

PID - PID from OpenINI call.

path - Fully qualified path to dictionary name.

dictionary - Name of the dictionary.

DelDictionary

public int DelDictionary(int PID,
                         java.lang.String dictionary)

Documentation for: DelDictionary Delete a dictionary from FRAMES 2.0 Startup.ini. The DelDictionary function call is made with a process id and a dictionary name string as input to delete a dictionary from the registry.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

SaveDictionary

public int SaveDictionary(int PID,
                          java.lang.String dictionary)

Documentation for: SaveDictionary Saves the contents for a dictionary to disk. The path is associated with the name when the dictionary was created or opened. The SaveDictionary function call is made with a process id and a dictionary name string as input to save a dictionary to the registry.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

SaveDictionaryAs

public int SaveDictionaryAs(int PID,
                            java.lang.String dictionary,
                            java.lang.String path,
                            java.lang.String newname)

Documentation for: SaveDictionaryAs Save as dictionary to disk but does not included it in the registry. The SaveDictionaryAs function call is made with a process id, a dictionary name string, a path string, and a new dictionary name string as input to save a dictionary not included in the registry.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

path - Fully qualified path to dictionary name.

newname - New name of the dictionary when saved to disk.

DictionaryCount

public int DictionaryCount(int PID,
                           SystemDev.ByReferenceInteger count)

Documentation for: DictionaryCount Get the count of all dictionaries in registry. The DictionaryCount function call is made with a process id and a dictionary name string as input, and a count integer to output a count of all dictionaries in the registry.

Parameters:

PID - PID from OpenINI call.

count - Current number of dictionaries in registery.

DictionaryList

public int DictionaryList(int PID,
                          java.lang.String delimiter,
                          SystemDev.ByReferenceString list)

Documentation for: DictionaryList Get the list of all dictionaries in registry in a single delimited string. The DictionaryList function call is made with a process id and a delimiter string as input, and an empty list string to output a string of dictionary names separated by commas.

Parameters:

PID - PID from OpenINI call.

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

list - The complete list of dictionary names in a string

GetDicDescription

public int GetDicDescription(int PID,
                             java.lang.String dictionary,
                             SystemDev.ByReferenceString description)

Documentation for: GetDicDescription Get the description of a dictionary.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

description - The description of the dictionary

SetDicDescription

public int SetDicDescription(int PID,
                             java.lang.String dictionary,
                             java.lang.String description)

Documentation for: SetDicDescription Set the description of a dictionary.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

description - The new description of the dictionary

GetDicPrivilege

public int GetDicPrivilege(int PID,
                           java.lang.String dictionary,
                           SystemDev.ByReferenceInteger privilege)

Documentation for: GetDicPrivilege Get the privilege of a dictionary. The privilege is either 0=System UI, 1=System Boundary Condition, 2=Module UI, or 3=Module Boundary Condition. This represents the level of review a dictionary has received. A system dictionary should have a number of individuals agree that it is complete, useful and mutually exclusive of other system dictionaries. Module level privileges are meant for people to develop their own standards that may become system dictionaries in the future.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

privilege - The privilege of the dictionary

SetDicPrivilege

public int SetDicPrivilege(int PID,
                           java.lang.String dictionary,
                           int privilege)

Documentation for: SetDicPrivilege Set the privilege of a dictionary.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

privilege - The new privilege of the dictionary

GetDicVersion

public int GetDicVersion(int PID,
                         java.lang.String dictionary,
                         SystemDev.ByReferenceInteger version)

Documentation for: GetDicVersion Get the version of a dictionary.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

version - The version of the dictionary

SetDicVersion

public int SetDicVersion(int PID,
                         java.lang.String dictionary,
                         int version)

Documentation for: SetDicVersion Set the version of a dictionary.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

version - The new version of the dictionary

GetDicPath

public int GetDicPath(int PID,
                      java.lang.String dictionary,
                      SystemDev.ByReferenceString path)

Documentation for: GetDicPath Get the path associated with a dictionary. To change the path you need to 1) SaveDictionaryAs changing the path, 2) DelDictionary, and 3) AddOpenDictionary from it new location.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

path - The path of the dictionary

GetDicUpdate

public int GetDicUpdate(int PID,
                        java.lang.String dictionary,
                        SystemDev.ByReferenceInteger update)

Documentation for: GetDicUpdate If the state of a dictionary has changed then update flag will be non-zero.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

update - The update flag of the dictionary

AddVariable

public int AddVariable(int PID,
                       java.lang.String dictionary,
                       java.lang.String variable)

Documentation for: AddVariable The AddVariable function call is made with a process id, a dictionary name string, and a variable string as input to add a variable to a dictionary. The function returns success/fail flag. This function must be called to allocate new space for a parameter. The parameter will be added to the dictionary or dataset by _dicId with the given _name. The parameter will have the default settings of: dimension = 0; description = ""; type = integer; stochastic = false; min = 0; max = 0.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The name of the new parameter

DelVariable

public int DelVariable(int PID,
                       java.lang.String dictionary,
                       java.lang.String variable)

Documentation for: DelVariable Delete a variable from a dictionary. Warning - Deleting a variable, dictionary, or a dataset can have some serious side effects therefore the software will not allow the use any these delete functions when more than one handle to a simulation exists. (i.e. A module and the system are active, or two system level users are active on a single instance of FRAMES. The DelVariable function call is made with a process id, a dictionary name string, and a variable string as input to delete a variable from a dictionary. The function returns success/fail flag.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The name of the new parameter

GetVarCount

public int GetVarCount(int PID,
                       java.lang.String dictionary,
                       SystemDev.ByReferenceInteger count)

Documentation for: GetVarCount Gets the varible count of a dictionary. The GetVarCount function call is made with a process id, a dictionary name string, and a count integer to output a count of all variables in the dictionary. The function returns success/fail flag.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

count - Current number of variables in dictionary.

GetVarName

public int GetVarName(int PID,
                      java.lang.String dictionary,
                      int index,
                      SystemDev.ByReferenceString variable)

Documentation for: GetVarName Gets the name of the nth (index) variable in the dictionary.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

index - The index of the variable within the dictionary.

variable - The name of the variable.

GetVarList

public int GetVarList(int PID,
                      java.lang.String dictionary,
                      java.lang.String delimiter,
                      SystemDev.ByReferenceString list)

Documentation for: GetVarList Gets the delimited list of all variable names in a dictionary. The function returns success/fail flag.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

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

list - The complete list of variable names.

SetVarName

public int SetVarName(int PID,
                      java.lang.String dictionary,
                      java.lang.String oldvariable,
                      java.lang.String newvariable)

Documentation for: SetVarName Set the variable name (rename).The SetVarName function call is made with a process id, a dictionary name string, an existing variable name string, and a variable name string as input to change the variable name.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

oldvariable - The variables current name.

newvariable - The new name of the new variable

SetVarDescription

public int SetVarDescription(int PID,
                             java.lang.String dictionary,
                             java.lang.String variable,
                             java.lang.String description)

Documentation for: SetVarDescription Set the variable's description. The SetVarDescription function call is made with a process id, a dictionary name string, a variable name string, and a description string as input to change the description of the variable.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The variables current name.

description - The new description of the variable

SetVarType

public int SetVarType(int PID,
                      java.lang.String dictionary,
                      java.lang.String variable,
                      java.lang.String type)

Documentation for: SetVarType Set the variable's type. Type can be either "String", "Logical", "Real", or "Integer". The SetVarType function call is made with a process id, a dictionary name string, a variable name string, and a type string as input to change the type parameter of the variable.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The variables current name.

type - The new type of the variable

SetVarScalar

public int SetVarScalar(int PID,
                        java.lang.String dictionary,
                        java.lang.String variable,
                        int flag)

Documentation for: SetVarScalar Set the variable's scalar flag. If the flag is 0 then a set of values is stored. (i.e. the dimensionality will be increased by 1). If the flag=1 a single value is stored.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The variables current name.

flag - The new scalar flag.

SetVarMin

public int SetVarMin(int PID,
                     java.lang.String dictionary,
                     java.lang.String variable,
                     double min)

Documentation for: SetVarMin Set the variable's minimum value. Setting both minimum and maximum equal to each other has the effect of having the variable NOT range checked.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The variables current name.

min - The new minimum for the variable

SetVarMax

public int SetVarMax(int PID,
                     java.lang.String dictionary,
                     java.lang.String variable,
                     double max)

Documentation for: SetVarMax Set the variable's maximum value. Setting both minimum and maximum equal to each other has the effect of having the variable NOT range checked.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The variables current name.

max - The new maximum for the variable

SetVarMeasure

public int SetVarMeasure(int PID,
                         java.lang.String dictionary,
                         java.lang.String variable,
                         java.lang.String measure)

Documentation for: SetVarMeasure Set the variable's measure.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The variables current name.

measure - The new measure for the variable

SetVarUnit

public int SetVarUnit(int PID,
                      java.lang.String dictionary,
                      java.lang.String variable,
                      java.lang.String unit)

Documentation for: SetVarUnit Set the variable's unit for its given measure.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The variables current name.

unit - The new unit for the variable

SetVarStochastic

public int SetVarStochastic(int PID,
                            java.lang.String dictionary,
                            java.lang.String variable,
                            int flag)

Documentation for: SetVarStochastic Set the variable's 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 - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The variables current name.

flag - The new stochastic flag.

SetVarPreposition

public int SetVarPreposition(int PID,
                             java.lang.String dictionary,
                             java.lang.String variable,
                             java.lang.String preposition)

Documentation for: SetVarPreposition Set the preposition, this helps in describing parameters in a human readable form. 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. The SetVarPreposition function call is made with a process id, a dictionary name string, a variable name string, and a prep string as input to change the preposition parameter of the variable.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The variables current name.

preposition - The new preposition for the variable

SetVarPrimaryKey

public int SetVarPrimaryKey(int PID,
                            java.lang.String dictionary,
                            java.lang.String variable,
                            int flag)

Documentation for: SetVarPrimaryKey Set the variable 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 - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The variables current name.

flag - The new primary key flag.

AddVarIndex

public int AddVarIndex(int PID,
                       java.lang.String dictionary,
                       java.lang.String variable,
                       java.lang.String reference,
                       java.lang.String index)

Documentation for: AddVarIndex Add a variable index or label index to a variable. The AddVarIndex function call is made with a process id, a dictionary name string, a variable name string, a dictionary reference string, and an index string as input to add a variable index or label index to a variable.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The variables current name.

reference - The referred dicitonary for the index.

index - The referred variable within the dictionary.

DelVarIndex

public int DelVarIndex(int PID,
                       java.lang.String dictionary,
                       java.lang.String variable,
                       java.lang.String reference,
                       java.lang.String index)

Documentation for: DelVarIndex Delete an indice from a variable. The DelVarIndex function call is made with a process id, a dictionary name string, a variable name string, and an index string as input to delete a variable index or label index to a variable.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The variables current name.

reference - The referred dicitonary for the index.

index - The referred variable within the dictionary.

GetVarIndexCount

public int GetVarIndexCount(int PID,
                            java.lang.String dictionary,
                            java.lang.String variable,
                            SystemDev.ByReferenceInteger count)

Documentation for: GetVarIndexCount Get the count of indices for a variable. The GetVarIndexCount function call is made with a process id, a dictionary name string, and a variable name string as input, and an empty count integer to output a count of indices for a variable.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The variables current name.

count - The count of the indices.

VarIndexList

public int VarIndexList(int PID,
                        java.lang.String dictionary,
                        java.lang.String variable,
                        java.lang.String delimiter,
                        SystemDev.ByReferenceString list)

Documentation for: VarIndexList Get the list of all indices for a variable. The VarIndexList function call is made with a process id, a dictionary name string, a variable name string, and a delimiter string as input, and an empty list string to output a list of indices for a variable.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The variables current name.

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

list - The complete list of dictionary names in a string

PromoteVarIndex

public int PromoteVarIndex(int PID,
                           java.lang.String dictionary,
                           java.lang.String variable,
                           java.lang.String reference,
                           java.lang.String index)

Documentation for: PromoteVarIndex Move and index up one level in the order of referred indices.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The variables current name.

reference - The referred dicitonary for the index.

index - The referred variable within the dictionary.

DemoteVarIndex

public int DemoteVarIndex(int PID,
                          java.lang.String dictionary,
                          java.lang.String variable,
                          java.lang.String reference,
                          java.lang.String index)

Documentation for: DemoteVarIndex Move and index down one level in the order of referred indices.

Parameters:

PID - PID from OpenINI call.

dictionary - Name of the dictionary.

variable - The variables current name.

reference - The referred dicitonary for the index.

index - The referred variable within the dictionary.

AddNewModule

public int AddNewModule(int PID,
                        java.lang.String path,
                        java.lang.String module)

Documentation for: AddNewModule Create and add a module description in registry module name passed in. The AddNewModule function call is made with a process id, a path string, and a module name string as input to create and add a module description in the registry. It is expected that .mod file does not exist or is empty.

Parameters:

PID - PID from OpenINI call.

path - Fully qualified path to the location of the .mod file for the module.

module - The new module name.

AddOpenModule

public int AddOpenModule(int PID,
                         java.lang.String path,
                         SystemDev.ByReferenceString module)

Documentation for: AddOpenModule Open and add a module description in registry module name passed out. The AddOpenModule function call is made with a process id and a path string as input to open and add a module description in the registry, and a module name string to output the module name.

Parameters:

PID - PID from OpenINI call.

path - Fully qualified path to the location of the .mod file for the module.

module - The module name that was read.

DelModule

public int DelModule(int PID,
                     java.lang.String module)

Documentation for: DelModule Delete a module description dataset from registry. The DelModule function call is made with a process id and a module name string as input to delete a module description dataset from the registry.

Parameters:

PID - PID from OpenINI call.

module - The module name.

SaveModule

public int SaveModule(int PID,
                      java.lang.String module)

Documentation for: SaveModule Save the module description dataset to registry. The SaveModule function call is made with a process id and a module name string as input to save a module description dataset in the registry.

Parameters:

PID - PID from OpenINI call.

module - The module name.

SaveModuleAs

public int SaveModuleAs(int PID,
                        java.lang.String module,
                        java.lang.String path,
                        SystemDev.ByReferenceString newmodule)

Documentation for: SaveModuleAs Save the module description as another dataset to registry. The SaveModuleAs function call is made with a process id, an old module name string, a path string, and a new module name string as input to save the module description as another dataset in the registry. The old module name continues to be the open module.

Parameters:

PID - PID from OpenINI call.

module - The module name.

path - Fully qualified path to the location of the .mod file for the module.

newmodule - The new module name.

ModuleCount

public int ModuleCount(int PID,
                       SystemDev.ByReferenceInteger count)

Documentation for: ModuleCount Get the count of all modules in registry. The SaveModuleAs function call is made with a process id, an old module name string, a path string, and a new module name string as input to save the module description as another dataset in the registry. The old module name continues to be the open module.

Parameters:

PID - PID from OpenINI call.

count - The number of modules in the registery.

ModuleList

public int ModuleList(int PID,
                      java.lang.String delimiter,
                      SystemDev.ByReferenceString list)

Documentation for: ModuleList Get the list of all module desriptions in registry. The ModuleList function call is made with a process id, a mod string, and a delimiter string as input, and an empty list string to output a comma-separated list of all module descriptions in the registry.

Parameters:

PID - PID from OpenINI call.

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

list - The complete list of dictionary module names in a string

GetModPath

public int GetModPath(int PID,
                      java.lang.String module,
                      SystemDev.ByReferenceString path)

Documentation for: GetModPath Get module path associated with a module.

Parameters:

PID - PID from OpenINI call.

module - The module name.

path - Fully qualified path to the location of the .mod file for the module.

AddScheme

public int AddScheme(int PID,
                     java.lang.String module,
                     java.lang.String scheme)

Documentation for: AddScheme Add a scheme to a module.

Parameters:

PID - PID from OpenINI call.

module - The module name.

scheme - The name of the scheme.

DelScheme

public int DelScheme(int PID,
                     java.lang.String module,
                     java.lang.String scheme)

Documentation for: DelScheme Delete a scheme from a module.

Parameters:

PID - PID from OpenINI call.

module - The module name.

scheme - The name of the scheme.

SchemeCount

public int SchemeCount(int PID,
                       java.lang.String module,
                       SystemDev.ByReferenceInteger count)

Documentation for: SchemeCount Get the number of the schemes for a module.

Parameters:

PID - PID from OpenINI call.

module - The module name.

count - The number of the schemes for the module.

SchemeList

public int SchemeList(int PID,
                      java.lang.String module,
                      java.lang.String delimiter,
                      SystemDev.ByReferenceString list)

Documentation for: SchemeList Get the number of the schemes for a module.

Parameters:

PID - PID from OpenINI call.

module - The module name.

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

list - The complete list of dictionary module schemes in a string

AddSchemeIDic

public int AddSchemeIDic(int PID,
                         java.lang.String module,
                         java.lang.String scheme,
                         java.lang.String dictionary)

Documentation for: AddSchemeIDic Add a dictionary to a scheme for a module.

Parameters:

PID - PID from OpenINI call.

module - The module name.

scheme - The name of the scheme.

dictionary - The name of the dictionary to add.

DelSchemeIDic

public int DelSchemeIDic(int PID,
                         java.lang.String module,
                         java.lang.String scheme,
                         java.lang.String dictionary)

Documentation for: DelSchemeIDic Delete a dictionary from a scheme for a module.

Parameters:

PID - PID from OpenINI call.

module - The module name.

scheme - The name of the scheme.

dictionary - The name of the dictionary to add.

SchemeIDicCount

public int SchemeIDicCount(int PID,
                           java.lang.String module,
                           java.lang.String scheme,
                           SystemDev.ByReferenceInteger count)

Documentation for: SchemeIDicCount Get the number of input dictionaries associated with a scheme for a module.

Parameters:

PID - PID from OpenINI call.

module - The module name.

scheme - The name of the scheme.

count - The number of input dictionaries associated with a scheme.

SchemeIDicList

public int SchemeIDicList(int PID,
                          java.lang.String module,
                          java.lang.String scheme,
                          java.lang.String delimiter,
                          SystemDev.ByReferenceString list)

Documentation for: SchemeIDicList Get a single string that contains all the names of the input dictionaries associated with a scheme for a module.

Parameters:

PID - PID from OpenINI call.

module - The module name.

scheme - The name of the scheme.

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

list - The complete list of dictionary dictionaries in a string

AddSchemeODic

public int AddSchemeODic(int PID,
                         java.lang.String module,
                         java.lang.String scheme,
                         java.lang.String dictionary)

Documentation for: AddSchemeODic Add an output dictionary to a scheme for a module.

Parameters:

PID - PID from OpenINI call.

module - The module name.

scheme - The name of the scheme.

dictionary - The name of the dictionary to add.

DelSchemeODic

public int DelSchemeODic(int PID,
                         java.lang.String module,
                         java.lang.String scheme,
                         java.lang.String dictionary)

Documentation for: DelSchemeODic Delete an output dictionary from a scheme for a module.

Parameters:

PID - PID from OpenINI call.

module - The module name.

scheme - The name of the scheme.

dictionary - The name of the dictionary to add.

SchemeODicCount

public int SchemeODicCount(int PID,
                           java.lang.String module,
                           java.lang.String scheme,
                           SystemDev.ByReferenceInteger count)

Documentation for: SchemeODicCount Get the number of output dictionaries associated with a scheme for a module.

Parameters:

PID - PID from OpenINI call.

module - The module name.

scheme - The name of the scheme.

count - The number of output dictionaries associated with a scheme.

SchemeODicList

public int SchemeODicList(int PID,
                          java.lang.String module,
                          java.lang.String scheme,
                          java.lang.String delimiter,
                          SystemDev.ByReferenceString list)

Documentation for: SchemeODicList Get a single string that contains all the names of the output dictionaries associated with a scheme for a module.

Parameters:

PID - PID from OpenINI call.

module - The module name.

scheme - The name of the scheme.

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

list - The complete list of dictionary dictionaries in a string

GetModDimSize

public int GetModDimSize(int PID,
                         java.lang.String id,
                         java.lang.String variable,
                         int[] indices,
                         SystemDev.ByReferenceInteger count)

Documentation for: GetModDimSize Get the dimension size for the dataset information about modules.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

variable - The name of a variable

indices - An array of integers that contains the indexs

count - Current number of number of elements in the dimension.

GetModInteger

public int GetModInteger(int PID,
                         java.lang.String id,
                         java.lang.String variable,
                         java.lang.String unit,
                         int[] indices,
                         SystemDev.ByReferenceInteger value)

Documentation for: GetModInteger Get an integer from meta data about a module.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

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

GetModDouble

public int GetModDouble(int PID,
                        java.lang.String id,
                        java.lang.String variable,
                        java.lang.String unit,
                        int[] indices,
                        SystemDev.ByReferenceDouble value)

Documentation for: GetModDouble Get an integer from meta data about a module.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

variable - The name of a variable

unit - A unit within the same measure

indices - An array of integers that contains the indexs

value - The double that was retrieved

GetModLogical

public int GetModLogical(int PID,
                         java.lang.String id,
                         java.lang.String variable,
                         java.lang.String unit,
                         int[] indices,
                         SystemDev.ByReferenceInteger value)

Documentation for: GetModLogical Get an integer from meta data about a module.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

variable - The name of a variable

unit - A unit within the same measure

indices - An array of integers that contains the indexs

value - The logical value that was retrieved

GetModString

public int GetModString(int PID,
                        java.lang.String id,
                        java.lang.String variable,
                        java.lang.String unit,
                        int[] indices,
                        SystemDev.ByReferenceString value)

Documentation for: GetModString Get an integer from meta data about a module.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

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

PutModInteger

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

Documentation for: PutModInteger Put an integer of meta data about a module.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

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

PutModDouble

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

Documentation for: PutModDouble Put a double of meta data about a module.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

variable - The name of a variable

unit - A unit within the same measure

indices - An array of integers that contains the indexs

value - The double that was retrieved

PutModLogical

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

Documentation for: PutModLogical Put an logical of meta data about a module.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

variable - The name of a variable

unit - A unit within the same measure

indices - An array of integers that contains the indexs

value - The logical value that was retrieved

PutModString

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

Documentation for: PutModString Put a string of meta data about a module.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

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

AddDomain

public int AddDomain(int PID,
                     java.lang.String domainName)

Documentation for: AddDomain Automatically adds the four class types to the domain. The AddDomain function call is made with a process id and a domain name string as input to add a domain; automatically adds the four class types to the domain.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

DelDomain

public int DelDomain(int PID,
                     java.lang.String domainName)

Documentation for: DelDomain Deletes the domain and it tree. The DelDomain function call is made with a process id and a domain name string as input to delete a domain and its tree, deleting its classes, groups, subgroups, and modules.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

GetDomainIcon

public int GetDomainIcon(int PID,
                         java.lang.String domainName,
                         SystemDev.ByReferenceString icon)

Documentation for: GetDomainIcon Get the icon associated with a domain. Icon are either .bmp, .gif files for image. They should be small 32X32 pixels.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

icon - Fully qualified path to a image file.

SetDomainIcon

public int SetDomainIcon(int PID,
                         java.lang.String domainName,
                         java.lang.String icon)

Documentation for: SetDomainIcon Set the icon associated with a domain. Icon are either .bmp, .gif files for image. They should be small 32X32 pixels.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

icon - Fully qualified path to a image file.

AddClass

public int AddClass(int PID,
                    java.lang.String domainName,
                    java.lang.String className)

Documentation for: AddClass For future use - not presently active. The AddClass function call is made with a process id, a domain name string, and a class name string as input to add a class.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

DelClass

public int DelClass(int PID,
                    java.lang.String domainName,
                    java.lang.String className)

Documentation for: DelClass For future use - not presently active. The DelClass function call is made with a process id, a domain name string, and a class name string as input to delete a class from a domain, including its groups, subgroups, and modules.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

GetClassIcon

public int GetClassIcon(int PID,
                        java.lang.String domainName,
                        java.lang.String className,
                        SystemDev.ByReferenceString icon)

Documentation for: GetClassIcon Get the icon associated with a class in a domain. Icon are either .bmp, .gif files for image. They should be small 32X32 pixels.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

icon - Fully qualified path to a image file.

SetClassIcon

public int SetClassIcon(int PID,
                        java.lang.String domainName,
                        java.lang.String className,
                        java.lang.String icon)

Documentation for: SetClassIcon Set the icon associated with a class in a domain. Icon are either .bmp, .gif files for image. They should be small 32X32 pixels.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

icon - Fully qualified path to a image file.

AddGroup

public int AddGroup(int PID,
                    java.lang.String domainName,
                    java.lang.String className,
                    java.lang.String group)

Documentation for: AddGroup The AddGroup function call is made with a process id, a domain name string, a class name string, and a group name string as input to add a group to a domain and class.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

DelGroup

public int DelGroup(int PID,
                    java.lang.String domainName,
                    java.lang.String className,
                    java.lang.String group)

Documentation for: DelGroup The DelGroup function call is made with a process id, a domain name string, a class name string, and a group name string as input to delete a group from a domain and class, including its subgroups and modules.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

GetGroupIcon

public int GetGroupIcon(int PID,
                        java.lang.String domainName,
                        java.lang.String className,
                        java.lang.String group,
                        SystemDev.ByReferenceString icon)

Documentation for: GetGroupIcon Get the icon associated with a class in a domain. Icon are either .bmp, .gif files for image. They should be small 32X32 pixels.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

icon - Fully qualified path to a image file.

SetGroupIcon

public int SetGroupIcon(int PID,
                        java.lang.String domainName,
                        java.lang.String className,
                        java.lang.String group,
                        java.lang.String icon)

Documentation for: SetGroupIcon Set the icon associated with a class in a domain. Icon are either .bmp, .gif files for image. They should be small 32X32 pixels.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

icon - Fully qualified path to a image file.

AddSubGroup

public int AddSubGroup(int PID,
                       java.lang.String domainName,
                       java.lang.String className,
                       java.lang.String group,
                       java.lang.String subgroup)

Documentation for: AddSubGroup The AddSubGroup function call is made with a process id, a domain name string, a class name string, a group name string, and a subgroup name string as input to add a subgroup to a domain, class, and group.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

subgroup - The subgroup name.

DelSubGroup

public int DelSubGroup(int PID,
                       java.lang.String domainName,
                       java.lang.String className,
                       java.lang.String group,
                       java.lang.String subgroup)

Documentation for: DelSubGroup The DelSubGroup function call is made with a process id, a domain name string, a class name string, a group name string, and a subgroup name string as input to delete a subgroup from a domain, class, and group, including its modules.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

subgroup - The subgroup name.

GetSubGrpIcon

public int GetSubGrpIcon(int PID,
                         java.lang.String domainName,
                         java.lang.String className,
                         java.lang.String group,
                         java.lang.String subgroup,
                         SystemDev.ByReferenceString icon)

Documentation for: GetSubGrpIcon Get the icon associated with a class in a domain. Icon are either .bmp, .gif files for image. They should be small 32X32 pixels.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

subgroup - The subgroup name.

icon - Fully qualified path to a image file.

SetSubGrpIcon

public int SetSubGrpIcon(int PID,
                         java.lang.String domainName,
                         java.lang.String className,
                         java.lang.String group,
                         java.lang.String subgroup,
                         java.lang.String icon)

Documentation for: SetSubGrpIcon Set the icon associated with a class in a domain. Icon are either .bmp, .gif files for image. They should be small 32X32 pixels.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

subgroup - The subgroup name.

icon - Fully qualified path to a image file.

AddGroupModule

public int AddGroupModule(int PID,
                          java.lang.String domainName,
                          java.lang.String className,
                          java.lang.String group,
                          java.lang.String module)

Documentation for: AddGroupModule Add a module at the group level. The AddGroupModule function call is made with a process id, a domain name string, a class name string, a group name string, and a module name string as input to add a module to a domain, class, and group.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

module - The module name.

DelGroupModule

public int DelGroupModule(int PID,
                          java.lang.String domainName,
                          java.lang.String className,
                          java.lang.String group,
                          java.lang.String module)

Documentation for: DelGroupModule Remove a module at the group level. The DelGroupModule function call is made with a process id, a domain name string, a class name string, a group name string, and a module name string as input to delete a module from a domain, class, and group.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

module - The module name.

AddSubGrpModule

public int AddSubGrpModule(int PID,
                           java.lang.String domainName,
                           java.lang.String className,
                           java.lang.String group,
                           java.lang.String subgroup,
                           java.lang.String module)

Documentation for: AddSubGrpModule Add a module at the subgroup level. The AddSubGrpModule function call is made with a process id, a domain name string, a class name string, a group name string, a subgroup name string, and a module name string as input to add a module to a domain, class, group, and subgroup.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

subgroup - The subgroup name.

module - The module name.

DelSubGrpModule

public int DelSubGrpModule(int PID,
                           java.lang.String domainName,
                           java.lang.String className,
                           java.lang.String group,
                           java.lang.String subgroup,
                           java.lang.String module)

Documentation for: DelSubGrpModule Remove a module at the subgroup level. The DelSubGrpModule function call is made with a process id, a domain name string, a class name string, a group name string, a subgroup name string, and module name string as input to delete a module from a domain, class, group, and subgroup.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

subgroup - The subgroup name.

module - The module name.

GetDomainList

public int GetDomainList(int PID,
                         java.lang.String delimiter,
                         SystemDev.ByReferenceString list)

Documentation for: GetDomainList The GetDomainList function call is made with a process id and a delimiter string as input, and an empty list string to output a comma-separated list of all domains in the registry.

Parameters:

PID - PID from OpenINI call.

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

list - The complete list of domain names in a string

GetClassList

public int GetClassList(int PID,
                        java.lang.String domainName,
                        java.lang.String delimiter,
                        SystemDev.ByReferenceString list)

Documentation for: GetClassList The GetClassList function call is made with a process id, a domain name string, and a delimiter string as input, and an empty list string to output a comma-separated list of all classes in a domain.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

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

list - The complete list of class names in a string

GetGroupList

public int GetGroupList(int PID,
                        java.lang.String domainName,
                        java.lang.String className,
                        java.lang.String delimiter,
                        SystemDev.ByReferenceString list)

Documentation for: GetGroupList The GetGroupList function call is made with a process id, a domain name string, a class name string, and a delimiter string as input, and an empty list string to output a comma-separated list of all groups in a domain and class.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

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

list - The complete list of group names in a string

GetSubGrpList

public int GetSubGrpList(int PID,
                         java.lang.String domainName,
                         java.lang.String className,
                         java.lang.String group,
                         java.lang.String delimiter,
                         SystemDev.ByReferenceString list)

Documentation for: GetSubGrpList The GetSubGrpList function call is made with a process id, a domain name string, a class name string, a group name string, and a delimiter string as input, and an empty list string to output a comma-separated list of all subgroups in a domain, class, and group.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

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

list - The complete list of subgroup names in a string

GetGroupModList

public int GetGroupModList(int PID,
                           java.lang.String domainName,
                           java.lang.String className,
                           java.lang.String group,
                           java.lang.String delimiter,
                           SystemDev.ByReferenceString list)

Documentation for: GetGroupModList The GetGroupModList function call is made with a process id, a domain name string, a class name string, a group name string, and a delimiter string as input, and an empty list string to output a comma-separated list of all subgroups in a domain, class, and group.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

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

list - The complete list of dictionary modules in a string

GetSubGrpModList

public int GetSubGrpModList(int PID,
                            java.lang.String domainName,
                            java.lang.String className,
                            java.lang.String group,
                            java.lang.String subgroup,
                            java.lang.String delimiter,
                            SystemDev.ByReferenceString list)

Documentation for: GetSubGrpModList The GetSubGrpModList function call is made with a process id, a domain name string, a class name string, a group name string, a subgroup name string, and a delimiter string as input, and an empty list string to output a comma-separated list of all subgroups in a domain, class, and group.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

subgroup - The subgroup name.

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

list - The complete list of dictionary modules in a string

GetDomainCount

public int GetDomainCount(int PID,
                          SystemDev.ByReferenceInteger count)

Documentation for: GetDomainCount Get the number of domains in the registery. The GetDomainCount function call is made with a process id as input, and an empty count integer to output a count of all domains in the registry.

Parameters:

PID - PID from OpenINI call.

count - The number of domains.

GetClassCount

public int GetClassCount(int PID,
                         java.lang.String domainName,
                         SystemDev.ByReferenceInteger count)

Documentation for: GetClassCount Get the number of classes in a domain. The GetClassCount function call is made with a process id and a domain name string as input, and an empty count integer to output a count of all classes in a domain.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

count - The number of classes.

GetGroupCount

public int GetGroupCount(int PID,
                         java.lang.String domainName,
                         java.lang.String className,
                         SystemDev.ByReferenceInteger count)

Documentation for: GetGroupCount Get the number of groups in a class, and domain. The GetGroupCount function call is made with a process id, a domain name string, and a class name string as input, and an empty count integer to output a count of all groups in a domain and class.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

count - The number of groups.

GetSubGrpCount

public int GetSubGrpCount(int PID,
                          java.lang.String domainName,
                          java.lang.String className,
                          java.lang.String group,
                          SystemDev.ByReferenceInteger count)

Documentation for: GetSubGrpCount Get the number of subgroups in a group, class and domain.The GetSubGrpCount function call is made with a process id, a domain name string, a class name string, and a group name string as input, and an empty count integer to output a count of all subgroups in a domain, class, and group.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

count - The number of subgroups.

GetGroupModCount

public int GetGroupModCount(int PID,
                            java.lang.String domainName,
                            java.lang.String className,
                            java.lang.String group,
                            SystemDev.ByReferenceInteger count)

Documentation for: GetGroupModCount Get the number of modules at the group level for a group, class, and domain. The GetGroupModCount function call is made with a process id, a domain name string, a class name string, and a group name string as input, and an empty count integer to output a count of all modules in a domain, class, and group.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

count - The number of modules at the group level.

GetSubGrpModCount

public int GetSubGrpModCount(int PID,
                             java.lang.String domainName,
                             java.lang.String className,
                             java.lang.String group,
                             java.lang.String subgroup,
                             SystemDev.ByReferenceInteger count)

Documentation for: GetSubGrpModCount Get the number of modules at the subgroup level for a subgroup, group, class, and domain. The GetSubGrpModCount function call is made with a process id, a domain name string, a class name string, a group name string, and a subgroup name string as input, and an empty count integer to output a count of all modules in a domain, class, group, and subgroup.

Parameters:

PID - PID from OpenINI call.

domainName - The domain name.

className - The class name.

group - The group name.

subgroup - The subgroup name.

count - The number of modules at the subgroup level.

NewSim

public int NewSim(int PID,
                  java.lang.String path,
                  java.lang.String simulation)

Documentation for: NewSim Open a new simulation return a simulation dataset name. The NewSim function call is made with a process id and a filename string as input to open a new simulation. Only one simulation is allowed to be open at a time in a FRAMES session, however, multiple FRAMES sessions may be open at the same time.

Parameters:

PID - PID from OpenINI call.

path - Fully qualified path to the new .sim file.

simulation - The new simulation name.

OpenSim

public int OpenSim(int PID,
                   java.lang.String path,
                   SystemDev.ByReferenceString simulation)

Documentation for: OpenSim Open an existing simulation return a simulation dataset name. The OpenSim function call is made with a process id and a filename string as input to open an existing simulation.

Parameters:

PID - PID from OpenINI call.

path - Fully qualified path to the location of .sim file.

simulation - The simulation name read from the file.

SaveSim

public int SaveSim(int PID)

Documentation for: SaveSim Save the simulation present state. The SaveSim function call is made with a process id as input to save the simulation's present state.

Parameters:

PID - PID from OpenINI call.

SaveSimAs

public int SaveSimAs(int PID,
                     java.lang.String path,
                     java.lang.String simulation)

Documentation for: SaveSimAs Open an exsisting simulation return a simId. The SaveSimAs function call is made with a process id and a filename string (new name) as input to save a simulation (SDE) as another name, but continue to work in same simulation name.

Parameters:

PID - PID from OpenINI call.

path - Fully qualified path to the location of .sim file.

simulation - The simulation dataset name to be saved.

CloseSim

public int CloseSim(int PID)

Documentation for: CloseSim Close the simulation without saving. The CloseSim function call is made with a process id as input to close the simulation without saving.

Parameters:

PID - PID from OpenINI call.

GetSim

public int GetSim(int PID,
                  SystemDev.ByReferenceString path,
                  SystemDev.ByReferenceString simulation)

Documentation for: GetSim Get current simulation name for which all simulation functions will use for this PID.

Parameters:

PID - PID from OpenINI call.

path - The simulation path.

simulation - The simulation name.

SetSim

public int SetSim(int PID,
                  java.lang.String simulation)

Documentation for: SetSim Set current simulation name for which all simulation functions will use for this PID.

Parameters:

PID - PID from OpenINI call.

simulation - The simulation name.

GetSimList

public int GetSimList(int PID,
                      java.lang.String delimiter,
                      SystemDev.ByReferenceString list)

Documentation for: GetSimList Get the list of all simulations loaded in the environment.

Parameters:

PID - PID from OpenINI call.

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

list - The complete list of simulation names in a string

AddNewDataSet

public int AddNewDataSet(int PID,
                         java.lang.String dictionary,
                         java.lang.String path,
                         java.lang.String dset)

Documentation for: AddNewDataSet Create a new dataset using a registered dictionary. The AddNewDataSet function call is made with a process id, a dictionary name string, a path name string, and a set string as input to create a new dataset using a registered dictionary.

Parameters:

PID - PID from OpenINI call.

dictionary - Registered dictionary name.

path - Fully qualified path to the location of dataset (extension is defined by the dataset name) file.

dset - The new dataset name.

AddOpenDataSet

public int AddOpenDataSet(int PID,
                          java.lang.String dictionary,
                          java.lang.String path,
                          SystemDev.ByReferenceString dset)

Documentation for: AddOpenDataSet Open a dataset, dataset file must exist or an error will occur. The AddOpenDataSet function call is made with a process id, a path name string, and a set string as input to open an existing dataset to the registry.

Parameters:

PID - PID from OpenINI call.

dictionary - Registered dicitonary name.

path - Fully qualified path to the location of dataset (extension is defined by the dataset name) file.

dset - The dataset name.

DelDataSet

public int DelDataSet(int PID,
                      java.lang.String dset)

Documentation for: DelDataSet Delete a dataset. The DelDataSet function call is made with a process id and a set string as input to delete a dataset. Does not write the dataset before deletion.

Parameters:

PID - PID from OpenINI call.

dset - The dataset name.

SaveDataSet

public int SaveDataSet(int PID,
                       java.lang.String dset)

Documentation for: SaveDataSet Save the dataset. The SaveDataSet function call is made with a process id and a set string as input to save a dataset.

Parameters:

PID - PID from OpenINI call.

dset - The dataset name.

SaveDataSetAs

public int SaveDataSetAs(int PID,
                         java.lang.String dset,
                         java.lang.String path,
                         java.lang.String newset)

Documentation for: SaveDataSetAs Save the dataset with a different name. The SaveDataSetAs function call is made with a process id, an oldSet string, a path string, and a newSet string as input to save a dataset under a new name.

Parameters:

PID - PID from OpenINI call.

dset - The dataset name.

path - Fully qualified path to the location of dataset (extension is defined by the dataset name) file.

newset - The new dataset name.

GetDataSetList

public int GetDataSetList(int PID,
                          java.lang.String delimiter,
                          SystemDev.ByReferenceString list)

Documentation for: GetDataSetList Get the list of all the datasets for simulation.

Parameters:

PID - PID from OpenINI call.

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

list - The complete list of datasets in a string

GetDataSetPath

public int GetDataSetPath(int PID,
                          java.lang.String dataset,
                          SystemDev.ByReferenceString path)

Documentation for: GetDataSetPath Get the path associated with a dictionary. To change the path you need to 1) SaveDictionaryAs changing the path, 2) DelDictionary, and 3) AddOpenDictionary from it new location.

Parameters:

PID - PID from OpenINI call.

dataset - Name of the dataset.

path - The path of the dataset.

AddLink

public int AddLink(int PID,
                   java.lang.String idfrom,
                   java.lang.String idto)

Documentation for: AddLink Returns SUCCESS if the connection is made in the simulation. The AddLink function call is made with a process id, a modIdFrom string, and a modIdTo string as input to connect two modules, and returns a success/fail flag. The arrow of the connection will point from -> to.

Parameters:

PID - PID from OpenINI call.

idfrom - The module to connect from.

idto - The module to connect to.

DelLink

public int DelLink(int PID,
                   java.lang.String fromid,
                   java.lang.String toid)

Documentation for: DelLink Returns SUCCESS if the connection is dropped in the simulation. The DelLink function call is made with a process id, a modIdFrom string, and a modIdTo string as input to delete the connection between two modules, and returns a success/fail flag.

Parameters:

PID - PID from OpenINI call.

fromid - The module to connect from.

toid - The module to connect to.

AddIcon

public int AddIcon(int PID,
                   int scope,
                   java.lang.String domainName,
                   java.lang.String className,
                   java.lang.String group,
                   java.lang.String subgroup,
                   SystemDev.ByReferenceString id)

Documentation for: AddIcon Returns the module ID added to the simulation. if scope is 0 then the icon is added to the global diagram. if scope is non zero it is added to the local diagram.

Parameters:

PID - PID from OpenINI call.

scope - The scope to add icon to.

domainName - The domain name.

className - The class name.

group - The group name.

subgroup - The subgroup name.

id - The unique identifier for the new icon.

DelIcon

public int DelIcon(int PID,
                   java.lang.String id)

Documentation for: DelIcon Deletes the module ID from the simulation. The DelIcon function call is made with a process id and a id string as input to delete the module ID from the simulation.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

GetIconUIDic

public int GetIconUIDic(int PID,
                        java.lang.String id,
                        SystemDev.ByReferenceString dictionary)

Documentation for: GetIconUIDic Returns the dic for the module icon returns "" when no set exists.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

dictionary - Registered dicitonary name.

GetIconUISet

public int GetIconUISet(int PID,
                        java.lang.String id,
                        SystemDev.ByReferenceString dataset)

Documentation for: GetIconUISet Returns the set for the module icon returns "" when no set exists.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

dataset - Dataset name.

SetIconMod

public int SetIconMod(int PID,
                      java.lang.String id,
                      java.lang.String module,
                      java.lang.String scheme,
                      java.lang.String delimiter,
                      java.lang.String list)

Documentation for: SetIconMod Sets module and scheme associated with an icon. A subset of the datasets the icon consumes is given in the list parameter.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

module - The module to use.

scheme - The connection scheme to use.

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

list - The complete list of datasets in a string

GetIconMod

public int GetIconMod(int PID,
                      java.lang.String id,
                      SystemDev.ByReferenceString module,
                      SystemDev.ByReferenceString scheme)

Documentation for: GetIconMod Sets module and scheme associated with an icon. A list of datasets is returned in the list parameter.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

module - The module that is being used.

scheme - The connection scheme that is used.

GetIconUIArgs

public int GetIconUIArgs(int PID,
                         java.lang.String id,
                         SystemDev.ByReferenceString path,
                         SystemDev.ByReferenceString cmdline)

Documentation for: GetIconUIArgs Get the commandline arguments for a given id. The active part of the icon is the user interface that requires the user to be active during its execution.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

path - Fully qualified path to the location of the user interface.

cmdline - Options passed on the command line for the user interface.

RunIconUI

public int RunIconUI(int PID,
                     java.lang.String id,
                     java.lang.String path,
                     java.lang.String cmdline,
                     java.lang.String wrnfile,
                     java.lang.String errfile)

Documentation for: RunIconUI The active part of the icon is the user interface that requires the user to be active during its execution. The RunIconActive function call is made with a process id and a modId string as input to run the active module. Returns a success/fail flag. See GetIconActiveArgs for the cmdline parameter.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

path - Fully qualified path to the location of user interface for the module.

cmdline - Options passed on the command line for the user interface.

wrnfile - Fully qualified path to the location of output warning file.

errfile - Fully qualified path to the location of output error file.

GetIconModelArgs

public int GetIconModelArgs(int PID,
                            java.lang.String id,
                            SystemDev.ByReferenceString path,
                            SystemDev.ByReferenceString cmdline)

Documentation for: GetIconModelArgs The passive part of the icon is the model itself that requires NO user to be active during its execution.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

path - Fully qualified path to the location of model.

cmdline - Options passed on the command line for the model.

RunIconModel

public int RunIconModel(int PID,
                        java.lang.String id,
                        java.lang.String path,
                        java.lang.String cmdline,
                        java.lang.String wrnfile,
                        java.lang.String errfile)

Documentation for: RunIconModel The passive part of the icon is the model itself that requires NO user to be active during its execution. The RunModPassive function call is made with a process id and a modId string as input to run a passive module. Returns a success/fail flag.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

path - Fully qualified path to the location of the model.

cmdline - Options passed on the command line for the model.

wrnfile - Fully qualified path to the location of output warning file.

errfile - Fully qualified path to the location of output error file.

IsIconUIOk

public int IsIconUIOk(int PID,
                      java.lang.String id)

Documentation for: IsIconUIOk Returns SUCCESS if no error during the execution of the user interface.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

IsIconModelOk

public int IsIconModelOk(int PID,
                         java.lang.String id)

Documentation for: IsIconModelOk Returns SUCCESS if no error during the execution of the model.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

IsIconInfoOk

public int IsIconInfoOk(int PID,
                        java.lang.String id)

Documentation for: IsIconInfoOk Returns SUCCESS if no error if the information for the module is complete (i.e. module and scheme have been chosen).

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

RunBetween

public int RunBetween(int PID,
                      java.lang.String idBegin,
                      java.lang.String idEnd)

Documentation for: RunBetween Returns SUCCESS if no error.

Parameters:

PID - PID from OpenINI call.

idBegin - The unique identifier for the icon.

idEnd - The unique identifier for the icon.

SetState

public int SetState(int PID,
                    java.lang.String id,
                    int state,
                    int downstate)

Documentation for: SetState Abitrarily set the state of an icon.

Parameters:

PID - PID from OpenINI call.

id - The unique identifier for the icon.

state - The new state of the icon.

downstate - .

LaunchTool

public int LaunchTool(int PID,
                      java.lang.String moduleName,
                      int isSystemTool,
                      java.lang.String iconId)

Documentation for: LaunchTool Launches the specified module.

Parameters:

PID - PID from OpenINI call.

moduleName - The module name.

isSystemTool - Flag determines arguments passed to tool.

iconId - The unique identifier for the icon, only applicable if not system tool and simulation is open.

Launcher

public int Launcher(java.lang.String path,
                    java.lang.String cmdline,
                    int wait)

Documentation for: Launcher Launches the specified module.

Parameters:

path - Path to executable.

cmdline - Commandline arguments.

wait - Wait for completion if non-zero, else return immediately.