FRAMES2API
Class References

java.lang.Object
  FRAMES2API.References

public class References
extends java.lang.Object

Nested Class Summary

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

Constructor Summary

References()

Method Summary

int	AddRef(int PID, java.lang.String _name, java.lang.String _ref) Documentation for: AddRef Add a reference to the reference dataset.
int	AddVarRef(int PID, java.lang.String _dataset, java.lang.String _variable, int _1, int _2, int _3, int _4, int _5, int _6, java.lang.String _refName) Documentation for: AddVarRef Associate a reference with a variable or value using the indices _1 through _6.
int	DelRef(int PID, java.lang.String _name) Documentation for: DelRef Deletes a reference from the reference dataste.
int	DelVarRef(int PID, java.lang.String _dataset, java.lang.String _variable, int _1, int _2, int _3, int _4, int _5, int _6, java.lang.String _refName) Documentation for: DelVarRef Dis-associate a reference with a variable or value using the indices _1 through _6.
int	FindRef(int PID, java.lang.String _refName, References.ByReferenceInteger pos) Documentation for: FindRef Returns the index of the reference with name _name.
int	GetRef(int PID, java.lang.String _refName, References.ByReferenceString _ref) Documentation for: GetRef Retreive a reference from the reference dataset, using the reference name/id as a search key.
int	GetRefByIndex(int PID, int _index, References.ByReferenceString _refName, References.ByReferenceString _ref) Documentation for: GetRefByIndex Retreive a reference from the reference dataset using an index.
int	GetRefCount(int PID, int[] _count) Documentation for: GetRefCount Retrieves the number of references in the references dataset.
int	GetVarRef(int PID, java.lang.String _dataset, java.lang.String _variable, int _1, int _2, int _3, int _4, int _5, int _6, int _refIndex, References.ByReferenceString _refName) Documentation for: GetVarRef Returns the reference at position _index in the references list associated with the variable/value at _variable and indices _1 through _6.
int	GetVarRefCount(int PID, java.lang.String _dataset, java.lang.String _variable, int _1, int _2, int _3, int _4, int _5, int _6, References.ByReferenceInteger _refCount) Documentation for: GetVarRefCount Returns the amount of references associated with the variable/value at _variable and indices _1 through _6.
int	PutRef(int PID, int _pos, java.lang.String _refName, java.lang.String _ref) Documentation for: PutRef Puts a reference name/id and it's reference to position _pos.
int	SaveRefs(int PID) Documentation for: SaveRefs Save the references permanently (to disk).
int	SaveVarRefs(int PID) Documentation for: SaveVarRefs Save the used references permanently (to disk).
int	ViewRefDialog(int PID, java.lang.String _dataset, java.lang.String _variable, int _1, int _2, int _3, int _4, int _5, int _6) Documentation for: ViewRefDialog Display a modal box for managing references to a particular value.
int	ViewRefsDialog(int PID) Documentation for: ViewRefsDialog Display a modal box for managing all references via an interface.

Methods inherited from class java.lang.Object

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

Constructor Detail

References

public References()

Method Detail

SaveRefs

public int SaveRefs(int PID)

Documentation for: SaveRefs Save the references permanently (to disk). Return is negative if error.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

SaveVarRefs

public int SaveVarRefs(int PID)

Documentation for: SaveVarRefs Save the used references permanently (to disk). Return is negative if error.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

FindRef

public int FindRef(int PID,
                   java.lang.String _refName,
                   References.ByReferenceInteger pos)

Documentation for: FindRef Returns the index of the reference with name _name. Search is linear, thus slow. Return is negative if failure.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

_refName - The reference name/id to find.

pos - The position at which _refName is found. Negative if not found.

PutRef

public int PutRef(int PID,
                  int _pos,
                  java.lang.String _refName,
                  java.lang.String _ref)

Documentation for: PutRef Puts a reference name/id and it's reference to position _pos. By put, i mean any values at _pos will be replaced. This is a useful function for renaming references or editing existing references.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

_pos - The position to store _refName and the reference _ref.

_refName - The reference name/id to put.

_ref - The reference to put

AddRef

public int AddRef(int PID,
                  java.lang.String _name,
                  java.lang.String _ref)

Documentation for: AddRef Add a reference to the reference dataset.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

_name - The name or ID of the reference to add.

_ref - The reference string (associated with _name) to add.

GetRef

public int GetRef(int PID,
                  java.lang.String _refName,
                  References.ByReferenceString _ref)

Documentation for: GetRef Retreive a reference from the reference dataset, using the reference name/id as a search key.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

_refName - The name or ID associated with the reference to retrieve.

_ref - The reference will be stored here if function is successful.

DelRef

public int DelRef(int PID,
                  java.lang.String _name)

Documentation for: DelRef Deletes a reference from the reference dataste. WARNING this function doesn't track down all the variables/values that are associated with this references and remove them. You would have to go through manually and remove each references to this reference.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

_name - The name or ID associated with the reference to delete.

GetRefCount

public int GetRefCount(int PID,
                       int[] _count)

Documentation for: GetRefCount Retrieves the number of references in the references dataset. Use this function with GetRefByIndex to enumerate through all the references.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

_count - If functions has success, _count will hold the number of references.

GetRefByIndex

public int GetRefByIndex(int PID,
                         int _index,
                         References.ByReferenceString _refName,
                         References.ByReferenceString _ref)

Documentation for: GetRefByIndex Retreive a reference from the reference dataset using an index.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

_index - The index in the references dataset list.

_refName - The name/ID at _index to retrieve.

_ref - The reference at _index to retrieve.

AddVarRef

public int AddVarRef(int PID,
                     java.lang.String _dataset,
                     java.lang.String _variable,
                     int _1,
                     int _2,
                     int _3,
                     int _4,
                     int _5,
                     int _6,
                     java.lang.String _refName)

Documentation for: AddVarRef Associate a reference with a variable or value using the indices _1 through _6. This function does no checking to verify that a value actually exists at the indices. The indices don't even have to point to the variable/value you want to associate with a reference, but it is easier to pretend that they do.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

_dataset - The dataset which holds the variable/value.

_variable - The variable associated with the reference.

_1 - The first index/dimension.

_2 - The second index/dimension.

_3 - The third index/dimension.

_4 - The fourth index/dimension.

_5 - The fifth index/dimension.

_6 - The sixth index/dimension.

_refName - The name/ID of reference to associate with the _dataset and _variable and the indices _1 through _6.

DelVarRef

public int DelVarRef(int PID,
                     java.lang.String _dataset,
                     java.lang.String _variable,
                     int _1,
                     int _2,
                     int _3,
                     int _4,
                     int _5,
                     int _6,
                     java.lang.String _refName)

Documentation for: DelVarRef Dis-associate a reference with a variable or value using the indices _1 through _6. This function does no checking to verify that a value actually exists at the indices. The indices don't even have to point to the variable/value you want to associate with a reference, but it is easier to pretend that they do.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

_dataset - The dataset which holds the variable/value.

_variable - The variable associated with the reference.

_1 - The first index/dimension.

_2 - The second index/dimension.

_3 - The third index/dimension.

_4 - The fourth index/dimension.

_5 - The fifth index/dimension.

_6 - The sixth index/dimension.

_refName - The name/ID of reference to dis-associate with using the _dataset and _variable and the indices _1 through _6.

GetVarRefCount

public int GetVarRefCount(int PID,
                          java.lang.String _dataset,
                          java.lang.String _variable,
                          int _1,
                          int _2,
                          int _3,
                          int _4,
                          int _5,
                          int _6,
                          References.ByReferenceInteger _refCount)

Documentation for: GetVarRefCount Returns the amount of references associated with the variable/value at _variable and indices _1 through _6. This function does no checking to verify that a value actually exists at the indices. The indices don't even have to point to the variable/value you want to associate with a reference, but it is easier to pretend that they do.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

_dataset - The dataset which holds the variable/value.

_variable - The variable associated with the reference.

_1 - The first index/dimension.

_2 - The second index/dimension.

_3 - The third index/dimension.

_4 - The fourth index/dimension.

_5 - The fifth index/dimension.

_6 - The sixth index/dimension.

_refCount - The number of references associated with the variable in _dataset specified at indices _1 through _6.

GetVarRef

public int GetVarRef(int PID,
                     java.lang.String _dataset,
                     java.lang.String _variable,
                     int _1,
                     int _2,
                     int _3,
                     int _4,
                     int _5,
                     int _6,
                     int _refIndex,
                     References.ByReferenceString _refName)

Documentation for: GetVarRef Returns the reference at position _index in the references list associated with the variable/value at _variable and indices _1 through _6. Use GetRef with _refName to get the reference from the reference dataset. This function does no checking to verify that a value actually exists at the indices. The indices don't even have to point to the variable/value you want to associate with a reference, but it is easier to pretend that they do.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

_dataset - The dataset which holds the variable/value.

_variable - The variable associated with the reference.

_1 - The first index/dimension.

_2 - The second index/dimension.

_3 - The third index/dimension.

_4 - The fourth index/dimension.

_5 - The fifth index/dimension.

_6 - The sixth index/dimension.

_refIndex - The index position in the references list pointing to the reference name/ID to retrieve.

_refName - The reference name/ID returned from index specified by _index.

ViewRefsDialog

public int ViewRefsDialog(int PID)

Documentation for: ViewRefsDialog Display a modal box for managing all references via an interface. After closing the dialog, all changes are saved permanently. Return is negative if error.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

ViewRefDialog

public int ViewRefDialog(int PID,
                         java.lang.String _dataset,
                         java.lang.String _variable,
                         int _1,
                         int _2,
                         int _3,
                         int _4,
                         int _5,
                         int _6)

Documentation for: ViewRefDialog Display a modal box for managing references to a particular value. After closing the dialog, all changes are saved permanently. Return is negative if error.

Parameters:

PID - The ProcessID from OpenIO or OpenINI

_dataset - The dataset which holds the variable/value.

_variable - The variable associated with the reference.

_1 - The first index/dimension.

_2 - The second index/dimension.

_3 - The third index/dimension.

_4 - The fourth index/dimension.

_5 - The fifth index/dimension.

_6 - The sixth index/dimension.