feat(ia): implement ignition.common.BrowseElement (#70)

Author: César Román

src/com/inductiveautomation/ignition/common/opc/__init__.py

@@ -1,15 +1,16 @@
 __all__ = [
     "BasicOPCBrowseElement",
     "BasicServerNodeId",
+    "BrowseElement",
     "BrowseElementType",
     "OPCBrowseElement",
     "ServerBrowseElement",
     "ServerNodeId",
 ]
 
-from typing import Any, List
+from typing import Any, Dict, List, Optional
 
-from java.lang import Class, Enum, Object, String
+from java.lang import Class, Enum, Object, String, StringBuilder
 
 
 class OPCBrowseElement(object):
@@ -96,6 +97,137 @@ def getServerName(self):
         return self.serverName
 
 
+class BrowseElement(Object):
+    PROP_PROVIDER = 500  # type: int
+    PROP_DRIVER = 501  # type: int
+    _server = None  # type: String
+    _browsePath = None  # type: String
+    _itemName = None  # type: String
+    _itemId = None  # type: String
+    _itemType = None  # type: Optional[int]
+    _properties = None  # type: Dict[int, BrowseElement.PropertyElement]
+    _complete = False  # type: bool
+
+    def __init__(self, itemType=None):
+        # type: (Optional[int]) -> None
+        self._itemType = itemType
+        self._properties = {0: BrowseElement.PropertyElement(0, "", "")}
+
+    def addProperty(self, id_, name, value):
+        # type: (int, String, String) -> None
+        pass
+
+    def asServerNodeId(self):
+        # type: () -> ServerNodeId
+        pass
+
+    def createRequestElement(self, type_):
+        # type: (int) -> BrowseElement
+        pass
+
+    def fillInDetails(self, elm):
+        # type: (BrowseElement) -> None
+        pass
+
+    def getBrowsePath(self):
+        # type: () -> String
+        return self._browsePath
+
+    def getItemId(self):
+        # type: () -> String
+        return self._itemId
+
+    def getItemName(self):
+        # type: () -> String
+        return self._itemName
+
+    def getItemType(self):
+        # type: () -> Optional[int]
+        return self._itemType
+
+    def getProperties(self):
+        # type: () -> List[BrowseElement.PropertyElement]
+        return self._properties.values()
+
+    def getProperty(self, id_):
+        # type: (int) -> BrowseElement.PropertyElement
+        return self._properties[id_]
+
+    def getServer(self):
+        # type: () -> String
+        return self._server
+
+    def isComplete(self):
+        # type: () -> bool
+        return self._complete
+
+    def setBrowsePath(self, browsePath):
+        # type: (String) -> None
+        self._browsePath = browsePath
+
+    def setComplete(self, value):
+        # type: (bool) -> None
+        self._complete = value
+
+    def setItemId(self, itemId):
+        # type: (String) -> None
+        self._itemId = itemId
+
+    def setItemName(self, itemName):
+        # type: (String) -> None
+        self._itemName = itemName
+
+    def setItemType(self, itemType):
+        # type: (int) -> None
+        self._itemType = itemType
+
+    def setServer(self, server):
+        # type: (String) -> None
+        self._server = server
+
+    @staticmethod
+    def toBrowseElement(opcElem):
+        # type: (OPCBrowseElement) -> BrowseElement
+        pass
+
+    @staticmethod
+    def toBrowseElements(opcElements):
+        # type: (List[OPCBrowseElement]) -> List[BrowseElement]
+        pass
+
+    @staticmethod
+    def toServerNodeId(elem):
+        # type: (BrowseElement) -> ServerNodeId
+        pass
+
+    def toXML(self, out, type_=None, includeProperties=None):
+        # type: (StringBuilder, Optional[int], Optional[bool]) -> None
+        pass
+
+    class PropertyElement(Object):
+        id = None  # type: int
+        name = None  # type: String
+        value = None  # type: String
+
+        def __init__(self, id_, name, value):
+            # type: (int, String, String) -> None
+            self.id = id_
+            self.name = name
+            self.value = value
+
+        def getId(self):
+            # type: () -> int
+            return self.id
+
+        def getName(self):
+            # type: () -> String
+            return self.name
+
+        def getValue(self):
+            # type: () -> String
+            return self.value
+
+
 class BrowseElementType(Enum):
     DATAVARIABLE = None  # type: BrowseElementType
     DEVICE = None  # type: BrowseElementType