Building Controls Virtual Test Bed
bacnet.util.BACnetObjectType Class Reference

This class reads the XML configuration file and stores the data in the BACnetObjectType data type. More...

Collaboration diagram for bacnet.util.BACnetObjectType:

Public Member Functions

 BACnetObjectType (final String name, final String instance, final ArrayList< BACnetPropertyValue > mapPI, final HashMap mapOTname, final HashMap mapOTinst, final HashMap piOrder, final HashMap otOrder)
 Construct an instance of BACnet object. More...
 
 BACnetObjectType ()
 Empty constructor. More...
 
String getBOTName ()
 Get the bacnet object type name. More...
 
String getBOTInst ()
 Get the instance of the bacnet object type. More...
 
ArrayList< BACnetPropertyValuegetBOTPI ()
 Get the map of the property identifier. More...
 
HashMap getBACnetObjectTypeNameMap ()
 Get the map of the object type. More...
 
HashMap getBACnetObjectTypeInstanceMap ()
 Get the map of the object type. More...
 
HashMap getBACnetObjectTypePropertyIdentifierOrder ()
 Get the map of the property identifier index. More...
 
HashMap getBACnetObjectTypeOrder ()
 Get the map of the bacnet object type index. More...
 
ArrayList< BACnetObjectTypeparseObjectType (final String s) throws ParserConfigurationException, SAXException, IOException
 Read bacnet object types from the xml configuration. More...
 
ArrayList< String > readDeviceInst (final String s) throws FileNotFoundException, ParserConfigurationException, SAXException, IOException
 Read ArrayList String from xml configuration file. More...
 
BACnetObjectType readBacnetDeviceObjectType (final String dev_inst, final String s) throws FileNotFoundException, ParserConfigurationException, SAXException, IOException
 Read Bancet DeviceObjectType from xml configuration file. More...
 
BACnetObjectType readBacnetNonDeviceObjectType (final String dev_inst, final String obj_inst, final String obj_name, final String s) throws FileNotFoundException, ParserConfigurationException, SAXException, IOException
 Read NonDevice BACnetObjectType from xml configuration file. More...
 
String convertObjectName (String orStr)
 Convert object name to the same convention as in BacnetDeviceManager. More...
 

Protected Attributes

String bot_name
 The BACnetObjectType name. More...
 
String bot_instance
 The BACnetObjectType instance. More...
 
ArrayList< BACnetPropertyValuebot_mapPI
 ArrayList with elements of BACnetPropertyValue. More...
 
HashMap bot_mapOTname
 Hashmap containing the index and name of the objecty type pair. More...
 
HashMap bot_mapOTinst
 Hashmap containing the index and object instance number pair for BACnet Device Object and device instance number and object instance number pair for BACnet non-Device Object. More...
 
HashMap bot_piOrder
 Hashmap containing the name and index pair of property identifier. More...
 
HashMap bot_otOrder
 Hashmap containing the instance and index pair of object type. More...
 

Static Private Attributes

static final String LS = System.getProperty("line.separator")
 System-dependent line separator. More...
 

Detailed Description

This class reads the XML configuration file and stores the data in the BACnetObjectType data type.

Author
Zhengwei Li

Definition at line 98 of file BACnetObjectType.java.

Constructor & Destructor Documentation

bacnet.util.BACnetObjectType.BACnetObjectType ( final String  name,
final String  instance,
final ArrayList< BACnetPropertyValue mapPI,
final HashMap  mapOTname,
final HashMap  mapOTinst,
final HashMap  piOrder,
final HashMap  otOrder 
)
inline

Construct an instance of BACnet object.

Parameters
namename of the object type
instanceinstance number of the object type
mapPIArrayList containing the elements of BACnetPropertyValue(name and value pair)
mapOTnameHashmap containing the index and name of the objecty type pair
mapOTinstHashmap containing the index and object instance number pair for BACnet Device Object and device instance number and object instance number pair for BACnet nonDevice Object
piOrderHashmap containing the name and index pair of property identifier
otOrderHashmap containing the instance and index pair of object type

Definition at line 113 of file BACnetObjectType.java.

References bacnet.util.BACnetObjectType.bot_instance, bacnet.util.BACnetObjectType.bot_mapOTinst, bacnet.util.BACnetObjectType.bot_mapOTname, bacnet.util.BACnetObjectType.bot_mapPI, bacnet.util.BACnetObjectType.bot_name, bacnet.util.BACnetObjectType.bot_otOrder, and bacnet.util.BACnetObjectType.bot_piOrder.

bacnet.util.BACnetObjectType.BACnetObjectType ( )
inline

Member Function Documentation

String bacnet.util.BACnetObjectType.convertObjectName ( String  orStr)
inline

Convert object name to the same convention as in BacnetDeviceManager.

Parameters
orStrobject name in xml configuration file
Returns
object name to be used in BACnetDeviceManager

Definition at line 532 of file BACnetObjectType.java.

Referenced by bacnet.util.BACnetObjectType.readBacnetDeviceObjectType(), and bacnet.util.BACnetObjectType.readBacnetNonDeviceObjectType().

HashMap bacnet.util.BACnetObjectType.getBACnetObjectTypeInstanceMap ( )
inline

Get the map of the object type.

Returns
the map containing object type

Definition at line 176 of file BACnetObjectType.java.

References bacnet.util.BACnetObjectType.bot_mapOTinst.

HashMap bacnet.util.BACnetObjectType.getBACnetObjectTypeNameMap ( )
inline

Get the map of the object type.

Returns
the map containing object type

Definition at line 167 of file BACnetObjectType.java.

References bacnet.util.BACnetObjectType.bot_mapOTname.

HashMap bacnet.util.BACnetObjectType.getBACnetObjectTypeOrder ( )
inline

Get the map of the bacnet object type index.

Returns
the map containing object type name and index

Definition at line 192 of file BACnetObjectType.java.

References bacnet.util.BACnetObjectType.bot_otOrder.

HashMap bacnet.util.BACnetObjectType.getBACnetObjectTypePropertyIdentifierOrder ( )
inline

Get the map of the property identifier index.

Returns
the map contating property identifier name and index

Definition at line 184 of file BACnetObjectType.java.

References bacnet.util.BACnetObjectType.bot_piOrder.

String bacnet.util.BACnetObjectType.getBOTInst ( )
inline

Get the instance of the bacnet object type.

Returns
the instance of the bacnet object type

Definition at line 149 of file BACnetObjectType.java.

References bacnet.util.BACnetObjectType.bot_instance.

Referenced by bacnet.util.BACnetDeviceManager.readCompleteObjectPropertyList(), bacnet.util.BACnetDeviceManager.readDevicePropertyList(), and bacnet.util.BACnetDeviceManager.readObjectList().

String bacnet.util.BACnetObjectType.getBOTName ( )
inline
ArrayList<BACnetPropertyValue> bacnet.util.BACnetObjectType.getBOTPI ( )
inline

Get the map of the property identifier.

Returns
the map containing property identifier

Definition at line 158 of file BACnetObjectType.java.

References bacnet.util.BACnetObjectType.bot_mapPI.

ArrayList<BACnetObjectType> bacnet.util.BACnetObjectType.parseObjectType ( final String  s) throws ParserConfigurationException, SAXException, IOException
inline

Read bacnet object types from the xml configuration.

Parameters
sname of configuration file
Returns
ArrayList with elements of bacnet object type
Exceptions
FileNotFoundExceptionif configuration file couldn't be found
ParserConfigurationExceptionif configuration file couldn't be read properly
SAXExceptionif error occurs while configuration file is parsed
IOExceptionif I/O error occurs while parsing configuration file

Definition at line 206 of file BACnetObjectType.java.

References i, bacnet.util.BACnetObjectType.LS, bacnet.util.BACnetObjectType.readBacnetDeviceObjectType(), bacnet.util.BACnetObjectType.readBacnetNonDeviceObjectType(), and bacnet.util.BACnetObjectType.readDeviceInst().

BACnetObjectType bacnet.util.BACnetObjectType.readBacnetDeviceObjectType ( final String  dev_inst,
final String  s 
) throws FileNotFoundException, ParserConfigurationException, SAXException, IOException
inline

Read Bancet DeviceObjectType from xml configuration file.

Parameters
sxml configuration file path
dev_instdevice instance
Returns
Bacnet Device Object Type
Exceptions
FileNotFoundExceptionif configuration file can't be found
ParserConfigurationExceptionif configuration file couldn't be read properly
SAXExceptionif error occurs while configuration file is parsed
IOExceptionif I/O error occurs while parsing configuration file

Definition at line 308 of file BACnetObjectType.java.

References bacnet.util.BACnetObjectType.BACnetObjectType(), and bacnet.util.BACnetObjectType.convertObjectName().

Referenced by bacnet.util.BACnetObjectType.parseObjectType().

BACnetObjectType bacnet.util.BACnetObjectType.readBacnetNonDeviceObjectType ( final String  dev_inst,
final String  obj_inst,
final String  obj_name,
final String  s 
) throws FileNotFoundException, ParserConfigurationException, SAXException, IOException
inline

Read NonDevice BACnetObjectType from xml configuration file.

Parameters
dev_instdevice instance number
obj_instobject instance number
Returns
a non device BACnetObjectType
Exceptions
FileNotFoundExceptionif configuration file can't be found
ParserConfigurationExceptionif configuration file couldn't be read properly
SAXExceptionif error occurs while configuration file is parsed
IOExceptionif I/O error occurs while parsing configuration file

Definition at line 418 of file BACnetObjectType.java.

References bacnet.util.BACnetObjectType.BACnetObjectType(), and bacnet.util.BACnetObjectType.convertObjectName().

Referenced by bacnet.util.BACnetObjectType.parseObjectType().

ArrayList<String> bacnet.util.BACnetObjectType.readDeviceInst ( final String  s) throws FileNotFoundException, ParserConfigurationException, SAXException, IOException
inline

Read ArrayList String from xml configuration file.

Parameters
sxml configuation file path
Returns
ArrayList containing elements of Bacnet Device
Exceptions
FileNotFoundExceptionif configuration file can't be found
ParserConfigurationExceptionif configuration file couldn't be read properly
SAXExceptionif error occurs while configuration file is parsed
IOExceptionif I/O error occurs while parsing configuration file

Definition at line 257 of file BACnetObjectType.java.

Referenced by bacnet.util.BACnetObjectType.parseObjectType().

Member Data Documentation

String bacnet.util.BACnetObjectType.bot_instance
protected
HashMap bacnet.util.BACnetObjectType.bot_mapOTinst
protected

Hashmap containing the index and object instance number pair for BACnet Device Object and device instance number and object instance number pair for BACnet non-Device Object.

Definition at line 551 of file BACnetObjectType.java.

Referenced by bacnet.util.BACnetObjectType.BACnetObjectType(), and bacnet.util.BACnetObjectType.getBACnetObjectTypeInstanceMap().

HashMap bacnet.util.BACnetObjectType.bot_mapOTname
protected

Hashmap containing the index and name of the objecty type pair.

Definition at line 547 of file BACnetObjectType.java.

Referenced by bacnet.util.BACnetObjectType.BACnetObjectType(), and bacnet.util.BACnetObjectType.getBACnetObjectTypeNameMap().

ArrayList<BACnetPropertyValue> bacnet.util.BACnetObjectType.bot_mapPI
protected
String bacnet.util.BACnetObjectType.bot_name
protected
HashMap bacnet.util.BACnetObjectType.bot_otOrder
protected

Hashmap containing the instance and index pair of object type.

Definition at line 557 of file BACnetObjectType.java.

Referenced by bacnet.util.BACnetObjectType.BACnetObjectType(), and bacnet.util.BACnetObjectType.getBACnetObjectTypeOrder().

HashMap bacnet.util.BACnetObjectType.bot_piOrder
protected

Hashmap containing the name and index pair of property identifier.

Definition at line 554 of file BACnetObjectType.java.

Referenced by bacnet.util.BACnetObjectType.BACnetObjectType(), and bacnet.util.BACnetObjectType.getBACnetObjectTypePropertyIdentifierOrder().

final String bacnet.util.BACnetObjectType.LS = System.getProperty("line.separator")
staticprivate

System-dependent line separator.

Definition at line 560 of file BACnetObjectType.java.

Referenced by bacnet.util.BACnetObjectType.parseObjectType().


The documentation for this class was generated from the following file: