joynr.types.ProviderQos.js Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of libjoynr-js Show documentation
JOYnr JavaScript libjoynr-js
There is a newer version: 1.4.0
/**
 * This is the generated struct type ProviderQos: DOCS GENERATED FROM INTERFACE DESCRIPTION
 * Generation date: Fri Jun 29 14:35:22 CEST 2018
 */
(function(undefined) {
	/**
	 * @name ProviderQos
	 * @constructor
	 *
	 * @classdesc
	 * This is the generated struct type ProviderQos: DOCS GENERATED FROM INTERFACE DESCRIPTION
	 * 
Generation date: Fri Jun 29 14:35:22 CEST 2018
	 * 

the provider quality of service settings
	 *
	 * @param {Object} members - an object containing the individual member elements
	 * @param {Array.} members.customParameters - the list of Provider-Specific and InterfaceSpecific
	 * 				QoS Parameters
	 * @param {Number} members.priority - the priority value of the provider used for discovery
	 * @param {ProviderScope} members.scope - the scope of the provider (e.g. if it is to be used only
	 * 			with the local cluster controller)
	 * @param {Boolean} members.supportsOnChangeSubscriptions - true, if the provider supports onChangeSubscriptions,
	 * 			false otherwise
	 * @returns {ProviderQos} a new instance of a ProviderQos
	 */
	var ProviderQos = function ProviderQos(members) {
		if (!(this instanceof ProviderQos)) {
			// in case someone calls constructor without new keyword (e.g. var c = Constructor({..}))
			return new ProviderQos(members);
		}

		/**
		 * Used for serialization.
		 * @name ProviderQos#_typeName
		 * @type String
		 * @readonly
		 */
		Object.defineProperty(this, "_typeName", {
			enumerable : true,
			value : ProviderQos._typeName
		});

		/**
		 * the list of Provider-Specific and InterfaceSpecific
		 * 				QoS Parameters
		 * @name ProviderQos#customParameters
		 * @type Array.
		 */
		/**
		 * the priority value of the provider used for discovery
		 * @name ProviderQos#priority
		 * @type Number
		 */
		/**
		 * the scope of the provider (e.g. if it is to be used only
		 * 			with the local cluster controller)
		 * @name ProviderQos#scope
		 * @type ProviderScope
		 */
		/**
		 * true, if the provider supports onChangeSubscriptions,
		 * 			false otherwise
		 * @name ProviderQos#supportsOnChangeSubscriptions
		 * @type Boolean
		 */

		if (members !== undefined) {
			this.customParameters = members.customParameters;
			this.priority = members.priority;
			this.scope = members.scope;
			this.supportsOnChangeSubscriptions = members.supportsOnChangeSubscriptions;
		}

	};

	Object.defineProperty(ProviderQos, "_typeName", {
		value : "joynr.types.ProviderQos"
	});

	Object.defineProperty(ProviderQos, 'checkMembers', {
		value: function checkMembers(instance, check) {
			check(instance.customParameters, "Array", "members.customParameters");
			check(instance.priority, "Number", "members.priority");
			check(instance.scope, ["String", "Object", "ProviderScope"], "members.scope");
			check(instance.supportsOnChangeSubscriptions, "Boolean", "members.supportsOnChangeSubscriptions");
		}
	});

	/**
	 * @name ProviderQos#MAJOR_VERSION
	 * @constant {Number}
	 * @default 0
	 * @summary The MAJOR_VERSION of the struct type ProviderQos is GENERATED FROM THE INTERFACE DESCRIPTION
	 */
	Object.defineProperty(ProviderQos, 'MAJOR_VERSION', { value: 0 });
	/**
	 * @name ProviderQos#MINOR_VERSION
	 * @constant {Number}
	 * @default 0
	 * @summary The MINOR_VERSION of the struct type ProviderQos is GENERATED FROM THE INTERFACE DESCRIPTION
	 */
	Object.defineProperty(ProviderQos, 'MINOR_VERSION', { value: 0 });

	var preparePrototype = function(joynr) {
		ProviderQos.prototype = new joynr.JoynrObject();
		ProviderQos.prototype.constructor = ProviderQos;
		joynr.util.GenerationUtil.addEqualsCompound(ProviderQos);
		joynr.util.GenerationUtil.addMemberTypeGetter(ProviderQos);
	};

	Object.defineProperty(ProviderQos, '_memberTypes', {
		value: {
			customParameters: "joynr.types.CustomParameter[]",
			priority: "Long",
			scope: "joynr.types.ProviderScope",
			supportsOnChangeSubscriptions: "Boolean"
		}
	});

	var joynr = require("joynr");
	preparePrototype(joynr);
	joynr.addType("joynr.types.ProviderQos", ProviderQos);
	module.exports = ProviderQos;
})();