OpenStrat
API
Generated with
OpenStrat/ostrat/ostrat.geom/Kilometres

Kilometres

ostrat.geom.Kilometres
See theKilometres companion object
final class Kilometres(val kilometresNum: Double) extends AnyVal, LengthMetric

Measurement of Length in Kilometres. can be negative.

Attributes

Companion
object
Graph
Supertypes
trait LengthMetric
trait TellDblBased
trait Tell
trait Persist
trait MetricUnits
trait Length
trait Ordered[Length]
trait Comparable[Length]
class Object
class AnyVal
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def *(operand: Length): Kilares
Implicitly added by LengthMetricExtensions

Extension operator method to produce Kilares, multiplying this Kilometres by an operand Length.

Extension operator method to produce Kilares, multiplying this Kilometres by an operand Length.

Attributes

override def *(operand: Double): Kilometres

Multiply by the given scalar.

Multiply by the given scalar.

Attributes

Definition Classes
override def +(operand: Length): Kilometres

Add a Length defined in Length units. Use addLength method if you wish to mix units from different unit measurement systems.

Add a Length defined in Length units. Use addLength method if you wish to mix units from different unit measurement systems.

Attributes

Definition Classes
override def -(operand: Length): Kilometres

Subtract a Length defined in LengthMetric units. Use subLength method if you wish to mix units from different unit measurement systems.

Subtract a Length defined in LengthMetric units. Use subLength method if you wish to mix units from different unit measurement systems.

Attributes

Definition Classes
override def /(operand: Double): Kilometres

Divide by the given scalar.

Divide by the given scalar.

Attributes

Definition Classes
override def compare(that: Length): Int

Attributes

Definition Classes
override def divByLength(operand: Length): Double

Attributes

Definition Classes
override def endingStr: String

Attributes

Definition Classes
override def gigametresNum: Double

The number of gigametres in this Length.

The number of gigametres in this Length.

Attributes

Definition Classes
override def max(operand: LengthMetric): Kilometres

Returns the max length of this and the operand length in the units of this object.

Returns the max length of this and the operand length in the units of this object.

Attributes

Definition Classes
override def megametresNum: Double

The number of megametres in this Length.

The number of megametres in this Length.

Attributes

Definition Classes
override def metresNum: Double

The number of metres in this Length.

The number of metres in this Length.

Attributes

Definition Classes
override def min(operand: LengthMetric): Kilometres

Returns the max length of this and the operand length in the units of this object.

Returns the max length of this and the operand length in the units of this object.

Attributes

Definition Classes
override def mulByLength(operand: Length): Kilares

Multiply by another Length to produce an area.

Multiply by another Length to produce an area.

Attributes

Definition Classes
override def neg: Boolean

Attributes

Definition Classes
override def nonNeg: Boolean

Is the length units greater or equal to zero.

Is the length units greater or equal to zero.

Attributes

Definition Classes
override def pos: Boolean

Attributes

Definition Classes
override def typeStr: String

The type of the object to be persisted.

The type of the object to be persisted.

Attributes

Definition Classes
override def unary_-: Kilometres

The negative of this Length

The negative of this Length

Attributes

Definition Classes
override def unitsDbl: Double

Attributes

Definition Classes

Inherited methods

def <(that: Length): Boolean

Attributes

Inherited from:
Ordered
def <=(that: Length): Boolean

Attributes

Inherited from:
Ordered
def >(that: Length): Boolean

Attributes

Inherited from:
Ordered
def >=(that: Length): Boolean

Attributes

Inherited from:
Ordered
def compareTo(that: Length): Int

Attributes

Inherited from:
Ordered
override def str: String

The most basic Show method, paralleling the strT method on ShowT type class instances.

The most basic Show method, paralleling the strT method on ShowT type class instances.

Attributes

Definition Classes
Inherited from:
TellDblBased
def str0: String

Show with decimal precision of 0 places.

Show with decimal precision of 0 places.

Attributes

Inherited from:
Tell
def str1: String

Show with decimal precision of 1 place padding with a zero if necessary.

Show with decimal precision of 1 place padding with a zero if necessary.

Attributes

Inherited from:
Tell
def str2: String

Show with decimal precision of 2 places padding with zeros if necessary.

Show with decimal precision of 2 places padding with zeros if necessary.

Attributes

Inherited from:
Tell
def str3: String

Show with decimal precision of 3 places padding with zeros if necessary.

Show with decimal precision of 3 places padding with zeros if necessary.

Attributes

Inherited from:
Tell
override def tell(style: ShowStyle, maxPlaces: Int, minPlaces: Int): String

Intended to be a multiple parameter comprehensive Show method. Intended to be paralleled by show method on Show type class instances.

Intended to be a multiple parameter comprehensive Show method. Intended to be paralleled by show method on Show type class instances.

Attributes

Definition Classes
Inherited from:
TellDblBased
override def tellDepth: Int

The syntactic depth of the tell String for this object.

The syntactic depth of the tell String for this object.

Attributes

Definition Classes
Inherited from:
TellDblBased
def toKiloMetres: Kilometres

Converts this Length to Metres.

Converts this Length to Metres.

Attributes

Inherited from:
Length
def toMetres: Metres

Converts this Length to Metres.

Converts this Length to Metres.

Attributes

Inherited from:
Length
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
TellDblBased -> Tell -> Any
Inherited from:
TellDblBased
def useMultiple: Boolean

This property determines if the type can be used with Multiple syntax.

This property determines if the type can be used with Multiple syntax.

MyObj * 7

. for describing sequences succinctly. This is not desirable for some types such as numerical and mathematical vector types as this could be confusing 3 * 4 should resolve to an Int of value 12, not a Multiple(3, 4).

Attributes

Inherited from:
Persist

Concrete fields

val kilometresNum: Double

The number of kilometres in this Length.

The number of kilometres in this Length.

Attributes

Generated with