Capability Negotiation

Code example

function getACapability(capability){// Specify a Capability with capability
    STR_CapValueType = [
        'TWTY_INT8', 'TWTY_INT16', 'TWTY_INT32', 'TWTY_UINT8', 'TWTY_UINT16', 'TWTY_int', 'TWTY_BOOL',
        'TWTY_FIX32', 'TWTY_FRAME', 'TWTY_STR32', 'TWTY_STR64', 'TWTY_STR128', 'TWTY_STR255'];

    DWObject.SelectSource();
    DWObject.OpenSource();
    DWObject.Capability = capability; // Specify a Capability
    DWObject.<code>CapGet()</code>;
    var i, nCapType = DWObject.CapType;
    switch (nCapType) {
        case EnumDWT_CapType.TWON_ARRAY/*3*/:
            console.log('Available Values:');
            for (i = 0; i < DWObject.CapNumItems; i++) {
                if (DWObject.CapValueType > 8) /* >8 is string*/
                /*STR*/console.log( DWObject.GetCapItemsString(i));
                else
                /*NUM*/console.log(DWObject.GetCapItems(i));
            }
            break;
        case EnumDWT_CapType.TWON_ENUMERATION/*4*/:
            console.log('Available Values:');
            for (i = 0; i < DWObject.CapNumItems; i++) {
                if (DWObject.CapValueType > 8)
                /*STR*/console.log(DWObject.GetCapItemsString(i));
                else
                /*NUM*/console.log(DWObject.GetCapItems(i));
            }
            if (DWObject.CapValueType > 8) {
                console.log('Current Index = ' + DWObject.CapCurrentIndex + ' (Value: ' + DWObject.GetCapItemsString(DWObject.CapCurrentIndex) + ')');
                console.log('Default Index = ' + DWObject.CapDefaultIndex + ' (Value: ' + DWObject.GetCapItemsString(DWObject.CapDefaultIndex) + ')');
            }
            else {
                console.log('Current Index = ' + DWObject.CapCurrentIndex + ' (Value: ' + DWObject.GetCapItems(DWObject.CapCurrentIndex) + ')');
                console.log('Default Index = ' + DWObject.CapDefaultIndex + ' (Value: ' + DWObject.GetCapItems(DWObject.CapDefaultIndex) + ')');
            }
            break;
        case EnumDWT_CapType.TWON_ONEVALUE/*5*/:
            var tempValue = '';
            if (DWObject.CapValueType > 8)
            /*STR*/tempValue = DWObject.CapValueString;
            else
            /*NUM*/tempValue = DWObject.CapValue;
            /*
            * Special for BOOL
            */
            if (DWObject.CapValueType == EnumDWT_CapValueType.TWTY_BOOL) {
                if (tempValue == 0) tempValue = 'FALSE'; else tempValue = 'TRUE';
            }
            console.log('ItemType = ' + STR_CapValueType[DWObject.CapValueType]);
            console.log('Value = ' + tempValue);
            break;
        case EnumDWT_CapType.TWON_RANGE/*6*/:
            console.log('ItemType = ' + STR_CapValueType[DWObject.CapValueType]);
            console.log('Min = ' + DWObject.CapMinValue);
            console.log('Max = ' + DWObject.CapMaxValue);
            console.log('StepSize = ' + DWObject.CapStepSize);
            console.log('Default = ' + DWObject.CapDefaultValue);
            console.log('Current = ' + DWObject.CapCurrentValue);
            break;
        default: console.log('This Capability is not supported');
    }
    var supportLevel = [];
    if (DWObject.CapIfSupported(EnumDWT_MessageType.TWQC_GET)) supportLevel.push('GET');/*TWQC_GET*/
    if (DWObject.CapIfSupported(EnumDWT_MessageType.TWQC_SET)) supportLevel.push('SET');/*TWQC_SET*/
    if (DWObject.CapIfSupported(EnumDWT_MessageType.TWQC_RESET)) supportLevel.push('RESET');/*TWQC_RESET*/
    if (supportLevel.length > 0) {
        console.log('Supported operations: ');
        console.log(supportLevel.join(' / '));
    }
}

// Set A Capability
function setACapability(capability, valueToSet, indexToSet) {
    var tempValue = '', i, valueToShow;
    DWObject.SelectSource();
    DWObject.OpenSource();
    DWObject.Capability = capability;
    DWObject.<code>CapGet()</code>;
    nCapType = DWObject.CapType;
    switch (nCapType) {
        case EnumDWT_CapType.TWON_ARRAY/*3*/:
            console.log('Setting an Array is not implemented');
            break;
        case EnumDWT_CapType.TWON_ENUMERATION/*4*/:
            DWObject.CapValue = valueToSet;
            DWObject.CapCurrentIndex = indexToSet;
            DWObject.<code>CapSet()</code>;
            console.log('CapSet: ' + DWObject.ErrorString);
            DWObject.<code>CapGet()</code>;
            console.log('After Setting:');
            if (DWObject.CapValueType > 8) {
                console.log('Current Index = ' + DWObject.CapCurrentIndex + ' (Value: ' + DWObject.GetCapItemsString(DWObject.CapCurrentIndex) + ')');
                console.log('Default Index = ' + DWObject.CapDefaultIndex + ' (Value: ' + DWObject.GetCapItemsString(DWObject.CapDefaultIndex) + ')');
            }
            else {
                console.log('Current Index = ' + DWObject.CapCurrentIndex + ' (Value: ' + DWObject.GetCapItems(DWObject.CapCurrentIndex) + ')');
                console.log('Default Index = ' + DWObject.CapDefaultIndex + ' (Value: ' + DWObject.GetCapItems(DWObject.CapDefaultIndex) + ')');
            }
            break;
        case EnumDWT_CapType.TWON_ONEVALUE/*5*/:
            DWObject.CapValue = valueToSet;
            DWObject.<code>CapSet()</code>;
            console.log('CapSet: ' + DWObject.ErrorString);
            DWObject.<code>CapGet()</code>;
            console.log('Value after setting: ' + DWObject.CapValue);
            break;
        case EnumDWT_CapType.TWON_RANGE/*6*/:
            DWObject.CapCurrentValue = valueToSet;
            DWObject.<code>CapSet()</code>;
            console.log('CapSet: ' + DWObject.ErrorString);
            DWObject.<code>CapGet()</code>;
            console.log('Value after setting: ' + DWObject.CapCurrentValue);
            break;
        default: console.log('This Capability is not supported');
    }
}

Methods

Properties