com.anylogic.engine

Enum AreaUnits

java.lang.Object

java.lang.Enum<AreaUnits>

com.anylogic.engine.AreaUnits

All Implemented Interfaces:

IUnits<AreaUnits>, java.io.Serializable, java.lang.Comparable<AreaUnits>

public enum AreaUnits
extends java.lang.Enum<AreaUnits>
implements IUnits<AreaUnits>

Standard AnyLogic area units, should be used in specific functions and parameters which work with units.

Author:

AnyLogic North America, LLC https://anylogic.com

Enum Constant Summary

Enum Constants

Enum Constant and Description
SQ_CENTIMETER Square centimeter
SQ_FOOT Square foot
SQ_INCH Square inch
SQ_KILOMETER Square kilometer
SQ_METER Square meter
SQ_MILE Square mile
SQ_MILLIMETER Square millimeter
SQ_NAUTICAL_MILE Square nautical mile
SQ_YARD Square yard

Field Summary

Fields inherited from interface com.anylogic.engine.IUnits

ALL_UNIT_TYPES

Method Summary

Modifier and Type	Method and Description
double	convertTo(double value, AreaUnits units) Converts the given value from this units to the given units
LengthUnits	getLengthUnits()
java.lang.String	getName() Returns human-readable name (e.g.
double	modifier(AreaUnits units)
static AreaUnits	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AreaUnits[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.anylogic.engine.IUnits

name

Enum Constant Detail

SQ_MILLIMETER

public static final AreaUnits SQ_MILLIMETER

Square millimeter

SQ_CENTIMETER

public static final AreaUnits SQ_CENTIMETER

Square centimeter

SQ_METER

public static final AreaUnits SQ_METER

Square meter

SQ_KILOMETER

public static final AreaUnits SQ_KILOMETER

Square kilometer

SQ_INCH

public static final AreaUnits SQ_INCH

Square inch

SQ_FOOT

public static final AreaUnits SQ_FOOT

Square foot

SQ_YARD

public static final AreaUnits SQ_YARD

Square yard

SQ_MILE

public static final AreaUnits SQ_MILE

Square mile

SQ_NAUTICAL_MILE

public static final AreaUnits SQ_NAUTICAL_MILE

Square nautical mile

Method Detail

values

public static AreaUnits[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AreaUnits c : AreaUnits.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AreaUnits valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getLengthUnits

public LengthUnits getLengthUnits()

getName

public java.lang.String getName()

Description copied from interface: IUnits

Returns human-readable name (e.g. "meters per second")

Specified by:

getName in interface IUnits<AreaUnits>

modifier

public double modifier(AreaUnits units)

Specified by:

modifier in interface IUnits<AreaUnits>

convertTo

public double convertTo(double value,
                        AreaUnits units)

Description copied from interface: IUnits

Converts the given value from this units to the given units

Specified by:

convertTo in interface IUnits<AreaUnits>

Parameters:

value - the value, measured in this units

units - units to convert the value to

Returns:

the value, measured in the given units