Class BrowseElement
- java.lang.Object
-
- com.inductiveautomation.ignition.common.opc.BrowseElement
-
- All Implemented Interfaces:
java.io.Serializable
public class BrowseElement extends java.lang.Object implements java.io.Serializable
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BrowseElement.PropertyElement
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
browsePath
protected boolean
complete
protected java.lang.String
itemId
protected java.lang.String
itemName
protected int
itemType
static java.lang.Integer
PROP_DRIVER
static java.lang.Integer
PROP_PROVIDER
protected java.util.Map<java.lang.Integer,BrowseElement.PropertyElement>
properties
protected java.lang.String
server
-
Constructor Summary
Constructors Constructor Description BrowseElement()
BrowseElement(int itemType)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addProperty(int id, java.lang.String name, java.lang.String value)
ServerNodeId
asServerNodeId()
BrowseElement
createRequestElement(int type)
Creates a copy of this browse element, but with the given type and no propertiesboolean
equals(java.lang.Object obj)
void
fillInDetails(BrowseElement elm)
java.lang.String
getBrowsePath()
java.lang.String
getItemId()
java.lang.String
getItemName()
int
getItemType()
java.util.Collection<BrowseElement.PropertyElement>
getProperties()
Returns all defined properties.BrowseElement.PropertyElement
getProperty(int id)
java.lang.String
getServer()
int
hashCode()
boolean
isComplete()
void
setBrowsePath(java.lang.String browsePath)
void
setComplete(boolean value)
void
setItemId(java.lang.String itemId)
void
setItemName(java.lang.String itemName)
void
setItemType(int itemType)
void
setServer(java.lang.String server)
static BrowseElement
toBrowseElement(OPCBrowseElement opcElem)
static java.util.List<BrowseElement>
toBrowseElements(java.util.List<OPCBrowseElement> opcElements)
static ServerNodeId
toServerNodeId(BrowseElement elem)
java.lang.String
toString()
void
toXML(java.lang.StringBuilder out)
void
toXML(java.lang.StringBuilder out, int type, boolean includeProperties)
-
-
-
Field Detail
-
PROP_PROVIDER
public static final java.lang.Integer PROP_PROVIDER
-
PROP_DRIVER
public static final java.lang.Integer PROP_DRIVER
-
server
protected java.lang.String server
-
browsePath
protected java.lang.String browsePath
-
itemName
protected java.lang.String itemName
-
itemId
protected java.lang.String itemId
-
itemType
protected int itemType
-
properties
protected java.util.Map<java.lang.Integer,BrowseElement.PropertyElement> properties
-
complete
protected boolean complete
-
-
Method Detail
-
asServerNodeId
public ServerNodeId asServerNodeId()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getServer
public java.lang.String getServer()
-
getBrowsePath
public java.lang.String getBrowsePath()
-
getItemName
public java.lang.String getItemName()
-
getItemId
public java.lang.String getItemId()
-
getItemType
public int getItemType()
-
getProperty
public BrowseElement.PropertyElement getProperty(int id)
-
isComplete
public boolean isComplete()
-
setComplete
public void setComplete(boolean value)
-
fillInDetails
public void fillInDetails(BrowseElement elm)
-
getProperties
public java.util.Collection<BrowseElement.PropertyElement> getProperties()
Returns all defined properties. Will return an empty collection (not null) if there are no properties
-
setServer
public void setServer(java.lang.String server)
-
setBrowsePath
public void setBrowsePath(java.lang.String browsePath)
-
setItemName
public void setItemName(java.lang.String itemName)
-
setItemId
public void setItemId(java.lang.String itemId)
-
setItemType
public void setItemType(int itemType)
-
createRequestElement
public BrowseElement createRequestElement(int type)
Creates a copy of this browse element, but with the given type and no properties
-
toXML
public void toXML(java.lang.StringBuilder out)
-
toXML
public void toXML(java.lang.StringBuilder out, int type, boolean includeProperties)
-
addProperty
public void addProperty(int id, java.lang.String name, java.lang.String value)
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBrowseElements
public static java.util.List<BrowseElement> toBrowseElements(java.util.List<OPCBrowseElement> opcElements)
-
toBrowseElement
public static BrowseElement toBrowseElement(OPCBrowseElement opcElem)
-
toServerNodeId
public static ServerNodeId toServerNodeId(BrowseElement elem)
-
-