APIs

Show:
// --------- This code has been automatically generated !!! 2017-12-15T21:13:58.919Z
"use strict";
/**
 * @module opcua.address_space.types
 */
var assert = require("node-opcua-assert");
var util = require("util");
var _  = require("underscore");
var makeNodeId = require("node-opcua-nodeid").makeNodeId;
var schema_helpers =  require("node-opcua-factory/src/factories_schema_helpers");
var extract_all_fields                       = schema_helpers.extract_all_fields;
var resolve_schema_field_types               = schema_helpers.resolve_schema_field_types;
var initialize_field                         = schema_helpers.initialize_field;
var initialize_field_array                   = schema_helpers.initialize_field_array;
var check_options_correctness_against_schema = schema_helpers.check_options_correctness_against_schema;
var _defaultTypeMap = require("node-opcua-factory/src/factories_builtin_types")._defaultTypeMap;
var ec = require("node-opcua-basic-types");
var encodeArray = ec.encodeArray;
var decodeArray = ec.decodeArray;
var makeExpandedNodeId = require("node-opcua-nodeid/src/expanded_nodeid").makeExpandedNodeId;
var generate_new_id = require("node-opcua-factory").generate_new_id;
var _enumerations = require("node-opcua-factory/src/factories_enumerations")._private._enumerations;
var schema = require("../schemas/AttributeOperand_schema").AttributeOperand_Schema;
var getFactory = require("node-opcua-factory/src/factories_factories").getFactory;
var RelativePath = getFactory("RelativePath");
var BaseUAObject = require("node-opcua-factory/src/factories_baseobject").BaseUAObject;
var FilterOperand = require("./_auto_generated_FilterOperand").FilterOperand;

/**
 * 
 * @class AttributeOperand
 * @constructor
 * @extends FilterOperand
 * @param  options {Object}
 * @param  [options.nodeId] {NodeId} NodeId of a Node from the type system.
 * @param  [options.alias] {String} An optional parameter used to identify or refer to an alias. An alias is a symbolic name that can be used to alias this operand and use it in other locations in the filter structure.
 * @param  [options.browsePath] {RelativePath} Browse path relative to the Node identified by the nodeId parameter.
 * @param  [options.attributeId] {IntegerId} 
 * @param  [options.indexRange] {NumericRange} This parameter is used to identify a single element of an array or a single range of indexes for an array. The first element is identified by index 0 (zero).
 */
function AttributeOperand(options)
{
    options = options || {};
    /* istanbul ignore next */
    if (schema_helpers.doDebug) { check_options_correctness_against_schema(this,schema,options); }
    var self = this;
    assert(this instanceof BaseUAObject); //  ' keyword "new" is required for constructor call')
    resolve_schema_field_types(schema);

    FilterOperand.call(this,options);

    /**
      * NodeId of a Node from the type system.
      * @property nodeId
      * @type {NodeId}
      */
    self.nodeId = initialize_field(schema.fields[0], options.nodeId);

    /**
      * An optional parameter used to identify or refer to an alias. An alias is a symbolic name that can be used to alias this operand and use it in other locations in the filter structure.
      * @property alias
      * @type {String}
      */
    self.alias = initialize_field(schema.fields[1], options.alias);

    /**
      * Browse path relative to the Node identified by the nodeId parameter.
      * @property browsePath
      * @type {RelativePath}
      */
    self.browsePath =  new RelativePath( options.browsePath);

    /**
      * 
      * @property attributeId
      * @type {IntegerId}
      */
    self.attributeId = initialize_field(schema.fields[3], options.attributeId);

    /**
      * This parameter is used to identify a single element of an array or a single range of indexes for an array. The first element is identified by index 0 (zero).
      * @property indexRange
      * @type {NumericRange}
      */
    self.indexRange = initialize_field(schema.fields[4], options.indexRange);

   // Object.preventExtensions(self);
}
util.inherits(AttributeOperand,FilterOperand);
AttributeOperand.prototype.encodingDefaultBinary = makeExpandedNodeId(600,0);
AttributeOperand.prototype.encodingDefaultXml = makeExpandedNodeId(599,0);
AttributeOperand.prototype._schema = schema;

var encode_NodeId = _defaultTypeMap.NodeId.encode;
var decode_NodeId = _defaultTypeMap.NodeId.decode;
var encode_String = _defaultTypeMap.String.encode;
var decode_String = _defaultTypeMap.String.decode;
var encode_IntegerId = _defaultTypeMap.IntegerId.encode;
var decode_IntegerId = _defaultTypeMap.IntegerId.decode;
var encode_NumericRange = _defaultTypeMap.NumericRange.encode;
var decode_NumericRange = _defaultTypeMap.NumericRange.decode;
/**
 * encode the object into a binary stream
 * @method encode
 *
 * @param stream {BinaryStream} 
 */
AttributeOperand.prototype.encode = function(stream,options) {
    // call base class implementation first
    FilterOperand.prototype.encode.call(this,stream,options);
    encode_NodeId(this.nodeId,stream);
    encode_String(this.alias,stream);
   this.browsePath.encode(stream,options);
    encode_IntegerId(this.attributeId,stream);
    encode_NumericRange(this.indexRange,stream);
};
/**
 * decode the object from a binary stream
 * @method decode
 *
 * @param stream {BinaryStream} 
 * @param [option] {object} 
 */
AttributeOperand.prototype.decode = function(stream,options) {
    // call base class implementation first
    FilterOperand.prototype.decode.call(this,stream,options);
    this.nodeId = decode_NodeId(stream,options);
    this.alias = decode_String(stream,options);
    this.browsePath.decode(stream,options);
    this.attributeId = decode_IntegerId(stream,options);
    this.indexRange = decode_NumericRange(stream,options);
};
AttributeOperand.possibleFields = [
  "nodeId",
         "alias",
         "browsePath",
         "attributeId",
         "indexRange"
];


exports.AttributeOperand = AttributeOperand;
var register_class_definition = require("node-opcua-factory/src/factories_factories").register_class_definition;
register_class_definition("AttributeOperand",AttributeOperand);