Interface BrowsableNode
-
- All Superinterfaces:
Node
- All Known Subinterfaces:
AlarmEvaluator
public interface BrowsableNode extends Node
- Since:
- 8.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default Results<NodeDescription>
browse(BrowseFilter filter)
default Results<NodeDescription>
browse(BrowseFilter filter, SecurityContext securityContext)
default QualityCode
browse(java.util.List<NodeDescription> results, BrowseFilter filter, int startingOffset, java.util.concurrent.atomic.AtomicInteger currentOffset)
QualityCode
browse(java.util.List<NodeDescription> results, BrowseFilter filter, int startingOffset, java.util.concurrent.atomic.AtomicInteger currentOffset, SecurityContext securityContext)
Browses the sub nodes of this tag.NodeDescription
getBrowseInfo()
The browse info of a tag node is a lighter weight version of the tag that is appropriate for browsing and discovery, but not actually configuration.Node
getChildNode(java.lang.String name)
Node
getPropertyNode(Property<?> property)
boolean
hasChildren()
-
Methods inherited from interface com.inductiveautomation.ignition.gateway.tags.evaluation.nodes.Node
read, setLeased, setSubscription, write
-
-
-
-
Method Detail
-
hasChildren
boolean hasChildren()
-
getChildNode
Node getChildNode(java.lang.String name)
-
getBrowseInfo
NodeDescription getBrowseInfo()
The browse info of a tag node is a lighter weight version of the tag that is appropriate for browsing and discovery, but not actually configuration.
-
browse
default Results<NodeDescription> browse(BrowseFilter filter)
-
browse
default Results<NodeDescription> browse(BrowseFilter filter, SecurityContext securityContext)
-
browse
default QualityCode browse(java.util.List<NodeDescription> results, BrowseFilter filter, int startingOffset, java.util.concurrent.atomic.AtomicInteger currentOffset)
-
browse
QualityCode browse(java.util.List<NodeDescription> results, BrowseFilter filter, int startingOffset, java.util.concurrent.atomic.AtomicInteger currentOffset, SecurityContext securityContext)
Browses the sub nodes of this tag. Results should be added to the "results" list. If the operation cannot be completed for some reason, a non-good QualityCode can be returned to indicate why.It is up to each implementation how fully they support the browse filter.
- Parameters:
results
- List upon which to add results.filter
- the non-null filter. Will be BrowseFilter.None if no filter is specified.startingOffset
- the starting offset of the browse. This has been extracted from the filter continuation point, or the filter offset.currentOffset
- an atomic integer that should be set to the desired continuation point if the browse is stopped early due to Filter.getMaxResults. It starts as 0 here, so you can increment it until it gets past startingOffset as an easy way to skip the initial offset.securityContext
- theSecurityContext
in which this browse is made
-
-