Documentation Comments
Use this form to comment on this topic. You can also provide any general observations about the Online Documentation, or request that additional information be added in a future release.
Reality V15.0 ()
Reality Interface Classes: Class RSCDescriptor (JReal) (rscdescriptor.html)
|
Reality Interface Classes | ||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||
java.lang.Object | +--com.northgateis.reality.rsc.RSCDescriptor
Builds a Vector containing the parameters of a subroutine, and provides methods to access the parameters either by reference or sequentially.
The methods of this class are normally only called by the RSC class
By default parameter are accessed by an index number (1 to n) where n is the number of parameters that the subroutine takes. Parameters referenced by index do not have to be accessed in order of index.
Optionally parameters can be accessed by name. In order to support this feature the parameter descriptors must have been down loaded from the RSC server by using the getDescriptors() method of the RSC class.
| Field Summary | |
int
|
reference
the reference number for this subroutine on the server |
| Constructor Summary | |
RSCDescriptor(java.lang.String name)Construct a new empty subroutine descriptor | |
RSCDescriptor(java.lang.String name,
int r,
int pc,
java.lang.String fmt)Construct a new subroutine descriptor | |
| Method Summary | |
RSCParam | get(int index)get a parameter descriptor by index |
RSCParam | get(java.lang.String name)get a parameter descriptor by name. |
java.lang.String | getName()return name of this subroutine |
boolean | hasMoreElements()test if there are more parameters available |
java.lang.Object | nextElement()get the next parameter descriptor in sequence. |
| Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
| Field Detail |
public int reference
| Constructor Detail |
public RSCDescriptor(java.lang.String name, int r, int pc, java.lang.String fmt)
public RSCDescriptor(java.lang.String name)
name - name of subroutine| Method Detail |
public java.lang.String getName()
public boolean hasMoreElements()
public java.lang.Object nextElement()
public RSCParam get(java.lang.String name) throws RSCException
name - name of parameterpublic RSCParam get(int index) throws RSCException
index - index of parameter
| Reality Interface Classes | ||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||