import Qrating from 'opengate-js/src/iot/catalog/Qrating.js'

public class | source

Qrating

Defines the builder to configure a qurating of datastream of IoT datamodel. With this builder you can configure a qrating

Constructor Summary

Public Constructor
public	constructor()

Method Summary

Public Methods
public	build(): Object Build a Qrating json object
public	withConversionMatrix(conversionMatrix: Object): Qrating Set the conversionMatrix attribute
public	withCumulativePeriodDivisor(cumulativePeriodDivisor: string): Qrating Set the cumulativePeriodDivisor attribute
public	withIdeal(label: string, value: number): Qrating Set the ideal attribute
public	withMaxAllowed(label: string, value: number): Qrating Set the maxAllowed attribute
public	withMaxDesired(label: string, value: number): Qrating Set the maxDesired attribute
public	withMaxScore(maxScore: number): Qrating Set the maxScore attribute
public	withMinDesired(label: string, value: number): Qrating Set the minDesired attribute
public	withMinRequired(label: string, value: number): Qrating Set the minRequired attribute
public	withVersion(version: string): Qrating Set the version attribute

Public Constructors

public constructor() source

Public Methods

public build(): Object source

Build a Qrating json object

Return:

Object

Datastream json object

Throw:

Error

Throw error if there is not version, minRequired, minDesired, ideal, maxDesired, maxAllowed and maxScore

Example:

ogapi.QratingsBuilder().build()

public withConversionMatrix(conversionMatrix: Object): Qrating source

Set the conversionMatrix attribute

Params:

Name	Type	Attribute	Description
conversionMatrix	Object	nullable: false

Return:

Qrating

public withCumulativePeriodDivisor(cumulativePeriodDivisor: string): Qrating source

Set the cumulativePeriodDivisor attribute

Params:

Name	Type	Attribute	Description
cumulativePeriodDivisor	string	nullable: false

Return:

Qrating

public withIdeal(label: string, value: number): Qrating source

Set the ideal attribute

Params:

Name	Type	Attribute	Description
label	string	nullable: false	required field
value	number	nullable: false	required field

Return:

Qrating

public withMaxAllowed(label: string, value: number): Qrating source

Set the maxAllowed attribute

Params:

Name	Type	Attribute	Description
label	string	nullable: false	required field
value	number	nullable: false	required field

Return:

Qrating

public withMaxDesired(label: string, value: number): Qrating source

Set the maxDesired attribute

Params:

Name	Type	Attribute	Description
label	string	nullable: false	required field
value	number	nullable: false	required field

Return:

Qrating

public withMaxScore(maxScore: number): Qrating source

Set the maxScore attribute

Params:

Name	Type	Attribute	Description
maxScore	number	nullable: false	required field

Return:

Qrating

public withMinDesired(label: string, value: number): Qrating source

Set the minDesired attribute

Params:

Name	Type	Attribute	Description
label	string	nullable: false	required field
value	number	nullable: false	required field

Return:

Qrating

public withMinRequired(label: string, value: number): Qrating source

Set the minRequired attribute

Params:

Name	Type	Attribute	Description
label	string	nullable: false	required field
value	number	nullable: false	required field

Return:

Qrating

public withVersion(version: string): Qrating source

Set the version attribute

Params:

Name	Type	Attribute	Description
version	string	nullable: false	required field

Return:

Qrating