BackupRestore.Restore (METH) ¶ METHOD Restore : CmpBACnet.IEC_BACNET_STATUS InOut: Scope Name Type Return Restore CmpBACnet.IEC_BACNET_STATUS
BackupRestore.RestoreClientCreatedObjects (PROP) ¶ PROPERTY RestoreClientCreatedObjects : BOOL Should client created objects be restored.
BackupRestore.TimeZone (PROP) ¶ PROPERTY TimeZone : Util.TimeZone Read / write the timezone. See also GetTimeZoneFromSystem and UpdateTimeZoneFromSystem .
BackupRestore.UpdateTimeZoneFromSystem (PROP) ¶ PROPERTY UpdateTimeZoneFromSystem : BOOL Determines whether or not the timezone is updated from the underlying system before each computation involving timezone.
ClientCreatableObjects (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL ClientCreatableObjects EXTENDS BACnet.BACnetServerPluginBase IMPLEMENTS BACnet.IBACnetEventConsumer Default implementation for client-create-object requests to limit client creatable object types to certain types and amounts. This default implementation registers a (client) create object service application hook and rejects unwanted client create object requests. This default implementation also ignores all property initial values except: Object_Name, Description, Profile_Name Properties: BlockFurtherProcessing Name NumHooks Methods: BACnetEventCallback GetHook Init PreRegister SetMaxNum Structure: BACnetEventCallback (Method) BlockFurtherProcessing (Property) GetHook (Method) Init (Method) Name (Property) NumHooks (Property) PreRegister (Method) SetMaxNum (Method)
ClientCreatableObjects.BACnetEventCallback (METH) ¶ METHOD BACnetEventCallback : BOOL Hook callback for IEC_BACNET_CB_TYPE.CB_DCC InOut: Scope Name Type Comment Return BACnetEventCallback BOOL Input EventId DWORD If only one event is possibly called, the following Ids can be ignored. If there are more at least the EventId should be checked, to get the right type of pParameter. ID of the occured Event. Contains the class and the event (see CmpBACnet.EVENTIDS) usParamId WORD Id of the parameter structure (see pParameter and CmpBACnet.EVENTIDS) usVersion WORD Version of the parameter structure (see pParameter and CmpBACnet.EVENTIDS) pParameter POINTER TO BYTE Pointer to the event specific parameter, that is specified by Id (see CmpBACnet.EVENTIDS and CmpBACnet, i.e. EVT_BACNET_ACKALARM)
ClientCreatableObjects.BlockFurtherProcessing (PROP) ¶ PROPERTY BlockFurtherProcessing : BOOL Controls either to block or allow further processing in other client create object service hook of BACnet-Server-Plugins registered later on.
ClientCreatableObjects.GetHook (METH) ¶ METHOD GetHook : BACnet.IBACnetServerPluginHook InOut: Scope Name Type Return GetHook BACnet.IBACnetServerPluginHook Input index UINT
BACnetSchedule.GetWeeklyEntry (METH) ¶ METHOD GetWeeklyEntry : CmpBACnet.IEC_BACNET_STATUS Gets the weekly entry for a specific day dayOfWeek at the index nIndex in the Weekly_Schedule-Property of this BACnet-Object. There are two options how to deal with the content buffer (value). 1.) the caller provides the content buffer large enough to hold the content. This works just for plain content data, because otherwise the caller can not determine the needed size of the content buffer a-priori. In case the content is of complex data type, GetWeeklyEntry returns BACNET_STATUS_INVALID_VALUE. 2.) stack allocated content buffer For this option provide value.buffer.pBuffer = 0 and free the stack allocated content buffer after usage FreeStackAllocatedMemory(value.buffer.pBuffer) Choosing one of the options, please be aware, that the Weekly_Schedule-Property of your Schedule object might be writable, so clients can add weekly entries of complex type even if your application isn’t doing so. InOut: Scope Name Type Comment Return GetWeeklyEntry CmpBACnet.IEC_BACNET_STATUS Input dayOfWeek CmpBACnet.IEC_BACNET_DAY_OF_WEEK The day of the week for which to get a weekly entry. nIndex CmpBACnet.IEC_BACNET_ELEMENT_COUNT The 1 based index of the entry of the week day to get. Output tim TIME The time of the entry after calling the method. Inout value CmpBACnet.IEC_BACNET_PROPERTY_CONTENTS The value of the entry after calling this method. The value.buffer.pBuffer has to have an allocated memory, which fits the data’s needs (is at least allocated big enough!)!
BACnetSchedule.GetWeeklyEntryCount (METH) ¶ METHOD GetWeeklyEntryCount : CmpBACnet.IEC_BACNET_STATUS Gets the number of weekly entries for a specific day dayOfWeek in the Weekly_Schedule-Property of this BACnet-Object. InOut: Scope Name Type Comment Return GetWeeklyEntryCount CmpBACnet.IEC_BACNET_STATUS Input dayOfWeek CmpBACnet.IEC_BACNET_DAY_OF_WEEK The day of the week for which the entry count shall be determined. Output count CmpBACnet.IEC_BACNET_ELEMENT_COUNT The number of entries for the specified week day after calling this method.
