@p2olab/pimad-core/dist/ModuleAutomation/ModuleAutomationObject.d.ts

PiMAd (Process-industry-Modular-Automation-description) High level access to automation of modular plants.

import { Backbone } from '../Backbone';
import PiMAdResponse = Backbone.PiMAdResponse;
import PiMAdResponseHandler = Backbone.PiMAdResponseHandler;
export declare type InitializeModuleAutomationObject = {
    dataSourceIdentifier?: string;
    defaultValue?: string;
    description?: string;
    metaModelRef?: string;
    name: string;
    pimadIdentifier: string;
    value?: string;
};
export declare abstract class AModuleAutomationObject implements ModuleAutomationObject {
    protected dataSourceIdentifier?: string;
    protected initialized: boolean;
    protected metaModelRef?: string;
    protected name?: string;
    protected pimadIdentifier?: string;
    protected responseHandler: PiMAdResponseHandler;
    protected defaultValue?: string;
    protected description?: string;
    protected value?: string;
    getDataSourceIdentifier(callback: (response: Backbone.PiMAdResponse, identifier: string | undefined) => void): void;
    getDefaultValue(callback: (response: Backbone.PiMAdResponse, defaultValue: string | undefined) => void): void;
    getDescription(callback: (response: Backbone.PiMAdResponse, defaultValue: string | undefined) => void): void;
    getMetaModelRef(callback: (response: Backbone.PiMAdResponse, metaModelRef: string | undefined) => void): void;
    getName(callback: (response: Backbone.PiMAdResponse, name: string | undefined) => void): void;
    getPiMAdIdentifier(callback: (response: Backbone.PiMAdResponse, identifier: string | undefined) => void): void;
    getValue(callback: (response: Backbone.PiMAdResponse, value: string | undefined) => void): void;
    protected genericPiMAdGetter<DataType>(data: DataType, callback: (response: Backbone.PiMAdResponse, responseGetter: DataType) => void): void;
    protected moduleAutomationObjectInitialize(instructions: InitializeModuleAutomationObject): boolean;
    constructor();
}
export interface ModuleAutomationObject {
    /**
     * Getter for this.dataSourceIdentifier. This variable contains the identifier of the previous data source. It's
     * mostly for debugging purpose and an assembling reference while importing the data.
     * @param callback - Accessing the identifier via callback function.
     */
    getDataSourceIdentifier(callback: (response: PiMAdResponse, identifier: string | undefined) => void): void;
    /**
     * Getter for this.name. The name of this instance.
     * @param callback - Accessing the name via callback function.
     */
    getName(callback: (response: PiMAdResponse, name: string | undefined) => void): void;
    /**
     * Getter for this.pimadIdentifier. A unique identifier in the PiMAd-core data model. Use this one while
     * interacting with PiMAd-objects.
     * @param callback - Accessing the identifier via callback function.
     */
    getPiMAdIdentifier(callback: (response: PiMAdResponse, identifier: string | undefined) => void): void;
    /**
     * Getter for this.metaModelRef. It's a link to the meta model description of the instance.
     * @param callback - Accessing the meta model reference via callback function.
     */
    getMetaModelRef(callback: (response: PiMAdResponse, metaModelRef: string | undefined) => void): void;
    /**
     * Getter for this.description.
     * @param callback - Accessing the meta model reference via callback function.
     */
    getDescription(callback: (response: PiMAdResponse, description: string | undefined) => void): void;
    /**
     * Getter for this.defaultValue.
     * @param callback - Accessing the meta model reference via callback function.
     */
    getDefaultValue(callback: (response: PiMAdResponse, defaultValue: string | undefined) => void): void;
}