com.nomagic.magicdraw.metrics

Class MetricResult

java.lang.Object

com.nomagic.magicdraw.metrics.MetricResult

@OpenApi
public class MetricResult
extends java.lang.Object

Wrapper for the metricValue. Delegates the methods call to the MetricValue class. Metrics values can be real values that are represented by RealValue or int values using IntegerValue.

Constructor Summary

Constructors

Constructor and Description
MetricResult(float value) Create a new metric result that contains a Real type of value;
MetricResult(int value) Create a new metric result that contains a Integer type of value;
MetricResult(MetricValue value) Creates a MetricResult and set its value to value

Method Summary

Modifier and Type	Method and Description
void	addValue(MetricValue value) Add a value to the metric value
static MetricValue	create(float value) Creates and returns a RealValue type.
static MetricValue	create(int value) Creates and returns a IntegerValue type.
int	getCalculatedElements() Number of elements calculated.
MetricValue	getValue() Return the MetricValue instance
float	getValueAsFloat() Get value as float.
int	getValueAsInteger() Get value as int.
boolean	hasValidResult() Return if it has a validResult.
void	incrementCalculatedElements() Increment the number of elements calculated.
boolean	isAboveLimit() Return if the result is above limit
boolean	isBelowLimit() Return if the result is below limit
boolean	isDifferentFromZero() Compare the value to zero and return a boolean indicating the result In case of null value, returns false;
void	setAboveLimit(boolean aboveLimit) Set to true is value is above Limit
void	setBelowLimit(boolean belowLimit) Set to true is value is above Limit
void	setCalculatedElements(int calculatedElements) Set the number of elements calculated.
void	setMaxValue(MetricValue value, MetricValue value2) Set the value to the maximum value of the two parameters
void	setMinValue(MetricValue value, MetricValue value2) Set the value to the minimum value of the two parameters
void	setValue(float value) Set create an Real type value
void	setValue(int value) Set create an Integer type value
void	setValue(MetricValue value) Set MetricValue to the given value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetricResult

@OpenApi
public MetricResult(MetricValue value)

Creates a MetricResult and set its value to value

Parameters:

value - instance of MetricValue.

MetricResult

@OpenApi
public MetricResult(int value)

Create a new metric result that contains a Integer type of value;

Parameters:

value -

MetricResult

@OpenApi
public MetricResult(float value)

Create a new metric result that contains a Real type of value;

Parameters:

value -

Method Detail

isAboveLimit

@OpenApi
public boolean isAboveLimit()

Return if the result is above limit

Returns:

boolean

setAboveLimit

@OpenApi
public void setAboveLimit(boolean aboveLimit)

Set to true is value is above Limit

Parameters:

aboveLimit -

isBelowLimit

@OpenApi
public boolean isBelowLimit()

Return if the result is below limit

Returns:

boolean

setBelowLimit

@OpenApi
public void setBelowLimit(boolean belowLimit)

Set to true is value is above Limit

Parameters:

belowLimit -

addValue

@OpenApi
public void addValue(MetricValue value)

Add a value to the metric value

Parameters:

value -

getValue

@OpenApi
public MetricValue getValue()

Return the MetricValue instance

Returns:

MetricValue

setValue

@OpenApi
public void setValue(MetricValue value)

Set MetricValue to the given value

Parameters:

value - MetricValue

setValue

@OpenApi
public void setValue(int value)

Set create an Integer type value

Parameters:

value - integer

setValue

@OpenApi
public void setValue(float value)

Set create an Real type value

Parameters:

value - float

setMinValue

@OpenApi
public void setMinValue(MetricValue value,
                                 MetricValue value2)

Set the value to the minimum value of the two parameters

Parameters:

value - MetricValue

value2 - MetricValue

setMaxValue

@OpenApi
public void setMaxValue(MetricValue value,
                                 MetricValue value2)

Set the value to the maximum value of the two parameters

Parameters:

value - MetricValue

value2 - MetricValue

isDifferentFromZero

@OpenApi
public boolean isDifferentFromZero()

Compare the value to zero and return a boolean indicating the result In case of null value, returns false;

Returns:

boolean

getValueAsFloat

@OpenApi
public float getValueAsFloat()

Get value as float. If value is null will return 0;

getValueAsInteger

@OpenApi
public int getValueAsInteger()

Get value as int. If value is null will return 0;

hasValidResult

@OpenApi
public boolean hasValidResult()

Return if it has a validResult. If the value is null returns false.

create

@OpenApi
public static MetricValue create(float value)

Creates and returns a RealValue type.

Parameters:

value - float

create

@OpenApi
public static MetricValue create(int value)

Creates and returns a IntegerValue type.

Parameters:

value - int

setCalculatedElements

@OpenApi
public void setCalculatedElements(int calculatedElements)

Set the number of elements calculated. Used for average mode.

Parameters:

calculatedElements - int

incrementCalculatedElements

@OpenApi
public void incrementCalculatedElements()

Increment the number of elements calculated.

getCalculatedElements

@OpenApi
public int getCalculatedElements()

Number of elements calculated. Used for average mode.

Returns:

int