A B C D E F G H I K L M N O P R S T U W
A
- Active() -
Method in class au.gov.aao.drama.DramaPath
- Indicates if the path is active (you can send messages along it).
- Add(String, DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaMonitor
- Send a monitor ADD message to the task assocaited with this
monitor.
- Add(String, DramaTask.Action) -
Method in class au.gov.aao.drama.DramaTask
- Add an action to the task.
- Add(String, DramaTask.KickableAction) -
Method in class au.gov.aao.drama.DramaTask
- Add a kickable action to the task.
- ALARM -
Static variable in class au.gov.aao.drama.DramaTask.ErsMessage
- Indicates the message is very important and should probably
be acknowledged by the user.
- Alarm() -
Method in class au.gov.aao.drama.DramaTask.ErsMessage
- Indicate if the ALARM flag of the message has been set.
- Annul() -
Static method in class au.gov.aao.drama.DramaErs
- Annul messages at the current DRAMA Error reporting context.
- Arg - Class in au.gov.aao.drama
- This class implements an interface to the AAO's
DRAMA SDS Library Java equivalent to the Arg library interface to SDS.
- Arg(int) -
Constructor for class au.gov.aao.drama.Arg
- Create an Arg instance using a C SDS ID value.
- Arg(int, boolean) -
Constructor for class au.gov.aao.drama.Arg
- Create an Arg instance using a C SDS ID value, with free flag specified.
- Arg(int, boolean, boolean) -
Constructor for class au.gov.aao.drama.Arg
- Create an Arg instance using a SDS C ID value, with free and delete
flags.
- Arg(int, boolean, boolean, boolean) -
Constructor for class au.gov.aao.drama.Arg
- Create an Arg instance using a SDS C ID value, with all flags
specifyable.
- Arg() -
Constructor for class au.gov.aao.drama.Arg
- Create a new Arg instance item including creation of the underlying
SDS structure.
- Arg(String) -
Constructor for class au.gov.aao.drama.Arg
- Create a new Arg instance item including creation of the underlying
SDS structure.
- Arg(SdsID, boolean) -
Constructor for class au.gov.aao.drama.Arg
- Create a new Arg instance refering to the same SDS item as an
SdsID instance.
- Arg(SdsID, String) -
Constructor for class au.gov.aao.drama.Arg
- Create a new Arg instance refering a component of an SDS structure.
- Arg(SdsID, String, int) -
Constructor for class au.gov.aao.drama.Arg
- Create a new child ARG item (of an SDS structure).
- Arg(SdsID, String, int, int[]) -
Constructor for class au.gov.aao.drama.Arg
- Create a new array child ARG item
- Arg(String, int, int[]) -
Constructor for class au.gov.aao.drama.Arg
- Create a new array top-level ARG item
- Arg(SdsID, int[]) -
Constructor for class au.gov.aao.drama.Arg
- Create an access to a cell of an existing SDS structure array.
- Arg(SdsID) -
Constructor for class au.gov.aao.drama.Arg
- Create a copy of an existing SDS item.
- Arg(SdsID, int) -
Constructor for class au.gov.aao.drama.Arg
- Create an access to a existing SDS structure by index
- Arg.StructList - Interface in au.gov.aao.drama
- This inteface is used by the
Arg.List() method to print a
single line when listing an SDS structure. - ARG_COPY -
Static variable in class au.gov.aao.drama.DramaTask
- A flag supplied to RequestExit()/RequestEnd() which indicates
the argument should be copied immediately and deleted by DRAMA
when appropiate.
- ARG_DELETE -
Static variable in class au.gov.aao.drama.DramaTask
- A flag supplied to RequestExit()/RequestEnd() which indicates
the argument should be deleted by DRAMA when appropiate.
- ARG_FREEID -
Static variable in class au.gov.aao.drama.DramaTask
- A flag supplied to RequestExit()/RequestEnd() which indicates
the argument (and SDS id) should be free-ed by DRAMA when appropiate.
- ARG_NODELETE -
Static variable in class au.gov.aao.drama.DramaTask
- A flag supplied to RequestExit()/RequestEnd() which indicates
the argument should not be deleted and not be copied.
- ARG_READFREE -
Static variable in class au.gov.aao.drama.DramaTask
- A flag supplied to RequestExit()/RequestEnd() which indicates
the argument is an SDS id obtained by reading an SDS file and
should be cleaned-up appropiately by DRAMA when appropiate.
- au.gov.aao.drama - package au.gov.aao.drama
- A package which provides a JAVA Interface to the
AAO's
DRAMA API, allowing DRAMA tasks and GUI's to be implementing in JAVA.
B
- BELL -
Static variable in class au.gov.aao.drama.DramaTask.ErsMessage
- Indicates the terminal bell should be rung when the message
is displayed.
- BoolValue(String) -
Method in class au.gov.aao.drama.Arg
- Return an boolean from a named Arg item.
- BoolValue(String) -
Static method in class au.gov.aao.drama.Sdp
- Return an boolean from a named Sdp parameter.
- Busy() -
Method in class au.gov.aao.drama.DramaPath
- Indicates if operations are currently in progress to set up
a path to the task.
C
- Cancel(DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaMonitor
- Send a monitor CANCEL message to the task assocaited with this
monitor.
- Changed(DramaMonitor, DramaTask, String, Arg) -
Method in class au.gov.aao.drama.DramaMonitor.MonResponse
- Handle the parameter changed monitor message.
- CheckWeHaveIt() -
Static method in class au.gov.aao.drama.DramaSem
- Throw an exception if the current thread does not have the DRAMA semaphore.
- ClearDelete() -
Method in class au.gov.aao.drama.SdsID
- Clear DELETE flag.
- ClearFree() -
Method in class au.gov.aao.drama.SdsID
- Clear FREE flag.
- ClearFreeIDWatch() -
Static method in class au.gov.aao.drama.SdsID
- Clear watching of an ID.
- ClearNames() -
Method in class au.gov.aao.drama.DramaPath
- Clear Names load time flag.
- ClearProg() -
Method in class au.gov.aao.drama.DramaPath
- Clear PROG load time flag.
- ClearReadFree() -
Method in class au.gov.aao.drama.SdsID
- Clear READ-FREE flag.
- ClearState() -
Method in class au.gov.aao.drama.DramaPath
- Clear the task state.
- ClearSymbols() -
Method in class au.gov.aao.drama.DramaPath
- Clear Symbols load time flag.
- Close() -
Method in class au.gov.aao.drama.DramaTask
- Deprecated. Replaced by
DramaTask.CloseTask()
which does not throw any checked exceptions.
- CloseTask(int) -
Method in class au.gov.aao.drama.DramaTask
- Close down a DRAMA task.
- CloseTask(DramaException) -
Method in class au.gov.aao.drama.DramaTask
- Close down a DRAMA task.
- CloseTask() -
Method in class au.gov.aao.drama.DramaTask
- Close down a DRAMA task.
- Code() -
Method in class au.gov.aao.drama.SdsID
- Return the code of an item.
- Control(String) -
Method in class au.gov.aao.drama.DramaPath
- Control message with name only, default reponse handler.
- Control(String, DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaPath
- Control message with name and handler.
- Control(String, SdsID) -
Method in class au.gov.aao.drama.DramaPath
- Control message with name and argument, default reponse handler.
- Control(String, SdsID, DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaPath
- Control message with name and argument and handler.
- ControlW(String) -
Method in class au.gov.aao.drama.DramaPath
- Send Control Message with name only, wait for completion.
- ControlW(String, SdsID) -
Method in class au.gov.aao.drama.DramaPath
- Send Control message with argument, wait for completion.
- ControlW(String, double) -
Method in class au.gov.aao.drama.DramaPath
- Send control message, wait for completion with timeout.
- ControlW(String, SdsID, double) -
Method in class au.gov.aao.drama.DramaPath
- Send control message with argument, wait for completion with timeout.
- CreateItem(SdsID) -
Static method in class au.gov.aao.drama.Sdp
- Create a parameter by inserting the specified Sds structure into
the parameter system.
- CreateItem(String, char) -
Static method in class au.gov.aao.drama.Sdp
- Create a char (8 bit) parameter.
- CreateItem(String, short) -
Static method in class au.gov.aao.drama.Sdp
- Create a short (16 bit) parameter.
- CreateItem(String, int) -
Static method in class au.gov.aao.drama.Sdp
- Create a int (32bit) parameter.
- CreateItem(String, long) -
Static method in class au.gov.aao.drama.Sdp
- Create a long (64 bit) parameter.
- CreateItem(String, double) -
Static method in class au.gov.aao.drama.Sdp
- Create a double length floating point parameter.
- CreateItem(String, String) -
Static method in class au.gov.aao.drama.Sdp
- Create a string parameter.
- CTX_KICKED -
Static variable in class au.gov.aao.drama.DramaTask
- Possible value from GetContext - Indicates Kick context.
- CTX_OBEY -
Static variable in class au.gov.aao.drama.DramaTask
- Possible value from GetContext - Indicates Obey context.
- CTX_UFACE -
Static variable in class au.gov.aao.drama.DramaTask
- Possible value from GetContext - Indicates User Interface context..
- CurrentTask -
Variable in class au.gov.aao.drama.DramaTask.TaskInfo
- Set true if the task is the current task.
D
- Debug() -
Method in class au.gov.aao.drama.SdsID
- Debugging routine - prints the SDS id and an integer to stdout.
- Debug(String) -
Method in class au.gov.aao.drama.SdsID
-
- Debug(String, SdsID, String) -
Method in class au.gov.aao.drama.SdsID
-
- DeepCopy(SdsID) -
Method in class au.gov.aao.drama.SdsID
- Make this object refer to a deep copy of the source object.
- Delete(String, DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaMonitor
- Send a monitor DELETE message to the task assocaited with this
monitor.
- Delete() -
Method in class au.gov.aao.drama.SdsID
- Delete the item explictly.
- Description -
Variable in class au.gov.aao.drama.DramaTask.TaskInfo
- Set to the Description of the task, as set with DitsSetDetails(3) or
the DramaTask.SetDetails() java method.
- Died() -
Method in class au.gov.aao.drama.DramaPath
- Indicates if the related task has died.
- Dims(int[]) -
Method in class au.gov.aao.drama.SdsID
- Returns the dims of an item,
- Disconnect(DramaTask, DramaPath) -
Method in interface au.gov.aao.drama.DramaPath.DisconnectHandler
- Invoked when a task associated with a DramaPath object disconnects.
- DramaError - Error in au.gov.aao.drama
- Objects of this class are used to convert a checked
DramaException to an unchecked expection. - DramaError(String, int) -
Constructor for error au.gov.aao.drama.DramaError
- Creates a DRAMA Error (unchecked exception) object, with the assocaited DRAMA
status passed as an integer.
- DramaError(String, DramaStatus) -
Constructor for error au.gov.aao.drama.DramaError
- Creates a DRAMA Error (unchecked exception) object, with the assocaited DRAMA
status passed using a DramaStatus object.
- DramaError(DramaException) -
Constructor for error au.gov.aao.drama.DramaError
- Creates a DRAMA Error (unchecked exception) object from a DramaException.
- DramaErs - Class in au.gov.aao.drama
- The DramaErs class is used to access the DRAMA
ERS library.
- DramaException - Exception in au.gov.aao.drama
- Objects of this class are thrown when exceptions occur in
DRAMA software.
- DramaException(String, int) -
Constructor for exception au.gov.aao.drama.DramaException
- Creates a DRAMA Exception object, with the assocaited DRAMA
status passed as an integer.
- DramaException(String, DramaStatus) -
Constructor for exception au.gov.aao.drama.DramaException
- Creates a DRAMA Exception object, with the assocaited DRAMA
status passed using a DramaStatus object.
- DramaMonitor - Class in au.gov.aao.drama
- This class implements parameter monitoring in a
DRAMA
task written in Java - allowing a JAVA DRAMA task to set up DRAMA
parameter monitoring in other DRAMA tasks.
- DramaMonitor(DramaPath, DramaMonitor.MonResponse, boolean, String[]) -
Constructor for class au.gov.aao.drama.DramaMonitor
- Constructor - Start a monitor operation (multiple parameters).
- DramaMonitor(DramaPath, DramaMonitor.MonResponse, boolean, String) -
Constructor for class au.gov.aao.drama.DramaMonitor
- Constructor - Start a monitor operation (single parameter).
- DramaMonitor(DramaPath, DramaMonitor.MonResponse) -
Constructor for class au.gov.aao.drama.DramaMonitor
- Constructor - Start up a monitor operation (no parameters).
- DramaMonitor(DramaPath, String, String, DramaMonitor.MonResponse, boolean, String[]) -
Constructor for class au.gov.aao.drama.DramaMonitor
- Constructor - Start a forward monitor operation (multiple parameters).
- DramaMonitor(DramaPath, String, String, DramaMonitor.MonResponse, boolean, String) -
Constructor for class au.gov.aao.drama.DramaMonitor
- Constructor - Start a forward monitor operation (single parameter).
- DramaMonitor(DramaPath, String, String, DramaMonitor.MonResponse) -
Constructor for class au.gov.aao.drama.DramaMonitor
- Constructor - Start a forward monitor operation (no parameters).
- DramaMonitor.MonResponse - Class in au.gov.aao.drama
- Used to handle DramaMonitor responses.
- DramaMonitor.MonResponse() -
Constructor for class au.gov.aao.drama.DramaMonitor.MonResponse
- Initialise a Monitor Response object.
- DramaPath - Class in au.gov.aao.drama
- This class implements an interface to sending
DRAMA
messages.
- DramaPath(DramaTask, String) -
Constructor for class au.gov.aao.drama.DramaPath
- Contruct a DramaPath object, task known locally, assumes the task
is already loaded.
- DramaPath(DramaTask, String, String) -
Constructor for class au.gov.aao.drama.DramaPath
- Contruct a DramaPath object, assumes the task is already loaded but allows
the node to be specified.
- DramaPath(DramaTask, String, String, String) -
Constructor for class au.gov.aao.drama.DramaPath
- Contruct a DramaPath object with full specification such that the task
can be loaded if need be.
- DramaPath(DramaTask) -
Constructor for class au.gov.aao.drama.DramaPath
- Construct a DramaPath object to this task.
- DramaPath.Buffers - Class in au.gov.aao.drama
- A helper class for defining buffer sizes for use with DramaPath objects.
- DramaPath.Buffers() -
Constructor for class au.gov.aao.drama.DramaPath.Buffers
- Create a Buffers item, default values.
- DramaPath.Buffers(int) -
Constructor for class au.gov.aao.drama.DramaPath.Buffers
- Create a Buffers item, MessageBytes specified.
- DramaPath.Buffers(int, int) -
Constructor for class au.gov.aao.drama.DramaPath.Buffers
- Create a Buffers item, MessageBytes and MaxMesssages specified.
- DramaPath.Buffers(int, int, int) -
Constructor for class au.gov.aao.drama.DramaPath.Buffers
- Create a Buffers item, MessageBytes, MaxMesssages and ReplySize
specified.
- DramaPath.Buffers(int, int, int, int) -
Constructor for class au.gov.aao.drama.DramaPath.Buffers
- Create a Buffers item, all sizes specified.
- DramaPath.DisconnectHandler - Interface in au.gov.aao.drama
- This interface is to be used by objects which are specified
with with
DramaPath.SetDisconnect. - DramaPath.RescheduleHandler - Class in au.gov.aao.drama
- A class which handles rescheduling of a DRAMA Action using the
DramaPath class to messages to other DRAMA tasks.
- DramaPath.RescheduleHandler() -
Constructor for class au.gov.aao.drama.DramaPath.RescheduleHandler
- Default Reschedule handler constructor.
- DramaPath.RescheduleHandler(double) -
Constructor for class au.gov.aao.drama.DramaPath.RescheduleHandler
- Constructors which allows timeout to be set.
- DramaPath.RescheduleHandler(boolean) -
Constructor for class au.gov.aao.drama.DramaPath.RescheduleHandler
- Constructor which initialises threadCount to zero.
- DramaPath.RescheduleHandler(double, boolean) -
Constructor for class au.gov.aao.drama.DramaPath.RescheduleHandler
- Constructor which allows setting of timeout and clearing threadCount.
- DramaPath.RescheduleHandler(boolean, double) -
Constructor for class au.gov.aao.drama.DramaPath.RescheduleHandler
- Constructor which allows setting of timeout and clearing
threadCount.
- DramaPath.RescheduleHandler(DramaTask) -
Constructor for class au.gov.aao.drama.DramaPath.RescheduleHandler
- Reschedule handler constructor which does a implicit Enable().
- DramaPath.RescheduleHandler(DramaTask, double) -
Constructor for class au.gov.aao.drama.DramaPath.RescheduleHandler
- Reschedule handler constructor which does a implicit Enable() and allows timeout to be set.
- DramaPath.RescheduleHandler(DramaTask, boolean) -
Constructor for class au.gov.aao.drama.DramaPath.RescheduleHandler
- Reschedule handler constructor which does a implicit Enable() and sets thread count to 0.
- DramaPath.RescheduleHandler(DramaTask, double, boolean) -
Constructor for class au.gov.aao.drama.DramaPath.RescheduleHandler
- Reschedule handler constructor which does a implicit Enable(), sets timeout and zero's thread count.
- DramaPath.RescheduleHandler(DramaTask, boolean, double) -
Constructor for class au.gov.aao.drama.DramaPath.RescheduleHandler
- Reschedule handler constructor which does a implicit Enable(), sets timeout and zero's thread count.
- DramaPath.ResponseHandler - Class in au.gov.aao.drama
- A class which handles responding to DRAMA messages initiated
using a DramaPath object.
- DramaPath.ResponseHandler(DramaPath) -
Constructor for class au.gov.aao.drama.DramaPath.ResponseHandler
- Construct a DramaPath.ResponseHandler object.
- DramaSem - Class in au.gov.aao.drama
- A multiple entry semaphore which is used to protect DRAMA's internal
structures from multithread access from JAVA.
- DramaSem.SemInterrupt - Error in au.gov.aao.drama
- A class thrown when an interrupt occurs whist waiting for the DRAMA
Semaphore.
- DramaSem.SemTimeout - Error in au.gov.aao.drama
- A class thrown when an timeout occurs whist waiting for the DRAMA
Semaphore.
- DramaStatus() -
Method in error au.gov.aao.drama.DramaError
- Return the DRAMA status code associated with an exception.
- DramaStatus() -
Method in exception au.gov.aao.drama.DramaException
- Return the DRAMA status code associated with an exception.
- DramaStatus - Class in au.gov.aao.drama
- The DramaStatus class is used to access DRAMA
status codes.
- DramaStatus(int) -
Constructor for class au.gov.aao.drama.DramaStatus
- Construct a DramaStatus value from an integer value
- DramaStatusInt() -
Method in error au.gov.aao.drama.DramaError
- Return the DRAMA status code associated with an exception.
- DramaStatusInt() -
Method in exception au.gov.aao.drama.DramaException
- Return the DRAMA status code associated with an exception.
- DramaTask - Class in au.gov.aao.drama
- This class implements an AAO
DRAMA
task in Java.
- DramaTask(String) -
Constructor for class au.gov.aao.drama.DramaTask
- Creates a DRAMA task of a given name, default initializations.
- DramaTask(String, int) -
Constructor for class au.gov.aao.drama.DramaTask
- Creates a DRAMA task of a given name with global buffer size specified.
- DramaTask(String, int, int) -
Constructor for class au.gov.aao.drama.DramaTask
- Creates a DRAMA task of a given name, global buffer and flags specified.
- DramaTask(String, int, int, int) -
Constructor for class au.gov.aao.drama.DramaTask
- Creates a DRAMA task of a given name with all details specified.
- DramaTask.Action - Interface in au.gov.aao.drama
- This interface is be used by objects which implement DRAMA Obey message
handlers.
- DramaTask.ErsHandler - Interface in au.gov.aao.drama
- An inteface to be implemented by objects which output ERS messages.
- DramaTask.ErsMessage - Class in au.gov.aao.drama
- A Class used to represent a DRAMA ERS message report.
- DramaTask.ErsMessage(String, int, int) -
Constructor for class au.gov.aao.drama.DramaTask.ErsMessage
- Construct an ERS message object.
- DramaTask.KickableAction - Interface in au.gov.aao.drama
- This interface is be used by objects which implement DRAMA Obey message
handlers.
- DramaTask.KickHandler - Interface in au.gov.aao.drama
- This interface is be used by objects which implement DRAMA Kick message
handlers.
- DramaTask.MsgHandler - Interface in au.gov.aao.drama
- An inteface to be implemented by objects which output MsgOut messages.
- DramaTask.TaskInfo - Class in au.gov.aao.drama
- A class used with the DramaTask.Tasks() function, to return the details
of currently known DRAMA tasks.
- DramaTask.TaskInfo(String, String, int, boolean, boolean, boolean, boolean) -
Constructor for class au.gov.aao.drama.DramaTask.TaskInfo
- Constructor for this object, only invoked from the Native.
E
- Enable(DramaTask) -
Method in class au.gov.aao.drama.DramaPath.RescheduleHandler
- Enable this reschedule handler.
- EnableFreeIDWatch() -
Method in class au.gov.aao.drama.SdsID
- Enable watching of this SDS id by low level SDS debugging code.
- equals(DramaStatus) -
Method in class au.gov.aao.drama.DramaStatus
- Tests a status code for equality with another status code
Remember that == will only test for a reference to the same object,
you must use this member function to test if two objects contain
the same code.
- equals(int) -
Method in class au.gov.aao.drama.DramaStatus
- Tests a status code for equality with an integer value.
- Error(DramaPath, DramaTask) -
Method in class au.gov.aao.drama.DramaMonitor
- Override of DramaPath.ResponseHandler.Error() routine - used
internally to implement functionally.
- Error(DramaPath, DramaTask) -
Method in class au.gov.aao.drama.DramaPath.ResponseHandler
- Invoked when a message has completed with error.
- ErrorCompletion(DramaMonitor, DramaTask) -
Method in class au.gov.aao.drama.DramaMonitor.MonResponse
- Handle the completion with an error of a monitor transaction.
- Ers(DramaPath, DramaTask) -
Method in class au.gov.aao.drama.DramaPath.ResponseHandler
- Invoked when a Ers message has been received.
- Extract() -
Method in class au.gov.aao.drama.SdsID
- Extract the item from its top level structure
This method makes the current item a top-level item in it's own
right.
F
- FC_IC -
Static variable in class au.gov.aao.drama.DramaTask
- Possible flag to DramaTask constructor.
- FillArray(SdsID) -
Method in class au.gov.aao.drama.SdsID
- Fill a structured array with copies of a specified structure.
- finalize() -
Method in class au.gov.aao.drama.DramaPath
- DramaPath finalizer.
- finalize() -
Method in class au.gov.aao.drama.DramaTask
- DramaTask Destructor.
- finalize() -
Method in class au.gov.aao.drama.SdsID
- Finalizer for the SdsID class.
- Finished(DramaTask) -
Method in class au.gov.aao.drama.DramaPath.RescheduleHandler
- Invoked when the last DRAMA message thread has finished.
- Flush() -
Static method in class au.gov.aao.drama.DramaErs
- Flush messages at the current DRAMA Error reporting context.
- Flush() -
Static method in exception au.gov.aao.drama.DramaException
- Flush ERS messages without return status to JAVA.
- ForceMsgLoopExit() -
Method in class au.gov.aao.drama.DramaTask
- Force RunDrama() to retrun.
- Forget() -
Method in class au.gov.aao.drama.DramaPath.ResponseHandler
- Forget this transaction.
- Forgotten() -
Method in class au.gov.aao.drama.DramaPath.ResponseHandler
- Has this transaction been forgotten?
G
- Get(String) -
Method in class au.gov.aao.drama.DramaPath
- Get Parameter with name only, default reponse handler.
- Get(String, DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaPath
- Get Parameter with name and handler.
- Get(String[], DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaPath
- Multiple Parameter Get with name and response handler.
- Get(String[]) -
Method in class au.gov.aao.drama.DramaPath
- Multiple Parameter Get with names only, default response handler.
- Get(int, long[]) -
Method in class au.gov.aao.drama.SdsID
- Get long (64 bit) DATA from the SDS item.
- Get(int, int[]) -
Method in class au.gov.aao.drama.SdsID
- Get int (32 bit) DATA from the SDS item.
- Get(int, short[]) -
Method in class au.gov.aao.drama.SdsID
- Get short (16 bit) DATA from the SDS item.
- Get(int, byte[]) -
Method in class au.gov.aao.drama.SdsID
- Get byte (8 bit) DATA from the SDS item.
- Get(int) -
Method in class au.gov.aao.drama.SdsID
- Return string DATA from the SDS item into a string.
- Get(boolean) -
Method in class au.gov.aao.drama.SdsID
- Get a string array from the SDS item.
- Get(int, float[]) -
Method in class au.gov.aao.drama.SdsID
- Get float DATA from the SDS item.
- Get(int, double[]) -
Method in class au.gov.aao.drama.SdsID
- Get double length floating point DATA from the SDS item.
- GetActIndex() -
Method in class au.gov.aao.drama.DramaTask
- Returns the action index of the current action.
- GetArgument() -
Method in class au.gov.aao.drama.DramaTask
- Get action argument.
- GetContext() -
Method in class au.gov.aao.drama.DramaTask
- Return DRAMA Context.
- GetContructorLocation() -
Method in class au.gov.aao.drama.SdsID
- Returns a string giving the location from which the constructor for
this object was invoked.
- GetDramaException() -
Method in error au.gov.aao.drama.DramaError
- Returns a reference to the underlying Drama Exception object
- GetEntName() -
Method in class au.gov.aao.drama.DramaTask
- Get the entry name.
- GetEntReason() -
Method in class au.gov.aao.drama.DramaTask
- Get the Reason for this action entry.
- GetEntStatus() -
Method in class au.gov.aao.drama.DramaTask
- Get the DRAMA Status associated with this action entry.
- GetEntTransId() -
Method in class au.gov.aao.drama.DramaTask
- Get the entry transaction id.
- GetName() -
Method in class au.gov.aao.drama.DramaTask
- Get the action name.
- GetPath(DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaPath
- Get a path to the task, using default buffers.
- GetPath(DramaPath.ResponseHandler, DramaPath.Buffers) -
Method in class au.gov.aao.drama.DramaPath
- Get a path to the task, specifying buffer sizes.
- GetPath() -
Method in class au.gov.aao.drama.DramaPath
- Get a path to the task - using a default response handler.
- GetPathLoaded() -
Method in class au.gov.aao.drama.DramaPath
- Indicate if GetPath caused the task to be loaded.
- GetPathW(DramaPath.Buffers) -
Method in class au.gov.aao.drama.DramaPath
- Get a path to the task, waiting for completion, specifying buffer sizes
and timeout.
- GetPathW(DramaPath.Buffers, double) -
Method in class au.gov.aao.drama.DramaPath
- Get a path to the task, waiting for completion, specifying buffer sizes
and timeout.
- GetPathW() -
Method in class au.gov.aao.drama.DramaPath
- Get a path to the task - waiting for completion.
- GetPathW(double) -
Method in class au.gov.aao.drama.DramaPath
- Get a path to the task - waiting for completion, but with timeout.
- GetSeq() -
Method in class au.gov.aao.drama.DramaTask
- Return DRAMA action Sequence number.
- GetSymbol(String) -
Static method in class au.gov.aao.drama.DramaTask
- Get a symbol (environment variable) value.
- GetTaskName() -
Method in class au.gov.aao.drama.DramaTask
-
- GetW(String) -
Method in class au.gov.aao.drama.DramaPath
- Get a parameter value and wait for completion.
- GetW(String, double) -
Method in class au.gov.aao.drama.DramaPath
- Get a parameter value and wait for completion and timeout.
- GetW(String[]) -
Method in class au.gov.aao.drama.DramaPath
- Get Multiple parameter values and wait for completion.
- GetW(String[], double) -
Method in class au.gov.aao.drama.DramaPath
- Get multiple parameter values and wait for completion and timeout.
- GitLogger(String) -
Method in class au.gov.aao.drama.DramaTask
- Enable the GIT Logger.
- GitLogger(String, String) -
Method in class au.gov.aao.drama.DramaTask
- Enable the GIT Logger.
H
- HaveIt() -
Static method in class au.gov.aao.drama.DramaSem
- Returns true if the DRAMA semaphore is currently taken by this thread.
- HIGHLIGHT -
Static variable in class au.gov.aao.drama.DramaTask.ErsMessage
- Indicates the message should be Highlite when displayed.
- Highlight() -
Method in class au.gov.aao.drama.DramaTask.ErsMessage
- Indicate if the HIGHLIGH flag of the message has been set.
I
- id -
Variable in class au.gov.aao.drama.SdsID
- The underlying SDS ID of the item.
- ID() -
Method in class au.gov.aao.drama.SdsID
- Return the SdsID as an integer.
- Init(DramaTask) -
Static method in class au.gov.aao.drama.Sdp
- Add the SDP parameter system to a DRAMA task.
- Initial() -
Method in class au.gov.aao.drama.DramaPath
- Indicates if GetPath is needed.
- Insert(SdsID) -
Method in class au.gov.aao.drama.SdsID
- Insert a new object into our object.
- Insert(SdsID, int[]) -
Method in class au.gov.aao.drama.SdsID
- Insert a new object into a structured array item.
- IntValue(String) -
Method in class au.gov.aao.drama.Arg
- Return an integer (up to 32 bit value) from a named Arg item.
- IntValue(String) -
Static method in class au.gov.aao.drama.Sdp
- Return an integer (up to 32 bit value) from a named Sdp parameter.
- IsOrphan(long) -
Method in class au.gov.aao.drama.DramaTask
- Indicate if a transaction has been orphaned.
- IsTaken() -
Static method in class au.gov.aao.drama.DramaSem
- Returns true if the Drama Semaphore has been taken.
K
- Kick(String) -
Method in class au.gov.aao.drama.DramaPath
- Kick with name only, default reponse handler.
- Kick(String, DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaPath
- Kick with name and handler.
- Kick(String, SdsID) -
Method in class au.gov.aao.drama.DramaPath
- Kick with name and argument, default reponse handler.
- Kick(String, SdsID, DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaPath
- Kick with name, argument and handler.
- Kick(DramaTask) -
Method in interface au.gov.aao.drama.DramaTask.KickableAction
- Invoked when DRAMA task receives a Kick message for the action.
- Kick(DramaTask) -
Method in interface au.gov.aao.drama.DramaTask.KickHandler
- Invoked when DRAMA task receives a Kick message for the action.
- KickForget(String) -
Method in class au.gov.aao.drama.DramaPath
- Kick with name only, default reponse handler, transaction orphaned.
- KickForget(String, DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaPath
- Kick with name and handler, transaction orphaned.
- KickForget(String, SdsID) -
Method in class au.gov.aao.drama.DramaPath
- Kick with name and argument, default reponse handler, orphaned.
- KickForget(String, SdsID, DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaPath
- Kick with name, argument and handler.
- KickW(String) -
Method in class au.gov.aao.drama.DramaPath
- Kick with name only, wait for completion.
- KickW(String, SdsID) -
Method in class au.gov.aao.drama.DramaPath
- Kick with name and argument, wait for completion.
- KickW(String, double) -
Method in class au.gov.aao.drama.DramaPath
- Kick with name, wait for completion with timeout.
- KickW(String, SdsID, double) -
Method in class au.gov.aao.drama.DramaPath
- Kick with name and argument, wait for completion with timeout.
- Kill(int, DramaStatus) -
Method in class au.gov.aao.drama.DramaTask
- Indicate that the SDS argument to an action should not be freeed or
deleted on return of the action.
- Kill(String, DramaStatus) -
Method in class au.gov.aao.drama.DramaTask
- Kill an action by name.
- Kill(int, SdsID, DramaStatus) -
Method in class au.gov.aao.drama.DramaTask
- Kill an action by index.
- Kill(String, SdsID, DramaStatus) -
Method in class au.gov.aao.drama.DramaTask
- Kill an action by name.
L
- List(Arg.StructList) -
Method in class au.gov.aao.drama.Arg
- List an SDS structure using a line output object.
- List() -
Method in class au.gov.aao.drama.SdsID
- List the SDS structure to stdiout.
- LoadArg() -
Method in class au.gov.aao.drama.DramaPath
- Return task load argument
- LocalTask -
Variable in class au.gov.aao.drama.DramaTask.TaskInfo
- Set true if the task is a local task (running on the current
machine).
- Log(int, String, String) -
Method in class au.gov.aao.drama.DramaTask
- Log a message using the DRAMA Logging system.
- LOG_ACT -
Static variable in class au.gov.aao.drama.DramaTask
- Possible value for SetDebug - Output details of action handling.
- LOG_ALL -
Static variable in class au.gov.aao.drama.DramaTask
- Possible value for SetDebug - Log everything.
- LOG_BASIC -
Static variable in class au.gov.aao.drama.DramaTask
- Possible value for SetDebug - Basic level debugging.
- LOG_BULK -
Static variable in class au.gov.aao.drama.DramaTask
- Possible value for SetDebug - Log details of bulk data operations.
- LOG_DETAILS -
Static variable in class au.gov.aao.drama.DramaTask
- Possible value for SetDebug - Log details of such things as message
lengths.
- LOG_IMPEVENTS -
Static variable in class au.gov.aao.drama.DramaTask
- Possible value for SetDebug - Turn IMP level event logging on.
- LOG_IMPINIT -
Static variable in class au.gov.aao.drama.DramaTask
- Possible value for SetDebug - Output details of calls which initiaite
IMP operations.
- LOG_IMPSYS -
Static variable in class au.gov.aao.drama.DramaTask
- Possible value for SetDebug - Output details of IMP System messages
- LOG_INST -
Static variable in class au.gov.aao.drama.DramaTask
- Possible flag to DramaTask.Log.
- LOG_LIBS -
Static variable in class au.gov.aao.drama.DramaTask
- Possible value for SetDebug - Log details of some libraries (DCPP).
- LOG_MON -
Static variable in class au.gov.aao.drama.DramaTask
- Possible value for SetDebug - Output details of monitor system.
- LOG_OFF -
Static variable in class au.gov.aao.drama.DramaTask
- Possible value for SetDebug - Turn debugging off
- LOG_RXLPEXIT -
Static variable in class au.gov.aao.drama.DramaTask
- Possible value for SetDebug - Log a message indicating exit from
the main message receiving routine.
- LOG_STARTUP -
Static variable in class au.gov.aao.drama.DramaTask
- Possible flag to DramaTask.Log.
- LOG_USER1 -
Static variable in class au.gov.aao.drama.DramaTask
- Possible flag to DramaTask.Log.
- LOG_USER2 -
Static variable in class au.gov.aao.drama.DramaTask
- Possible flag to DramaTask.Log.
- LoggingOff() -
Static method in class au.gov.aao.drama.DramaPath
- Turn logging off for all tasks.
- LoggingOn() -
Static method in class au.gov.aao.drama.DramaPath
- Turn logging on for all tasks.
- LongValue(String) -
Method in class au.gov.aao.drama.Arg
- Return a long (up to 64 bit value) from a named Arg item.
- LosePath() -
Method in class au.gov.aao.drama.DramaPath
- Lose the path and rest the state.
M
- main(String[]) -
Static method in error au.gov.aao.drama.DramaError
-
- MAY_LOAD -
Static variable in class au.gov.aao.drama.DramaTask
- Possible flag to DramaTask constructor.
- Monitor(String, SdsID, DramaPath.ResponseHandler, boolean) -
Method in class au.gov.aao.drama.DramaPath
- Send a Monitor message.
- MonitorForget(String, SdsID, DramaPath.ResponseHandler, boolean) -
Method in class au.gov.aao.drama.DramaPath
- Send a Monitor message and forget.
- Msg(DramaPath, DramaTask) -
Method in class au.gov.aao.drama.DramaPath.ResponseHandler
- Invoked when a MsgOut message has been received.
- MsgOut(String) -
Method in class au.gov.aao.drama.DramaTask
- Use DRAMA to send a message to user interface.
N
- Name() -
Method in class au.gov.aao.drama.SdsID
- Return the name of an item
- NewThread() -
Method in class au.gov.aao.drama.DramaPath.RescheduleHandler
- Increment the thread count, indicating another thread of messages
is being controlled by this RecheduleHandler object.
- NO_FC_AC -
Static variable in class au.gov.aao.drama.DramaTask
- Possible flag to DramaTask constructor.
- NodeName() -
Method in class au.gov.aao.drama.DramaPath
- Returns the node this task is to be loaded on.
- NotHandled(DramaTask) -
Method in class au.gov.aao.drama.DramaPath.RescheduleHandler
- Invoked if we received a message which we could not dispatch
to a handler because there was no handler assocaited with the
transaction.
O
- Obey(String) -
Method in class au.gov.aao.drama.DramaPath
- Obey with name only, default reponse handler.
- Obey(String, DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaPath
- Obey with name and handler.
- Obey(String, SdsID) -
Method in class au.gov.aao.drama.DramaPath
- Obey with name and argument, default reponse handler.
- Obey(String, SdsID, DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaPath
- Obey with name, argument and handler.
- Obey(String, SdsID, DramaPath.ResponseHandler, SdsID) -
Method in class au.gov.aao.drama.DramaPath
- Obey with name, argument, handler and return of transaction id.
- Obey(DramaTask) -
Method in class au.gov.aao.drama.DramaPath.RescheduleHandler
- Implement DramaTask.Action's obey handler.
- Obey(DramaTask) -
Method in interface au.gov.aao.drama.DramaTask.Action
- Invoked when DRAMA task receives an Obey message for the action.
- Obey(DramaTask) -
Method in interface au.gov.aao.drama.DramaTask.KickableAction
- Invoked when DRAMA task receives an Obey message for the action.
- ObeyForget(String) -
Method in class au.gov.aao.drama.DramaPath
- Obey with name only, default reponse handler, Transaction orphanded.
- ObeyForget(String, DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaPath
- Obey with name and handler, transaction orphaned.
- ObeyForget(String, SdsID) -
Method in class au.gov.aao.drama.DramaPath
- Obey with name and argument, default reponse, transaction orphaned.
- ObeyForget(String, SdsID, DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaPath
- Obey with name, argument and handler, transaction orphaned.
- ObeyForget(String, SdsID, DramaPath.ResponseHandler, SdsID) -
Method in class au.gov.aao.drama.DramaPath
- Obey with name, argument, handler and return of transaction id, orphaned.
- ObeyW(String) -
Method in class au.gov.aao.drama.DramaPath
- Obey with name only, wait for completion.
- ObeyW(String, SdsID) -
Method in class au.gov.aao.drama.DramaPath
- Obey with name and argument, wait for completion.
- ObeyW(String, double) -
Method in class au.gov.aao.drama.DramaPath
- Obey with name, wait for completion with timeout.
- ObeyW(String, SdsID, double) -
Method in class au.gov.aao.drama.DramaPath
- Obey with name and argument, wait for completion with timeout.
- OK -
Static variable in class au.gov.aao.drama.DramaStatus
-
- OrphanHandler(DramaTask) -
Method in class au.gov.aao.drama.DramaPath.RescheduleHandler
- Invoked if we receive a message which we could not dispatch
to a handler due to it being orphanded (but not forgotten).
- Outlives() -
Method in class au.gov.aao.drama.SdsID
- Mark the SDS item as outliving the Java object.
- Output(String) -
Static method in class au.gov.aao.drama.DramaErs
- Report a message use the DRAMA Ers facility and flush all messages
reported at the current context.
- Output(String, DramaStatus) -
Static method in class au.gov.aao.drama.DramaErs
- Report a message use the DRAMA Ers facility and flush all messages
reported at the current context.
P
- Path() -
Method in class au.gov.aao.drama.DramaMonitor
- Return the DRAMA Path assocaited with a monitor
- Pop() -
Static method in class au.gov.aao.drama.DramaErs
- Pop the DRAMA Error reporting context.
- PrintLine(String) -
Method in interface au.gov.aao.drama.Arg.StructList
- Output a single line of output whilst listing an SDS structure.
- PrintLine(String) -
Method in interface au.gov.aao.drama.DramaTask.MsgHandler
- Invoked when DRAMA task receives a MsgOut message to be output to
the user.
- PrintLines(DramaTask.ErsMessage[]) -
Method in interface au.gov.aao.drama.DramaTask.ErsHandler
- Invoked when DRAMA task receives an ERS message to be output to
the user.
- PrintReason() -
Method in class au.gov.aao.drama.DramaTask
- Print using DRAMA MsgOut/Ers routines the reason for an entry.
- Push() -
Static method in class au.gov.aao.drama.DramaErs
- Push the DRAMA Error reporting context.
- Put(String, char) -
Method in class au.gov.aao.drama.Arg
- Put a char (8 bit) item into an Arg structure.
- Put(String, short) -
Method in class au.gov.aao.drama.Arg
- Put a short (16 bit) item into an Arg structure.
- Put(String, int) -
Method in class au.gov.aao.drama.Arg
- Put an int (32 bit) item into an Arg structure.
- Put(String, long) -
Method in class au.gov.aao.drama.Arg
- Put an long (64 bit) item into an Arg structure.
- Put(String, double) -
Method in class au.gov.aao.drama.Arg
- Put an double length floating point item into an Arg structure.
- Put(String, boolean) -
Method in class au.gov.aao.drama.Arg
- Put an boolean item into an Arg structure.
- Put(String, String) -
Method in class au.gov.aao.drama.Arg
- Put an string item into an Arg structure.
- Put(String, char) -
Static method in class au.gov.aao.drama.Sdp
- Put a char (8 bit) item into an Sdp parameter.
- Put(String, short) -
Static method in class au.gov.aao.drama.Sdp
- Put a short (16 bit) item into an Sdp parameter
- Put(String, int) -
Static method in class au.gov.aao.drama.Sdp
- Put an int (32 bit) item into an Sdp parameter.
- Put(String, long) -
Static method in class au.gov.aao.drama.Sdp
- Put an long (64 bit) item into an Sdp parameter.
- Put(String, double) -
Static method in class au.gov.aao.drama.Sdp
- Put an double length floating point item into an Sdp parameter.
- Put(String, boolean) -
Static method in class au.gov.aao.drama.Sdp
- Put an boolean item into an Sdp parameter.
- Put(String, String) -
Static method in class au.gov.aao.drama.Sdp
- Put an string item into an Sdp parameter.
- Put(String, boolean, SdsID) -
Static method in class au.gov.aao.drama.Sdp
- Replace the SDS structure representing the named parameter with
the supplied structure.
- Put(int, long[]) -
Method in class au.gov.aao.drama.SdsID
- Put long (64 bit) DATA to the SDS item.
- Put(int, int[]) -
Method in class au.gov.aao.drama.SdsID
- Put int (32 bit) DATA to the SDS item.
- Put(int, short[]) -
Method in class au.gov.aao.drama.SdsID
- Put short (16 bit) DATA to the SDS item.
- Put(int, byte[]) -
Method in class au.gov.aao.drama.SdsID
- Put byte (8 bit) DATA to the SDS item.
- Put(int, float[]) -
Method in class au.gov.aao.drama.SdsID
- Put float DATA to the SDS item.
- Put(int, double[]) -
Method in class au.gov.aao.drama.SdsID
- Put double DATA to the SDS item.
- PutHandlers(DramaTask.KickableAction) -
Method in class au.gov.aao.drama.DramaTask
- Change both the Obey and Kick handlers for the next reschedule.
- PutKickHandler(DramaTask.Action) -
Method in class au.gov.aao.drama.DramaTask
- Change the Kick handler for the next attempt to kick this action.
- PutKickHandler(DramaTask.KickableAction) -
Method in class au.gov.aao.drama.DramaTask
- Change the Kick handler for the next attempt to kick this action.
- PutObeyHandler(DramaTask.Action) -
Method in class au.gov.aao.drama.DramaTask
- Change the Obey handler for the next reschedule event of this action.
- PutRequestEnd() -
Method in class au.gov.aao.drama.DramaTask
- Request action completion.
- PutRequestEnd(SdsID, int) -
Method in class au.gov.aao.drama.DramaTask
- Request action completion and return an argument to the parent.
- PutRequestExit() -
Method in class au.gov.aao.drama.DramaTask
- Request action completion and task exit.
- PutRequestExit(SdsID, int) -
Method in class au.gov.aao.drama.DramaTask
- Request action completion and task exit, return argument.
- PutRequestSleep() -
Method in class au.gov.aao.drama.DramaTask
- Request action delay.
- PutRequestWait(double) -
Method in class au.gov.aao.drama.DramaTask
- Request action delay.
- PutRequestWaitMessage(double) -
Method in class au.gov.aao.drama.DramaTask
- Request action wait for message with timeout.
- PutRequestWaitMessage() -
Method in class au.gov.aao.drama.DramaTask
- Request action wait for message with no timeout.
- PutUfaceErsHandler(DramaTask.ErsHandler) -
Method in class au.gov.aao.drama.DramaTask
- Supply a handler for UFACE context Ers messages.
- PutUfaceMsgHandler(DramaTask.MsgHandler) -
Method in class au.gov.aao.drama.DramaTask
- Supply a handler for UFACE context MsgOut messages.
R
- RCSID -
Static variable in class au.gov.aao.drama.Arg
- The RCS (ACMM) ID.
- RCSID -
Static variable in error au.gov.aao.drama.DramaError
- The RCS (ACMM) ID.
- RCSID -
Static variable in class au.gov.aao.drama.DramaErs
- The RCS (ACMM) ID.
- RCSID -
Static variable in exception au.gov.aao.drama.DramaException
- The RCS (ACMM) ID.
- RCSID -
Static variable in class au.gov.aao.drama.DramaMonitor
- The RCS (ACMM) ID.
- RCSID -
Static variable in class au.gov.aao.drama.DramaPath
- The RCS (ACMM) ID.
- RCSID -
Static variable in class au.gov.aao.drama.DramaSem
- The RCS (ACMM) ID.
- RCSID -
Static variable in class au.gov.aao.drama.DramaStatus
- The RCS (ACMM) ID.
- RCSID -
Static variable in class au.gov.aao.drama.DramaTask
- The RCS (ACMM) ID.
- RCSID -
Static variable in class au.gov.aao.drama.Sdp
- The RCS (ACMM) ID.
- RCSID -
Static variable in class au.gov.aao.drama.SdsID
- The RCS (ACMM) ID.
- REA_ASTINT -
Static variable in class au.gov.aao.drama.DramaTask
- Deprecated. Replaced by REA_SIGNAL.
- REA_BULK_DONE -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason - Indicates notification of
bulk data transfer complete.
- REA_BULK_TRANSFERRED -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason - Indicates notification of
bulk data transfer progress.
- REA_COMPLETE -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason - Indicates a Subsidary Action/
message has completed.
- REA_DIED -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason - Indicates a Subsidary Task
died whilst an action was outstanding.
- REA_ERROR -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason - Indicates an Ers message has
been recevied from a subsidary task.
- REA_EXIT -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason - Indicates an "Loaded Task has
Exited" message has been received.
- REA_KICK -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason - Indicates Kick entry.
- REA_LOAD -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason - Indicates a Load Success
message entry.
- REA_LOADFAILED -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason - Indicates Load Failure
message entry.
- REA_MESREJECTED -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason - Indicates Message Rejected
message entry.
- REA_MESSAGE -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason.
- REA_NOTIFY -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason - Indicates notification of
buffer empty has been received.
- REA_OBEY -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason - Indicates Obey entry.
- REA_PATHFAILED -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason - Indicates a Get Path failure
message has been received.
- REA_PATHFOUND -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason - Indicates a Path Found message
has been received.
- REA_RESCHED -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason - Indicates Reschedule Event
(timeout) entry.
- REA_SIGNAL -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason - Indicates entry for reception
of a Signal message (Signal functions).
- REA_TRIGGER -
Static variable in class au.gov.aao.drama.DramaTask
- Possible return value from GetReason - Indicates entry for reception
of a Trigger message from a subsidary task.
- ReadFacility(String) -
Static method in class au.gov.aao.drama.DramaTask
- Read a DRAMA Facility file into the task.
- ReadFacilityEnv(String, String) -
Static method in class au.gov.aao.drama.DramaTask
- Read a DRAMA Facility file into the task but don't complain if not found.
- RealValue(String) -
Method in class au.gov.aao.drama.Arg
- Return an real from a named Arg item.
- RealValue(String) -
Static method in class au.gov.aao.drama.Sdp
- Return an real from a named Sdp parameter.
- Release() -
Static method in class au.gov.aao.drama.DramaSem
- Release the DRAMA Semaphore.
- RemoveKickHandler() -
Method in class au.gov.aao.drama.DramaTask
- Clear the Kick handler.
- Rename(String) -
Method in class au.gov.aao.drama.SdsID
- Rename an SDS item.
- Report(String) -
Static method in class au.gov.aao.drama.DramaErs
- Report a message use the DRAMA Ers facility.
- Report(String, DramaStatus) -
Static method in class au.gov.aao.drama.DramaErs
- Report a message use the DRAMA Ers facility
- Report(String) -
Static method in exception au.gov.aao.drama.DramaException
- Report a string using ERS.
- Report(Throwable) -
Static method in exception au.gov.aao.drama.DramaException
- Report a Java Throwable using ERS.
- RequestNotify(DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaPath
- Request a notification when all outstanding messages have been
sent.
- Resize(int[]) -
Method in class au.gov.aao.drama.SdsID
- Resize an SDS array.
- rethrow() -
Method in error au.gov.aao.drama.DramaError
- Re-throw the underlying exception.
- RingBell() -
Method in class au.gov.aao.drama.DramaTask.ErsMessage
- Indicate if the BELL flag of the message has been set.
- RunDrama() -
Method in class au.gov.aao.drama.DramaTask
- Run the DRAMA task - enter the DRAMA message received loop.
S
- Sdp - Class in au.gov.aao.drama
- This class implements an interface to the
DRAMA C language SDP library, used to create DRAMA parameters.
- Sdp.Sds - Class in au.gov.aao.drama
- This class is used to access the value Sdp parameter
using SdsID and Arg class methods.
- Sdp.Sds(String) -
Constructor for class au.gov.aao.drama.Sdp.Sds
- Create a new Arg item accessing a DRAMA Sdp parameter.
- SDS_BYTE -
Static variable in class au.gov.aao.drama.SdsID
- SDS Type code value - Indicates a Byte (8 bit) type.
- SDS_CHAR -
Static variable in class au.gov.aao.drama.SdsID
- SDS Type code value - Indicates a Character type.
- SDS_DOUBLE -
Static variable in class au.gov.aao.drama.SdsID
- SDS Type code value - Indicates a double length floating point type.
- SDS_FLOAT -
Static variable in class au.gov.aao.drama.SdsID
- SDS Type code value - Indicates a floating point type.
- SDS_I64 -
Static variable in class au.gov.aao.drama.SdsID
- SDS Type code value - Indicates a Long (64 bit) Integer type.
- SDS_INT -
Static variable in class au.gov.aao.drama.SdsID
- SDS Type code value - Indicates an Integer (32 bit) type.
- SDS_SHORT -
Static variable in class au.gov.aao.drama.SdsID
- SDS Type code value - Indicates a Short (16 bit) type.
- SDS_STRUCT -
Static variable in class au.gov.aao.drama.SdsID
- SDS Type code value - Indicates an Sds Structure type.
- SDS_UBYTE -
Static variable in class au.gov.aao.drama.SdsID
- SDS Type code value - Indicates an Unsigned Byte (8 bit) type.
- SDS_UI64 -
Static variable in class au.gov.aao.drama.SdsID
- SDS Type code value - Indicates a Unsigned Long (64 bit) Integer type.
- SDS_UINT -
Static variable in class au.gov.aao.drama.SdsID
- SDS Type code value - Indicates an Unsigned Integer (32 bit) type.
- SDS_USHORT -
Static variable in class au.gov.aao.drama.SdsID
- SDS Type code value - Indicates an Unsigned Short (16 bit) type.
- SdsID - Class in au.gov.aao.drama
- This class implements an interface to the AAO's
DRAMA SDS Library Java.
- SdsID() -
Constructor for class au.gov.aao.drama.SdsID
- Create a SdsID containing a NULL Sds id.
- SdsID(int) -
Constructor for class au.gov.aao.drama.SdsID
- Create a SdsID using a C ID type.
- SdsID(int, boolean) -
Constructor for class au.gov.aao.drama.SdsID
- Create a SdsID using a C ID type, with free flag specified.
- SdsID(int, boolean, boolean) -
Constructor for class au.gov.aao.drama.SdsID
- Create a SdsID using a C ID type, with free and delete flags.
- SdsID(int, boolean, boolean, boolean) -
Constructor for class au.gov.aao.drama.SdsID
- Create a SdsID using a C ID type, with all flags specifyable.
- SdsID(String) -
Constructor for class au.gov.aao.drama.SdsID
- Create an SdsID, with the structure read from a file
- SdsID(SdsID, String, int) -
Constructor for class au.gov.aao.drama.SdsID
- Create a new child SDS item
- SdsID(String, int) -
Constructor for class au.gov.aao.drama.SdsID
- Create a new top-level SDS item
- SdsID(SdsID, String, int, int[]) -
Constructor for class au.gov.aao.drama.SdsID
- Create a new array child SDS item
- SdsID(String, int, int[]) -
Constructor for class au.gov.aao.drama.SdsID
- Create a new array top-level SDS item
- SdsID(SdsID, int[]) -
Constructor for class au.gov.aao.drama.SdsID
- Create an access to a cell of an existing SDS structure array.
- SdsID(SdsID) -
Constructor for class au.gov.aao.drama.SdsID
- Create a copy of an existing SDS item.
- SdsID(SdsID, String) -
Constructor for class au.gov.aao.drama.SdsID
- Create an access to an item in an SDS structure
- SdsID(SdsID, int) -
Constructor for class au.gov.aao.drama.SdsID
- Create an access to a existing SDS structure by index
- Set(String, SdsID) -
Method in class au.gov.aao.drama.DramaPath
- Set with default response handler.
- Set(String, SdsID, DramaPath.ResponseHandler) -
Method in class au.gov.aao.drama.DramaPath
- Set with response handler.
- SetAbsPriority(int) -
Method in class au.gov.aao.drama.DramaPath
- Set the load time absolute priority - only if not loaded.
- SetBuffers(DramaPath.Buffers) -
Method in class au.gov.aao.drama.DramaPath
- Change the buffer allocation, only if GetPath not performed.
- SetDebug(int) -
Method in class au.gov.aao.drama.DramaTask
- Set DRAMA internal debugging level.
- SetDebugging(boolean) -
Static method in class au.gov.aao.drama.SdsID
- Enable/Disable debugging (to stdout) of various SDS operations.
- SetDelete() -
Method in class au.gov.aao.drama.SdsID
- Set DELETE flag.
- SetDetails(int, String) -
Method in class au.gov.aao.drama.DramaTask
- Set the task details.
- SetDisconnect(DramaPath.DisconnectHandler) -
Method in class au.gov.aao.drama.DramaPath
- Set a handler to be invoked if the task this DramaPath communicates
with disconnects.
- SetFile(String) -
Method in class au.gov.aao.drama.DramaPath
- Change the load file - only effective if the task is not already loaded.
- SetFree() -
Method in class au.gov.aao.drama.SdsID
- Set FREE flag.
- SetLoadArg(String) -
Method in class au.gov.aao.drama.DramaPath
- Set the load time argument - only if not already loaded.
- SetNames() -
Method in class au.gov.aao.drama.DramaPath
- Set Names load time flag.
- SetNode(String) -
Method in class au.gov.aao.drama.DramaPath
- Change the task node - only if task not already found.
- SetProcess(String) -
Method in class au.gov.aao.drama.DramaPath
- Set the load time process name - only if not already loaded.
- SetProg() -
Method in class au.gov.aao.drama.DramaPath
- Set PROG load time flag.
- SetReadFree() -
Method in class au.gov.aao.drama.SdsID
- Set READ-FREE flag.
- SetRelPriority(int) -
Method in class au.gov.aao.drama.DramaPath
- Set the load time relative priority - only if not loaded.
- SetStackSize(int) -
Method in class au.gov.aao.drama.DramaPath
- Set the load time stack size.
- SetSymbols() -
Method in class au.gov.aao.drama.DramaPath
- Set Symbols load time flag.
- SetTaskName(String) -
Method in class au.gov.aao.drama.DramaPath
- Change the task name - only if not already loaded.
- SetTimeout(double) -
Method in class au.gov.aao.drama.DramaPath.RescheduleHandler
- Explicty set or reset the timeout assoicated with the reschedule
handler.
- SetTimeout(long) -
Static method in class au.gov.aao.drama.DramaSem
- Set the DRAMA Semaphore timeout.
- SetW(String, SdsID) -
Method in class au.gov.aao.drama.DramaPath
- Set, wait for completion.
- SetW(String, SdsID, double) -
Method in class au.gov.aao.drama.DramaPath
- Set, wait for completion with timeout.
- ShallowCopyNoOutlive(SdsID) -
Method in class au.gov.aao.drama.SdsID
- Make this id refer to the same id as another object but don't outlive it.
- ShallowCopyOutlive(SdsID) -
Method in class au.gov.aao.drama.SdsID
- Make this id refer to the same id as another object and outlive it.
- Signal(DramaTask) -
Method in class au.gov.aao.drama.DramaPath.RescheduleHandler
- Invoked on a Signal (DramaTask.EntReason == REA_SIGNAL).
- Signal(int) -
Method in class au.gov.aao.drama.DramaTask
- Signal an action by index.
- Signal(String) -
Method in class au.gov.aao.drama.DramaTask
- Signal an action by name.
- Signal(int, SdsID) -
Method in class au.gov.aao.drama.DramaTask
- Signal an action by index.
- Signal(String, SdsID) -
Method in class au.gov.aao.drama.DramaTask
- Signal an action by name.
- Started(DramaMonitor, DramaTask) -
Method in class au.gov.aao.drama.DramaMonitor.MonResponse
- Handle the monitor started message.
- Status() -
Method in class au.gov.aao.drama.DramaTask.ErsMessage
- Return the DRAMA status of the ERS message.
- StringValue(String) -
Method in class au.gov.aao.drama.Arg
- Return an string from a named Arg item.
- StringValue(String) -
Static method in class au.gov.aao.drama.Sdp
- Return an string from a named Sdp parameter.
- StuffUp() -
Method in class au.gov.aao.drama.SdsID
- Debugging test routine.
- Success(DramaPath, DramaTask) -
Method in class au.gov.aao.drama.DramaMonitor
- Override of DramaPath.ResponseHandler.Success() routine - used
internally to implement functionally.
- Success(DramaPath, DramaTask) -
Method in class au.gov.aao.drama.DramaPath.ResponseHandler
- Invoked when a message has completed sucessfully.
- SuccessCompletion(DramaMonitor, DramaTask) -
Method in class au.gov.aao.drama.DramaMonitor.MonResponse
- Handle the sucessfull completion of a monitor transaction.
- SystemError(DramaTask, DramaException) -
Method in class au.gov.aao.drama.DramaPath.RescheduleHandler
- Invoked if there is an overall error whilst handling reschedule
messages (an exception has been thrown).
T
- Take() -
Static method in class au.gov.aao.drama.DramaSem
- Take the DRAMA Semaphore or wait until we can get it.
- TakeOrphans() -
Method in class au.gov.aao.drama.DramaTask
- Take over orphan transactions.
- Task() -
Method in class au.gov.aao.drama.DramaPath
- Return the DramaTask object associated with this task
- TaskLoggingOff() -
Method in class au.gov.aao.drama.DramaPath
- Turn logging off for the object.
- TaskLoggingOn() -
Method in class au.gov.aao.drama.DramaPath
- Turn logging on for the object.
- TaskName() -
Method in class au.gov.aao.drama.DramaPath
- Return the name of the subject task.
- TaskName -
Variable in class au.gov.aao.drama.DramaTask.TaskInfo
- Set to the Name of task.
- Tasks() -
Method in class au.gov.aao.drama.DramaTask
- Returns an array of details on all the locally known running
DRAMA tasks.
- ThreadError(DramaTask, DramaException) -
Method in class au.gov.aao.drama.DramaPath.RescheduleHandler
- Invoked if an error occurs dispatching a thread.
- Timeout(DramaTask) -
Method in class au.gov.aao.drama.DramaPath.RescheduleHandler
- Invoked on a timeout whilst waiting for messages.
- TimerCanel(long) -
Method in class au.gov.aao.drama.DramaTask
- Cancel a timer setup with TimerInit.
- TimerInit(DramaTask.Action, double) -
Method in class au.gov.aao.drama.DramaTask
- Invoke a handler after a timeout, using DRAMA's timeout code.
- toInt() -
Method in class au.gov.aao.drama.DramaStatus
- Convert a status code to an integer value
- toString() -
Method in error au.gov.aao.drama.DramaError
- Returns a string representation of a DRAMA Exception.
- toString() -
Method in exception au.gov.aao.drama.DramaException
- Returns a string representation of a DRAMA Exception.
- toString() -
Method in class au.gov.aao.drama.DramaPath
- Returns the name and state information on the DRAMA Path.
- toString() -
Method in class au.gov.aao.drama.DramaStatus
- Convert a status code to a string.
- toString() -
Method in class au.gov.aao.drama.DramaTask.ErsMessage
- Return the text of the ERS message.
- toString() -
Method in class au.gov.aao.drama.DramaTask
- Returns the name of the DRAMA task.
- toString() -
Method in class au.gov.aao.drama.Sdp.Sds
- Standard conversion to string.
- toString() -
Method in class au.gov.aao.drama.SdsID
- Convert an Sds structure to a string using the ArgToString C function.
- Translated -
Variable in class au.gov.aao.drama.DramaTask.TaskInfo
- Set true if the task not an IMP/DRAMA task, but is instead a
translation to IMP/DRAMA of another type of task.
- Translator -
Variable in class au.gov.aao.drama.DramaTask.TaskInfo
- Set true if the task is an IMP translator task, which translates
messages for other tasks.
- Trigger(DramaPath, DramaTask) -
Method in class au.gov.aao.drama.DramaMonitor
- Override of DramaPath.ResponseHandler.Trigger() routine - used
internally to implement functionally.
- Trigger(DramaPath, DramaTask) -
Method in class au.gov.aao.drama.DramaPath.ResponseHandler
- Invoked when a trigger message has been received.
- Trigger(SdsID) -
Method in class au.gov.aao.drama.DramaTask
- Trigger parent action.
- Type -
Variable in class au.gov.aao.drama.DramaTask.TaskInfo
- Set to the Type of the task, as set with DitsSetDetails(3) or
the DramaTask.SetDetails() java method.
U
- ufaceCheck -
Static variable in class au.gov.aao.drama.DramaPath
- Deprecated. Fix the code, don't set this flag.
- UfaceCtxEnable(DramaTask.Action) -
Method in class au.gov.aao.drama.DramaTask
- Enable DRAMA's UFACE context.
- UfaceRespond() -
Method in class au.gov.aao.drama.DramaTask
- Invoke the DRAMA standard response to a UFACE message entry.
- UNIQUE -
Static variable in class au.gov.aao.drama.DramaTask
- Possible flag to DramaTask constructor.
- Update() -
Method in class au.gov.aao.drama.Sdp.Sds
- Indicate that the parameter we are accessing has been updated.
W
- Write(String) -
Method in class au.gov.aao.drama.SdsID
- Write the SDS structure to a specified file.
A B C D E F G H I K L M N O P R S T U W
Click here for the DRAMA home page and here for the AAO home page.
For more information, contact tjf@aaoepp.aao.gov.au.