BACnet Class |
This class will trigger "RemoteBACnetDevices.RemoteBACnetDevicesChange" events.
public sealed class BACnet : IDisposable
The BACnet type exposes the following members.
| Name | Description | |
|---|---|---|
| BACnetDiscoveryEnabled | Flag to indicate if the BACnet Discovery feature is enabled. true: if BACnet Discovery is enabled; false: if BACnet Discovery is disabled | |
| Discovery | BACnetBACnetDiscovery class object. This property is used to start and stop BACnet Discovery process. | |
| Disposed | Property to indicate if the Device has been disposed. | |
| EndpointsLimit | Maximum number of endpoints that can be added to the BACnet stack. Host device/object or a remote device/object is called an endpoint. | |
| HostDevice | Host device object. | |
| IsLicensed | Property to return the availability status of the BACnet license. true: BACnet license available; false: No BACnet license available | |
| Parent | The parent Control System that this object was added to. | |
| Registered | Flag to tell whether the BACnet slot is registered or not. | |
| RegistrationFailureReason | Property to get the Registration Failure Reason, this will match the return value from the call to register. | |
| RemoteBACnetDevices | Remote devices object. Remote devices collection is part of this object. | |
| RemoteDevicesSubClass | Remote Devices Slot under the Main BACnet slot, under which all the BACnet device sub-slots are be present. | |
| UnRegistrationFailureReason | Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister. |
| Name | Description | |
|---|---|---|
| AddRemoteDevice(UInt32) | Adds the specified remote device to the remote devices collection and with user settable timeout option. This function also validates the object parameters passed. Success will be returned if the device is added successfully, otherwise an exception is thrown that tells what kind of error found. If response is not received from the BACnet stack for add request before the timeout occurs, then a remove request will be sent to the BACnet stack to remove the remote from the stack and also the remote device will be deleted from the local collection. For Priority parameter the default value Available16 will be used. | |
| AddRemoteDevice(UInt32, eBACnetPriorityType) | Adds the specified remote device to the remote devices collection and with user settable timeout option. This function also validates the object parameters passed. Success will be returned if the device is added successfully, otherwise an exception is thrown that tells what kind of error found. If response is not received from the BACnet stack for add request before the timeout occurs, then a remove request will be sent to the BACnet stack to remove the remote from the stack and also the remote device will be deleted from the local collection. | |
| AddRemoteDevice(UInt32, Int32) | Adds the specified remote device to the remote devices collection and with user settable timeout option. This function also validates the object parameters passed. Success will be returned if the device is added successfully, otherwise an exception is thrown that tells what kind of error found. For Priority parameter the default value Available16 will be used. | |
| AddRemoteDevice(UInt32, eBACnetPriorityType, Int32) | Adds the specified remote device to the remote devices collection and with user settable timeout option. This function also validates the object parameters passed. Success will be returned if the device is added successfully, otherwise an exception is thrown that tells what kind of error found. | |
| Dispose | Clean up of resources. To unregister the BACnet call UnRegister, do not call this method. This method will dispose the BACnet slot itself. This method can be called from the program stopping event handler. To register BACnet again after calling this method, program need to be restarted. | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetNumberOfEndpoints | Method to get the number of endpoints added to the BACnet stack. Host device/object or a remote device/object is called an endpoint. | |
| GetNumberOfRemoteDevices | Method to get the number of remote devices added to the BACnet. | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| Register(UInt32, String) | Register this BACnet slot with the system. Default port number 47808 will be used for the host device. BACnet stack will be intimated about all the objects or devices that were already added to the local device/object collections so that those objects/devices will be added to the BACnet stack also. | |
| Register(UInt32, String, UInt32) | Register this BACnet slot with the system. BACnet stack will be intimated about all the objects or devices that were already added to the local device/object collections so that those objects/devices will be added to the BACnet stack also. | |
| RemoveAllRemoteDevices | Removes all remote devices from the remote device collection. Success will be returned if all the devices are removed successfully, otherwise failure is returned and the corresponding error is logged. | |
| RemoveAllRemoteDevices(Int32) | Removes all remote devices from the remote device collection, with user settable timeout option. Success will be returned if all the devices are removed successfully, otherwise failure is returned and the corresponding error is logged. | |
| RemoveRemoteDevice(UInt32) | Removes the specified remote device from the remote device collection. Success will be returned if the device is removed successfully, otherwise an exception is thrown that tells what kind of error found. | |
| RemoveRemoteDevice(UInt32, Int32) | Removes the specified remote device from the remote device collection, with user settable timeout option. Success will be returned if the device is removed successfully, otherwise an exception is thrown that tells what kind of error found. | |
| ToString |
String representation of the BACnet.
(Overrides ObjectToString) | |
| UnRegister | Unregister this BACnet slot with the system. All the host/remote objects and remote devices will be removed from the corresponding local collections. But the host device will not be removed and will show up in the current endpoints list. |