BAObjectHandler

The BaObjectHandler takes over the management of the BaObject.

Use

The implementation is done via the respective interfaces.

IUsesBaObject

Provision of the BaObjectHandler.

Requires:

• TcHmiBaFramework

module MyNamespace {
    export class MyClass<A extends MyClass.IAttributes = MyClass.IAttributes> extends TcHmi.BuildingAutomation.Base implements TcHmi.BuildingAutomation.BaObjectHandler.IUsesBaObject {

        public baObjectHandler: TcHmi.BuildingAutomation.BaObjectHandler;

        constructor(id: string, parent: TcHmi.BuildingAutomation.IBaseNode | null, attr?: A) {
             super(id, parent, attr);

             this.baObjectHandler = new TcHmi.BuildingAutomation.BaObjectHandler(this);
        }

        public processBaObject() {
            if (this.baObjectHandler.baObject == null) return;
            // do work
        }
    }

    export module MyClass {
        export interface IAttributes extends TcHmi.BuildingAutomation.Base.IAttributes {
            // optional additional attributes
        }
    }
}

IFCUsesBaObject

Providing the BaObjectHandler with BaObject attribute for the TcHmi Designer.

Requires:

• TcHmiBaFramework
• TcHmiBaControls

module MyNamespace {
    export class MyControl extends TcHmi.BuildingAutomation.Controls.System.BaseControl implements TcHmi.BuildingAutomation.BaObjectHandler.IFCUsesBaObject {

        public baObjectHandler: TcHmi.BuildingAutomation.BaObjectHandler;

        constructor(element: JQuery, pcElement: JQuery, attrs: TcHmi.Controls.ControlAttributeList) {
             super(element, pcElement, attrs);

             this.baObjectHandler = new TcHmi.BuildingAutomation.BaObjectHandler(this);
        }

        public processBaObject() {
        if (this.baObjectHandler.baObject == null) return;
        // do work
        }

        public setBaObject(p: TcHmi.BuildingAutomation.BA.BaBasicObject | TcHmi.BuildingAutomation.BA.BaBasicObject.IBaBasicObjectAttributes | TcHmi.Symbol | null | undefined): this {
             this.baObjectHandler.setBaObject(p);

             return this;
        }

        public getBaObject() {
             return this.baObjectHandler.baObject;
        }
    }
}

In the interface IFCUsesBaObject the setters and getters for the BaObject are already defined, so in the Description.json only the BaObject attribute has to be defined.

"attributes": [
    {
         "name": "data-tchmi-ba-object",
         "displayName": "BaObject",
         "propertyName": "BaObject",
         "propertySetterName": "setBaObject",
         "propertyGetterName": "getBaObject",
         "visible": true,
         "themeable": "None",
         "type": "tchmi:framework#/definitions/Symbol",
         "category": "BA",
         "description": "BA object of the control.",
         "requiredOnCompile": false,
         "readOnly": false,
         "bindable": true,
         "heritable": true,
         "defaultValue": null,
         "defaultValueInternal": null
    }
]