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

Go to download
/**
 * This is the generated struct type ProviderQos: DOCS GENERATED FROM INTERFACE DESCRIPTION
 * Generation date: Thu Aug 18 09:35:51 CEST 2016
 */
(function(undefined) {
	/**
	 * @name ProviderQos
	 * @constructor
	 *
	 * @classdesc
	 * This is the generated struct type ProviderQos: DOCS GENERATED FROM INTERFACE DESCRIPTION
	 * 
Generation date: Thu Aug 18 09:35:51 CEST 2016
	 * 

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", {
			configurable : false,
			writable : false,
			enumerable : true,
			value : "joynr.types.ProviderQos"
		});

		/**
		 * 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
		 */
		Object.defineProperty(this, 'checkMembers', {
			enumerable: false,
			value: function checkMembers(check) {
				check(this.customParameters, "Array", "members.customParameters");
				check(this.priority, "Number", "members.priority");
				check(this.scope, ["String", "Object", "ProviderScope"], "members.scope");
				check(this.supportsOnChangeSubscriptions, "Boolean", "members.supportsOnChangeSubscriptions");
			}
		});

		if (members !== undefined) {
			this.customParameters = members.customParameters;
			this.priority = members.priority;
			this.scope = members.scope;
			this.supportsOnChangeSubscriptions = 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', {
		enumerable: false,
		configurable: false,
		writable: false,
		readable: true,
		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', {
		enumerable: false,
		configurable: false,
		writable: false,
		readable: true,
		value: 0
	});

	var memberTypes = {
		customParameters: function() { return "joynr.types.CustomParameter[]"; },
		priority: function() { return "Long"; },
		scope: function() { return "joynr.types.ProviderScope"; },
		supportsOnChangeSubscriptions: function() { return "Boolean"; }
	};
	Object.defineProperty(ProviderQos, 'getMemberType', {
		enumerable: false,
		value: function getMemberType(memberName) {
			if (memberTypes[memberName] !== undefined) {
				return memberTypes[memberName]();
			}
			return undefined;
		}
	});

	// AMD support
	if (typeof define === 'function' && define.amd) {
		define("joynr/types/ProviderQos", ["joynr"], function (joynr) {
			ProviderQos.prototype = new joynr.JoynrObject();
			ProviderQos.prototype.constructor = ProviderQos;
			joynr.addType("joynr.types.ProviderQos", ProviderQos);
			return ProviderQos;
		});
	} else if (typeof exports !== 'undefined' ) {
		if ((module !== undefined) && module.exports) {
			exports = module.exports = ProviderQos;
		} else {
			// support CommonJS module 1.1.1 spec (`exports` cannot be a function)
			exports.ProviderQos = ProviderQos;
		}
		var joynr = requirejs("joynr");
		ProviderQos.prototype = new joynr.JoynrObject();
		ProviderQos.prototype.constructor = ProviderQos;

		joynr.addType("joynr.types.ProviderQos", ProviderQos);
	} else {
		ProviderQos.prototype = new window.joynr.JoynrObject();
		ProviderQos.prototype.constructor = ProviderQos;
		window.joynr.addType("joynr.types.ProviderQos", ProviderQos);
		window.ProviderQos = ProviderQos;
	}
})();