Package com.uc4.api.objects
Class OCVPanel
java.lang.Object
com.uc4.api.objects.OCVPanel
- All Implemented Interfaces:
Iterable<OCVPanel.CITValue>
This class provides access to the values of Connection Objects and Rapid Automation Jobs.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
This class represents a single row in this panel. -
Constructor Summary
ConstructorsConstructorDescriptionOCVPanel
(com.uc4.util.XMLDocument doc, Element citPanel, ConnectionAttributes session) Internal use only. -
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(OCVPanel.CITValue value) Adds a new value to this panel.boolean
changeValue
(String xmlName, String value) Modifies the value of an xmlName.void
clear()
Removes all values from this connection object.copy()
Creates a deep copy of this objectGets a value from by its unique name.int
Gets a value by its name and converts the result to an integer.iterator()
Returns an iterator which can be used ot read all values.boolean
Removes a value from this OCV Panel instance.void
Modifies or adds a new value to this OCV panel.int
size()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
OCVPanel
Internal use only.- Parameters:
doc
- XML documentcitPanel
- Element of RA valuessession
- Session info
-
-
Method Details
-
get
Gets a value from by its unique name.- Parameters:
name
- xmlName- Returns:
- value or null if not found
-
getInt
Gets a value by its name and converts the result to an integer.- Parameters:
name
- xmlName of the parameter- Returns:
- int (0 if not found, -1 in case of a NumberFormatException)
-
remove
Removes a value from this OCV Panel instance.- Parameters:
name
- XML name- Returns:
- true if the value has been removed, false otherwise
-
iterator
Returns an iterator which can be used ot read all values.- Specified by:
iterator
in interfaceIterable<OCVPanel.CITValue>
- Returns:
- Iterator over CITValue
-
clear
public void clear()Removes all values from this connection object. -
add
Adds a new value to this panel.- Parameters:
value
- CITValue
-
changeValue
Modifies the value of an xmlName.- Parameters:
xmlName
- Namevalue
- New value- Returns:
- true if successful, false otherwise
-
setValue
Modifies or adds a new value to this OCV panel.- Parameters:
xmlName
- Namevalue
- Valueenc
- Encryption?con
- Connection Object
-
size
public int size()- Returns:
- Number of entries
-
copy
Creates a deep copy of this object- Returns:
- A copy of this object
-