Click or drag to resize

HostedBACnetDevice Class

Hosted BACnet Device class. This class implements methods to add/remove all types of host objects to the BACnet stack. This class defines and maintains the host local objects collection to keep the added object details. Defines the properties to get the number of objects that were added of each object type for the host.

This class will trigger BACnetObjectChange event.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProBACnetDevice
    Crestron.SimplSharpProHostedBACnetDevice

Namespace: Crestron.SimplSharpPro
Assembly: SimplSharpPro (in SimplSharpPro.dll) Version: 2.21.121
Syntax
C#
public sealed class HostedBACnetDevice : BACnetDevice, 
	IDisposable

The HostedBACnetDevice type exposes the following members.

Properties
 NameDescription
Public propertyBACnetAnalogInputObjects Collection of BACnet Analog Input objects of the device.
Public propertyBACnetAnalogValueObjects Collection of BACnet Analog Value objects of the device.
Public propertyBACnetBinaryInputObjects Collection of BACnet Binary Input objects of the device.
Public propertyBACnetBinaryValueObjects Collection of BACnet Binary Value objects of the device.
Public propertyBACnetMultiStateInputObjects Collection of BACnet MultiState Input objects of the device.
Public propertyBACnetMultiStateValueObjects Collection of BACnet MultiState Value objects of the device.
Public propertyDeviceType Type of the BACnet device.
(Inherited from BACnetDevice)
Public propertyDisposed Property to indicate if the Device has been disposed.
Public propertyId A 22-bit decimal number that serves as an address of the device on the network and allows BACnet to unambiguously access it. The Id must be unique within the complete BACnet network.
(Inherited from BACnetDevice)
Public propertyName Device Name
Public propertyParent The parent that this BACnetDevice object was added to.
(Inherited from BACnetDevice)
Public propertyPortNumber The UDP port number, set by the programmer, to be used by the BACnet device/protocol for directed messages and broadcasts.
(Inherited from BACnetDevice)
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from BACnetDevice)
Public propertyWritePriority Write priority of the object.
(Inherited from BACnetDevice)
Top
Methods
 NameDescription
Public methodAddObject(BACnetObject) Adds the specified host object to the corresponding host objects collection. This function also validates the object parameters passed. Success will be returned if the object 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 object from the stack and also the object will be deleted from the local collection. In this function Object Name is trimmed.
(Overrides BACnetDeviceAddObject(BACnetObject))
Public methodAddObject(BACnetObject, Int32) Adds the specified host object to the corresponding host objects collection, with user settable timeout option. This function also validates the object parameters passed. Success will be returned if the object is added successfully, otherwise an exception is thrown that tells what kind of error found.
(Overrides BACnetDeviceAddObject(BACnetObject, Int32))
Public methodDispose Clean up of resources.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetNumberOfObjects Method to get the number of objects added to this BACnet device.
(Inherited from BACnetDevice)
Public methodGetNumberOfObjects(eBACnetObjectType) Method to get the number of objects added to this BACnet device of the specified object type.
(Inherited from BACnetDevice)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodRemoveAllObjects Removes all the host objects from all the host objects collections. Success will be returned if all the objects are removed successfully, otherwise failure is returned and the corresponding error is logged.
(Overrides BACnetDeviceRemoveAllObjects)
Public methodRemoveAllObjects(eBACnetObjectType) Removes all the host objects of the specified type from the corresponding host objects collections. Success will be returned if all the objects of the specified type are removed successfully, otherwise failure is returned and the corresponding error is logged.
(Overrides BACnetDeviceRemoveAllObjects(eBACnetObjectType))
Public methodRemoveAllObjects(Int32) Removes all the host objects from all the host objects collections, with user settable timeout option. Success will be returned if all the object are removed successfully, otherwise failure is returned and the corresponding error is logged.
(Overrides BACnetDeviceRemoveAllObjects(Int32))
Public methodRemoveAllObjects(eBACnetObjectType, Int32) Removes all the host objects of the specified type from the corresponding host objects collections. Success will be returned if all the objects of the specified type are removed successfully, otherwise failure is returned and the corresponding error is logged.
(Overrides BACnetDeviceRemoveAllObjects(eBACnetObjectType, Int32))
Public methodRemoveObject(BACnetObject) Removes the specified host object from the corresponding host objects collection. Success will be returned if the object is removed successfully, otherwise an exception is thrown that tells what kind of error found.
(Overrides BACnetDeviceRemoveObject(BACnetObject))
Public methodRemoveObject(BACnetObject, Int32) Removes the specified host object from the corresponding host objects collection, with user settable timeout option. This function also validates the object parameters passed. Success will be returned if the object is removed successfully, otherwise an exception is thrown that tells what kind of error found.
(Overrides BACnetDeviceRemoveObject(BACnetObject, Int32))
Public methodToString String representation of the HostedBACnetDevice.
(Overrides ObjectToString)
Top
Events
 NameDescription
Public eventBACnetBaseEvent Event triggered when a feedback has changed for this BACnetDevice.
(Inherited from BACnetDevice)
Top
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionThe BACnet remote device id passed is not valid.
BACnetExceptionUnable to remove the BACnet remote device due to no response or error in the response packet received from the BACnet stack.
BACnetDeviceOrObjectDoesNotExistExceptionBACnet remote device with the specified device id does not exist in the system.

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also