Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UnitSettings

Settings that define which units will be used when data is exported in summary or statistics files. All units are optional with application defaults being used for anything that isn't specified.

Hierarchy

  • UnitSettings

Index

Properties

alternateDistanceOutput

alternateDistanceOutput: DistanceUnit = DistanceUnit.DEFAULT

Alternate units for displaying distances.

alternateVelocityOutput

alternateVelocityOutput: VelocityUnit = new VelocityUnit()

An alternate unit for displaying velocity.

angleOutput

angleOutput: AngleUnit = AngleUnit.DEFAULT

Units for displaying angles.

areaOutput

areaOutput: AreaUnit = AreaUnit.DEFAULT

Units for displaying areas.

coordinateOutput

coordinateOutput: CoordinateUnit = CoordinateUnit.DEFAULT

Units for displaying coordinates.

distanceOutput

distanceOutput: DistanceUnit = DistanceUnit.DEFAULT

Units for displaying distances.

energyOutput

energyOutput: EnergyUnit = EnergyUnit.DEFAULT

Units for displaying energy.

intensityOutput

intensityOutput: IntensityUnit = new IntensityUnit()

Units for displaying fire intensity.

massAreaOutput

massAreaOutput: MassAreaUnit = new MassAreaUnit()

Units for displaying mass.

massOutput

massOutput: MassUnit = MassUnit.DEFAULT

Units for displaying mass or weight.

smallDistanceOutput

smallDistanceOutput: DistanceUnit = DistanceUnit.DEFAULT

Units for displaying small distances.

smallMeasureOutput

smallMeasureOutput: DistanceUnit = DistanceUnit.DEFAULT

Units for displaying small distance measurements.

temperatureOutput

temperatureOutput: TemperatureUnit = TemperatureUnit.DEFAULT

Units for displaying temperature.

velocityOutput

velocityOutput: VelocityUnit = new VelocityUnit()

Units for displaying velocity.

volumeOutput

volumeOutput: VolumeUnit = VolumeUnit.DEFAULT

Units for displaying volumes.

Static Private Readonly PARAM_UNITS

PARAM_UNITS: "export_units" = "export_units"

Methods

checkValid

  • Find all errors that may exist in the unit settings.

    Returns Array<ValidationError>

    A list of all errors that were found.

stream

  • stream(builder: Socket): void
  • Streams the attachment to a socket.

    Parameters

    • builder: Socket

    Returns void