Class AssetUtilizationPreset

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

The preset for the asset utilization report.

public class AssetUtilizationPreset : NameEntity, IEntity, IComparable, IIdentifiable

Inheritance

object

Entity

NameEntity

AssetUtilizationPreset

Implements

IEntity

IComparable

IIdentifiable

Inherited Members

NameEntity.CompareTo(object)

NameEntity.ToString()

NameEntity.Name

Entity.GetReadOnly()

Entity.Equals(object)

Entity.GetHashCode()

Entity.IsSystemEntity()

Entity.Id

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Remarks

Initializes a new instance of the AssetUtilizationPreset class.

Constructors

AssetUtilizationPreset(AssetUtilizationPreset)

Initializes a new instance of the AssetUtilizationPreset class.

protected AssetUtilizationPreset(AssetUtilizationPreset assetUtilizationPreset)

Parameters

assetUtilizationPreset AssetUtilizationPreset

The preset for the asset utilization.

AssetUtilizationPreset(Id)

Initializes a new instance of the AssetUtilizationPreset class.

public AssetUtilizationPreset(Id id)

Parameters

id Id

The Id.

AssetUtilizationPreset(Id?, string?, bool, DayOfWeek[]?, int[]?, int, bool, double?, double, double, double?, double?)

Initializes a new instance of the AssetUtilizationPreset class.

public AssetUtilizationPreset(Id? id, string? name, bool isDefault, DayOfWeek[]? daysOfWeek, int[]? months, int utilizationTimeMax, bool isIdlingExcluded, double? distance, double underUtilizationThreshold, double overUtilizationThreshold, double? optimalUtilizationMin, double? optimalUtilizationMax)

Parameters

id Id

The Id.

name string

The preset name.

isDefault bool

IsDefault

daysOfWeek DayOfWeek[]

DaysOfWeek

months int[]

Months

utilizationTimeMax int

UtilizationTimeMax

isIdlingExcluded bool

IsIdlingExcluded

distance double?

Distance

underUtilizationThreshold double

UnderUtilizationThreshold

overUtilizationThreshold double

OverUtilizationThreshold

optimalUtilizationMin double?

OptimalUtilizationMin

optimalUtilizationMax double?

OptimalUtilizationMax

Properties

DaysOfWeek

Gets or sets the days of week as a preset filter.

public DayOfWeek[]? DaysOfWeek { get; set; }

Property Value

DayOfWeek[]

0 represents Sunday, 1 Monday and so on.

Distance

Gets or sets the distance in meters per month as denominator to calculate utilization.

public double? Distance { get; set; }

Property Value

double?

double

IsDefault

Gets or sets a value indicating whether the preset is default.

public bool IsDefault { get; set; }

Property Value

bool

true if the preset is default; otherwise, false.

IsIdlingExcluded

Gets or sets a value indicating whether the idling will be excluded from the utilization data presented in the report.

public bool IsIdlingExcluded { get; set; }

Property Value

bool

true if the idling is excluded; otherwise, false.

Months

Gets or sets the months as a preset filter.

public int[]? Months { get; set; }

Property Value

int[]

1 represents January, 2 February and so on.

OptimalUtilizationMax

Gets or sets the upper bound of the optimal utilization.

public double? OptimalUtilizationMax { get; set; }

Property Value

double?

double maximum percentage value of the optimal utilization. Database default is 100.

OptimalUtilizationMin

Gets or sets the lower bound of the optimal utilization.

public double? OptimalUtilizationMin { get; set; }

Property Value

double?

double minimum percentage value of the optimal utilization. Database default is 10.

OverUtilizationThreshold

Gets or sets the threshold to determine if an asset is over-utilized.

public double OverUtilizationThreshold { get; set; }

Property Value

double

double value for a percentage above which an asset is considered over-utilized.

UnderUtilizationThreshold

Gets or sets the threshold to determine if an asset is underutilized.

public double UnderUtilizationThreshold { get; set; }

Property Value

double

double value for a percentage under which an asset is considered underutilized.

UtilizationTimeMax

Gets or sets the maximum hours as denominator to calculate the utilization.

public int UtilizationTimeMax { get; set; }

Property Value

int

between 1 and 24. Database default is 24.

Methods

Clone()

Creates a new object that is a copy of the current instance.

public override IEntity Clone()

Returns

IEntity

A new object that is a copy of this instance.