<SCIRangeProtocol> Protocol Reference

Defines protcol for ranges. More...

#import <SCIRangeProtocol.h>

Inheritance diagram for <SCIRangeProtocol>:
SCIDateRange SCIDoubleRange SCIFloatRange SCIIndexRange SCIIntegerRange

Instance Methods

(SCIRangeType- rangeType
 Returns range type (numeric, date time or index) More...
 
(SCIGenericType- diff
 Returns difference between max and min values. More...
 
(BOOL) - isZero
 Return true if difference between max and min is zero. More...
 
(BOOL) - isMinMaxValid
 Gets whether the min and max value are valid ( min <= max ) More...
 
("Please use minAsDouble and maxAsDouble instead") - __deprecated_msg
 Converts range to SCIDoubleRange. More...
 
(double) - maxAsDouble
 Gets the double representation of max value. More...
 
(double) - minAsDouble
 Gets the double representation of min value. More...
 
(void) - setMinTo:MaxTo:
 Method sets min and max values for range. More...
 
(void) - setMinTo:MaxTo:WithLimits:
 Method sets min and max values for range and clips values to limits. More...
 
(id< SCIRangeProtocol >) - growMinBy:MaxBy:
 Multiplies min and max values of current range. More...
 
(id< SCIRangeProtocol >) - clipTo:
 Clips range to maximum range. More...
 
(BOOL) - isValueWithinTheRange:
 Returns true if value is greater than min and lesser than max of range. More...
 
(BOOL) - isDefined
 Returns true if range is defines. More...
 
(BOOL) - equals:
 Compares range instance to another range and returhns true if they are equal. More...
 
(id< SCIRangeProtocol >) - unionWith:
 Returns new range as union of two ranges. More...
 
(id< SCIRangeProtocol >) - unionWithMin:max:
 Performs the union of two com.scichart.data.model.IRange instances. More...
 
(id< SCIRangeProtocol >) - clone
 Creates copy of range. More...
 
(void) - assertMinLessOrEqualToThanMax
 Check if min lesser than max and throw exception if not. More...
 
(id< SCIRangeProtocol >) - growMinBy:MaxBy:isLogarithmic:LogBase:
 Enlarges current range with logarithmic scaling. More...
 

Properties

SCIGenericType min
 Gets or sets min value for range. More...
 
SCIGenericType max
 Gets or sets max value for range. More...
 

Detailed Description

Defines protcol for ranges.

Range is defined by min, max values and type

Method Documentation

◆ __deprecated_msg()

- ("Please use minAsDouble and maxAsDouble instead") __deprecated_msg

Converts range to SCIDoubleRange.

See also
SCIDoubleRange

◆ assertMinLessOrEqualToThanMax()

- (void) assertMinLessOrEqualToThanMax

Check if min lesser than max and throw exception if not.

◆ clipTo:()

- (id<SCIRangeProtocol>) clipTo: (id< SCIRangeProtocol >)  maximumRange

Clips range to maximum range.

Return self

◆ clone()

- (id<SCIRangeProtocol>) clone

Creates copy of range.

◆ diff()

- (SCIGenericType) diff

Returns difference between max and min values.

See also
SCIGenericType

◆ equals:()

- (BOOL) equals: (__unsafe_unretained id< SCIRangeProtocol >)  otherRange

Compares range instance to another range and returhns true if they are equal.

◆ growMinBy:MaxBy:()

- (id<SCIRangeProtocol>) growMinBy: (SCIGenericType min
MaxBy: (SCIGenericType max 

Multiplies min and max values of current range.

Returns self

Parameters
minmin multiplier
maxmax multiplier

◆ growMinBy:MaxBy:isLogarithmic:LogBase:()

- (id<SCIRangeProtocol>) growMinBy: (SCIGenericType minFraction
MaxBy: (SCIGenericType maxFraction
isLogarithmic: (BOOL)  isLogarithmic
LogBase: (double)  logBase 

Enlarges current range with logarithmic scaling.

◆ isDefined()

- (BOOL) isDefined

Returns true if range is defines.

Usually it means that max greater than min and min and max is not NaN

◆ isMinMaxValid()

- (BOOL) isMinMaxValid

Gets whether the min and max value are valid ( min <= max )

◆ isValueWithinTheRange:()

- (BOOL) isValueWithinTheRange: (SCIGenericType value

Returns true if value is greater than min and lesser than max of range.

◆ isZero()

- (BOOL) isZero

Return true if difference between max and min is zero.

◆ maxAsDouble()

- (double) maxAsDouble

Gets the double representation of max value.

Returns
The double representation of max value.

◆ minAsDouble()

- (double) minAsDouble

Gets the double representation of min value.

Returns
The double representation of min value.

◆ rangeType()

- (SCIRangeType) rangeType
required

Returns range type (numeric, date time or index)

See also
SCIRangeType

◆ setMinTo:MaxTo:()

- (void) setMinTo: (SCIGenericType min
MaxTo: (SCIGenericType max 

Method sets min and max values for range.

See also
SCIGenericType

◆ setMinTo:MaxTo:WithLimits:()

- (void) setMinTo: (SCIGenericType min
MaxTo: (SCIGenericType max
WithLimits: (id< SCIRangeProtocol >)  limits 

Method sets min and max values for range and clips values to limits.

Parameters
minSCIGenericType min value
maxSCIGenericType max value @limits SCIRange resulting min and max can not be out of this range
See also
SCIGenericType

◆ unionWith:()

- (id<SCIRangeProtocol>) unionWith: (__unsafe_unretained id< SCIRangeProtocol >)  range

Returns new range as union of two ranges.

Min is minimal from two ranges and max is maximal from two ranges

◆ unionWithMin:max:()

- (id<SCIRangeProtocol>) unionWithMin: (SCIGenericType min
max: (SCIGenericType max 

Performs the union of two com.scichart.data.model.IRange instances.

Parameters
minThe min value.
maxThe max value.

Property Documentation

◆ max

- (SCIGenericType) max
readwritenonatomicassign

Gets or sets max value for range.

See also
SCIGenericType

◆ min

- (SCIGenericType) min
readwriterequirednonatomicassign

Gets or sets min value for range.

See also
SCIGenericType

The documentation for this protocol was generated from the following file: