BoundedValue

BoundedValue

Kind: global class

• BoundedValue
  • new BoundedValue(currentValue, upperLimit, [lowerLimit])
  • .setUpperLimit(v)
  • .getUpperLimit() ⇒ Number
  • .getLowerLimit() ⇒ Number
  • .setLowerLimit(v)
  • .setValue(v)
  • .getValue() ⇒ Number
  • .getFraction() ⇒ number
  • .setValueToLimit()
  • .isValueAtLimit() ⇒ boolean
  • .addValue(val)
  • .copy(other) ⇒ BoundedValue
  • .equals(other) ⇒ boolean
  • .hash() ⇒ number
  • .toBinaryBuffer(buffer)
  • .fromBinaryBuffer(buffer)

new BoundedValue(currentValue, upperLimit, [lowerLimit])

Param	Type	Default
currentValue	Number
upperLimit	Number
[lowerLimit]	Number	0

boundedValue.setUpperLimit(v)

Kind: instance method of BoundedValue

Param	Type
v	Number

boundedValue.getUpperLimit() ⇒ Number

Kind: instance method of BoundedValue

boundedValue.getLowerLimit() ⇒ Number

Kind: instance method of BoundedValue

boundedValue.setLowerLimit(v)

Kind: instance method of BoundedValue

Param	Type
v	Number

boundedValue.setValue(v)

Kind: instance method of BoundedValue

Param	Type
v	Number

boundedValue.getValue() ⇒ Number

Kind: instance method of BoundedValue

boundedValue.getFraction() ⇒ number

Kind: instance method of BoundedValue

boundedValue.setValueToLimit()

Kind: instance method of BoundedValue

boundedValue.isValueAtLimit() ⇒ boolean

Kind: instance method of BoundedValue

boundedValue.addValue(val)

Kind: instance method of BoundedValue

Param	Type
val	Number

boundedValue.copy(other) ⇒ BoundedValue

Kind: instance method of BoundedValue

Param	Type
other	BoundedValue

boundedValue.equals(other) ⇒ boolean

Kind: instance method of BoundedValue

Param	Type
other	BoundedValue

boundedValue.hash() ⇒ number

Kind: instance method of BoundedValue

boundedValue.toBinaryBuffer(buffer)

Kind: instance method of BoundedValue

Param	Type
buffer	BinaryBuffer

boundedValue.fromBinaryBuffer(buffer)

Kind: instance method of BoundedValue

Param	Type
buffer	BinaryBuffer