au.gov.aao.drama
Class Sdp.Sds

java.lang.Object
  au.gov.aao.drama.SdsID
      au.gov.aao.drama.Arg
          au.gov.aao.drama.Sdp.Sds

Enclosing class:

Sdp

public static class Sdp.Sds
extends Arg

This class is used to access the value Sdp parameter using SdsID and Arg class methods.

The constructor takes the name of the parameter which wish to access.

The only method of interest is the Update method which is used to indicate to the parameter system that the parameter value has been updated. Otherwise, you can use the methods of the SdsId and Arg classes to access and change the value of this parameter. This allows parameters with complex structure to be accessed and changed.

See Also:

SdsID, Arg, Sdp

Nested Class Summary

Nested classes/interfaces inherited from class au.gov.aao.drama.Arg

Arg.StructList

Field Summary

Fields inherited from class au.gov.aao.drama.Arg

RCSID

Fields inherited from class au.gov.aao.drama.SdsID

id, SDS_BYTE, SDS_CHAR, SDS_DOUBLE, SDS_FLOAT, SDS_I64, SDS_INT, SDS_SHORT, SDS_STRUCT, SDS_UBYTE, SDS_UI64, SDS_UINT, SDS_USHORT

Constructor Summary

Sdp.Sds(String Name)
Create a new Arg item accessing a DRAMA Sdp parameter.

Method Summary

String	toString() Standard conversion to string.
void	Update() Indicate that the parameter we are accessing has been updated.

Methods inherited from class au.gov.aao.drama.Arg

BoolValue, IntValue, List, LongValue, Put, Put, Put, Put, Put, Put, Put, RealValue, StringValue

Methods inherited from class au.gov.aao.drama.SdsID

ClearDelete, ClearFree, ClearFreeIDWatch, ClearReadFree, Code, Debug, Debug, Debug, DeepCopy, Delete, Dims, EnableFreeIDWatch, Extract, FillArray, finalize, Get, Get, Get, Get, Get, Get, Get, Get, GetContructorLocation, ID, Insert, Insert, List, Name, Outlives, Put, Put, Put, Put, Put, Put, Rename, Resize, SetDebugging, SetDelete, SetFree, SetReadFree, ShallowCopyNoOutlive, ShallowCopyOutlive, StuffUp, Write

Methods inherited from class java.lang.Object

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

Constructor Detail

Sdp.Sds

public Sdp.Sds(String Name)
        throws DramaException

Create a new Arg item accessing a DRAMA Sdp parameter.

Parameters:

Name - The name of the Parameter to access.

Throws:

DramaException - Thrown on errors in the DRAMA code.

Method Detail

Update

public void Update()
            throws DramaException

Indicate that the parameter we are accessing has been updated.

This function should be used to triger DRAMA parameter monitors of this parameter - such that tasks monitoring the parameter are notified of the change in its value.

Throws:

DramaException - Thrown on errors in the DRAMA code.

toString

public String toString()

Standard conversion to string.

Overrides:

toString in class SdsID

Returns:

A description of this object.