// --------- This code has been automatically generated !!! 2018-09-03T20:28:10.899Z
"use strict";
/**
* @module opcua.address_space.types
*/
const assert = require("node-opcua-assert").assert;
const util = require("util");
const _ = require("underscore");
const makeNodeId = require("node-opcua-nodeid").makeNodeId;
const schema_helpers = require("node-opcua-factory/src/factories_schema_helpers");
const extract_all_fields = schema_helpers.extract_all_fields;
const resolve_schema_field_types = schema_helpers.resolve_schema_field_types;
const initialize_field = schema_helpers.initialize_field;
const initialize_field_array = schema_helpers.initialize_field_array;
const check_options_correctness_against_schema = schema_helpers.check_options_correctness_against_schema;
const _defaultTypeMap = require("node-opcua-factory/src/factories_builtin_types")._defaultTypeMap;
const ec = require("node-opcua-basic-types");
const encodeArray = ec.encodeArray;
const decodeArray = ec.decodeArray;
const makeExpandedNodeId = require("node-opcua-nodeid/src/expanded_nodeid").makeExpandedNodeId;
const generate_new_id = require("node-opcua-factory").generate_new_id;
const _enumerations = require("node-opcua-factory/src/factories_enumerations")._private._enumerations;
const schema = require("../schemas/HistoryReadRequest_schema").HistoryReadRequest_Schema;
const getFactory = require("node-opcua-factory/src/factories_factories").getFactory;
const RequestHeader = getFactory("RequestHeader");
const HistoryReadValueId = require("./_auto_generated_HistoryReadValueId").HistoryReadValueId;
const BaseUAObject = require("node-opcua-factory/src/factories_baseobject").BaseUAObject;
/**
*
* @class HistoryReadRequest
* @constructor
* @extends BaseUAObject
* @param options {Object}
*/
function HistoryReadRequest(options)
{
options = options || {};
/* istanbul ignore next */
if (schema_helpers.doDebug) { check_options_correctness_against_schema(this,schema,options); }
const self = this;
assert(this instanceof BaseUAObject); // ' keyword "new" is required for constructor call')
resolve_schema_field_types(schema);
BaseUAObject.call(this,options);
if (options === null) {
BaseUAObject.call(this,options);
self.requestHeader = null; /* new RequestHeader(null); */
self.nodesToRead = null; /* null array */
return ;
}
/**
*
* @property requestHeader
* @type {RequestHeader}
*/
self.requestHeader = new RequestHeader( options.requestHeader);
/**
* Maximum age of the value to be read in milliseconds
* @property historyReadDetails
* @type {ExtensionObject}
*/
self.historyReadDetails = initialize_field(schema.fields[1], options.historyReadDetails);
/**
* An enumeration that specifies the Timestamps to be returned for each requested Variable Value Attribute.
* @property timestampsToReturn
* @type {TimestampsToReturn}
* @default 3
*/
self.setTimestampsToReturn(initialize_field(schema.fields[2], options.timestampsToReturn));
/**
*
* @property releaseContinuationPoints
* @type {Boolean}
*/
self.releaseContinuationPoints = initialize_field(schema.fields[3], options.releaseContinuationPoints);
/**
* List of Nodes and their Attributes to read. For each entry in this list, a StatusCode is returned, and if it indicates success, the Attribute Value is also returned.
* @property nodesToRead
* @type {HistoryReadValueId[]}
*/
self.nodesToRead = [];
if (options.nodesToRead) {
assert(_.isArray(options.nodesToRead));
self.nodesToRead = options.nodesToRead.map(function(e){ return new HistoryReadValueId(e); } );
}
// Object.preventExtensions(self);
}
util.inherits(HistoryReadRequest,BaseUAObject);
//## Define Enumeration setters
HistoryReadRequest.prototype.setTimestampsToReturn = function(value) {
const coercedValue = _enumerations.TimestampsToReturn.typedEnum.get(value);
/* istanbul ignore next */
if (coercedValue === undefined || coercedValue === null) {
throw new Error("value cannot be coerced to TimestampsToReturn: " + value);
}
this.timestampsToReturn = coercedValue;
};
HistoryReadRequest.prototype.encodingDefaultBinary = makeExpandedNodeId(664,0);
HistoryReadRequest.prototype.encodingDefaultXml = makeExpandedNodeId(663,0);
HistoryReadRequest.prototype._schema = schema;
const encode_ExtensionObject = _defaultTypeMap.ExtensionObject.encode;
const decode_ExtensionObject = _defaultTypeMap.ExtensionObject.decode;
const encode_TimestampsToReturn = _enumerations.TimestampsToReturn.encode;
const decode_TimestampsToReturn = _enumerations.TimestampsToReturn.decode;
const encode_Boolean = _defaultTypeMap.Boolean.encode;
const decode_Boolean = _defaultTypeMap.Boolean.decode;
/**
* encode the object into a binary stream
* @method encode
*
* @param stream {BinaryStream}
*/
HistoryReadRequest.prototype.encode = function(stream,options) {
// call base class implementation first
BaseUAObject.prototype.encode.call(this,stream,options);
this.requestHeader.encode(stream,options);
encode_ExtensionObject(this.historyReadDetails,stream);
encode_TimestampsToReturn(this.timestampsToReturn,stream);
encode_Boolean(this.releaseContinuationPoints,stream);
encodeArray(this.nodesToRead,stream,function(obj,stream){ obj.encode(stream,options); });
};
/**
* decode the object from a binary stream
* @method decode
*
* @param stream {BinaryStream}
*/
HistoryReadRequest.prototype.decode = function(stream) {
// call base class implementation first
BaseUAObject.prototype.decode.call(this,stream);
this.requestHeader.decode(stream);
this.historyReadDetails = decode_ExtensionObject(stream);
this.timestampsToReturn = decode_TimestampsToReturn(stream);
this.releaseContinuationPoints = decode_Boolean(stream);
this.nodesToRead = decodeArray(stream, function(stream) {
const obj = new HistoryReadValueId(null);
obj.decode(stream);
return obj;
});
};
HistoryReadRequest.possibleFields = [
"requestHeader",
"historyReadDetails",
"timestampsToReturn",
"releaseContinuationPoints",
"nodesToRead"
];
exports.HistoryReadRequest = HistoryReadRequest;
const register_class_definition = require("node-opcua-factory/src/factories_factories").register_class_definition;
register_class_definition("HistoryReadRequest",HistoryReadRequest);