BACnetObjectBase.GetPropertyInstanceStackAllocContentBuffer (METH) ¶ METHOD GetPropertyInstanceStackAllocContentBuffer : CmpBACnet.IEC_BACNET_STATUS Gets the value/content of a specified BACnet-Property (ePropertyID) independend of any client side acces restrictions. The specified index should be set to -1, meaning that all elements of a List or Array in a BACnet-Property are retrieved. Otherwise an index counting from 1 specifies a element of a BACnetARRAY property. The IEC_BACNET_PEROPERTY_CONTENTS variable propertyContents.Buffer.pBuffer is requested to be initialized with 0, whereas the stack allocates the latter pointer. Consequently after using the information in propertyContents.Buffer.pBuffer has to be used to freed. DeallocStackAllocatedContentBuffer provides convenient dealloc for stack allocated propertyContents. InOut: Scope Name Type Comment Return GetPropertyInstanceStackAllocContentBuffer CmpBACnet.IEC_BACNET_STATUS Input ePropertyID CmpBACnet.IEC_BACNET_PROPERTY_ID The id of the property to get. nIndex DINT Counting from 1. See documentation of CmpBACnet.BACnetRetrievePropertyInstance. Inout propertyContents CmpBACnet.IEC_BACNET_PROPERTY_CONTENTS structure holding the read Property-Data (see documentation above).
BACnetObjectBase.IsPropertyWriteable (METH) ¶ METHOD IsPropertyWriteable : BOOL Returns whether the specified BACnet-Property of this BACnet-Object (propID) is client side writeable or only client side readable. This access restrictions only hold for client side access and not for the functions used in this FB (i.e. SetPropertyInstance). InOut: Scope Name Type Comment Return IsPropertyWriteable BOOL Input propID CmpBACnet.IEC_BACNET_PROPERTY_ID The property ID for which the writeability shall be determined.
BACnetObjectBase.DeviceInstNumber (PROP) ¶ PROPERTY DeviceInstNumber : DWORD Device instance number of the parent BACnet-Device of this BACnet-Object.
BACnetObjectBase.GetPropertyAccessRight (METH) ¶ METHOD GetPropertyAccessRight : CmpBACnet.IEC_BACNET_STATUS Gets the client side access rights for a specified BACnet-Property of this BACnet-Object (propID). These restrictions only hold for client side access of the specified BACnet-Property. InOut: Scope Name Type Comment Return GetPropertyAccessRight CmpBACnet.IEC_BACNET_STATUS Input propID CmpBACnet.IEC_BACNET_PROPERTY_ID The property ID for which the access right shall be determined. Output accessRight CmpBACnet.IEC_BACNET_ACCESS The property access rights after a call to this method.
BACnetObjectBase.GetPropertyId (METH) ¶ METHOD GetPropertyId : CmpBACnet.IEC_BACNET_PROPERTY_ID Gets the propertId with the given index (0 .. NumberOfProperties-1). Returns IEC_BACNET_PROPERTY_ID._PROP_MAX_SIZE, in case propIdx is out of range or the requested propertID can not be read properly. InOut: Scope Name Type Return GetPropertyId CmpBACnet.IEC_BACNET_PROPERTY_ID Input propIdx DWORD
BACnetObjectBase.GetPropertyCallbackAttachment (METH) ¶ METHOD GetPropertyCallbackAttachment : CmpBACnet.IEC_BACNET_STATUS Gets the current callback status of a property of the BACnet-Object. This status defines if the WRITE- or READ-Callbacks (IEC_BACNET_CALLBACK_TYPE used in BACnetServer.RegisterCallback ) are called for the specified property of this object. InOut: Scope Name Type Initial Comment Return GetPropertyCallbackAttachment CmpBACnet.IEC_BACNET_STATUS Input ePropertyID CmpBACnet.IEC_BACNET_PROPERTY_ID The id of the property to get its callback status for. Output xReadCallbackAttached BOOL FALSE If the READ-Callback is called for the sepcified property of this object, TRUE. Else FALSE. xWriteCallbackAttached BOOL FALSE If the WRITE-Callback is called for the sepcified property of this object, TRUE. Else FALSE.
Utilities ¶ Utility functions for handling properties of different types of any BACnet object. GetBACnetAccumulatorRecordProperty (Method) GetBACnetArraySizeOfProperty (Method) GetBACnetArraySizeOfTwoProperties (Method) GetBACnetBitStringProperty (Method) GetBACnetBooleanProperty (Method) GetBACnetClientCOVProperty (Method) GetBACnetDateProperty (Method) GetBACnetDateRangeProperty (Method) GetBACnetDateTimeProperty (Method) GetBACnetDevObjPropReferenceProperty (Method) GetBACnetDoubleProperty (Method) GetBACnetEnumeratedProperty (Method) GetBACnetObjPropReferenceProperty (Method) GetBACnetObjectIDProperty (Method) GetBACnetPrescaleProperty (Method) GetBACnetRealProperty (Method) GetBACnetScaleProperty (Method) GetBACnetSetpointReferenceProperty (Method) GetBACnetSignedProperty (Method) GetBACnetStringProperty (Method) GetBACnetTimeProperty (Method) GetBACnetTimeStampProperty (Method) GetBACnetUnsignedProperty (Method) IsBACnetDateTimePropertyUnspecified (Method) SetBACnetAccumulatorRecordProperty (Method) SetBACnetBitStringProperty (Method) SetBACnetBooleanProperty (Method) SetBACnetClientCOVProperty (Method) SetBACnetDateProperty (Method) SetBACnetDateRangeProperty (Method) SetBACnetDateTimeProperty (Method) SetBACnetDateTimePropertyToUnspecified (Method) SetBACnetDevObjPropReferenceProperty (Method) SetBACnetDoubleProperty (Method) SetBACnetEnumeratedProperty (Method) SetBACnetObjPropReferenceProperty (Method) SetBACnetObjectIDProperty (Method) SetBACnetPrescaleProperty (Method) SetBACnetRealProperty (Method) SetBACnetScaleProperty (Method) SetBACnetSetpointReferenceProperty (Method) SetBACnetSignedProperty (Method) SetBACnetStringProperty (Method) SetBACnetTimeProperty (Method) SetBACnetTimeStampProperty (Method) SetBACnetUnsignedProperty (Method)
BACnetObjectBase.GetBACnetAccumulatorRecordProperty (METH) ¶ METHOD GetBACnetAccumulatorRecordProperty : CmpBACnet.IEC_BACNET_ACCUMULATOR_RECORD Returns the BACnet-Accumulator-Record of the specified Property (propID) of this BACnet-Object as a IEC_BACNET_ACCUMULATOR_RECORD struct. The used functions are no client, meaning, that the access of the property is not restricted by write or read access restrictions. InOut: Scope Name Type Comment Return GetBACnetAccumulatorRecordProperty CmpBACnet.IEC_BACNET_ACCUMULATOR_RECORD Input propID CmpBACnet.IEC_BACNET_PROPERTY_ID The ID of the property to get.
BACnetObjectBase.GetBACnetArraySizeOfProperty (METH) ¶ METHOD GetBACnetArraySizeOfProperty : CmpBACnet.IEC_BACNET_STATUS Returns the number of elements in a BACnetARRAY property. InOut: Scope Name Type Comment Return GetBACnetArraySizeOfProperty CmpBACnet.IEC_BACNET_STATUS Input ePropertyID CmpBACnet.IEC_BACNET_PROPERTY_ID The ID of the property to get the array size from. Output arraySize CmpBACnet.IEC_BACNET_ELEMENT_COUNT
BACnetObjectBase.NumberOfProperties (PROP) ¶ PROPERTY NumberOfProperties : DWORD Gets the number of properties the object provides.