Table of Contents

Class DemoConfiguration

Namespace
Geotab.Checkmate.ObjectModel.Demonstration
Assembly
Geotab.Checkmate.ObjectModel.dll

The configuration of a demo database.

public record DemoConfiguration : IEquatable<DemoConfiguration>
Inheritance
DemoConfiguration
Implements
Inherited Members

Constructors

DemoConfiguration() 

public DemoConfiguration()

DemoConfiguration(DemoConfiguration) 

protected DemoConfiguration(DemoConfiguration original)

Parameters

original DemoConfiguration

Fields

MaxValidHoursToExpiry

The maximum amount of hours to be added to the DemoExpiryDate.

public const int MaxValidHoursToExpiry = 4380

Field Value

int

MaxValidVehicleCount

The maximum number of vehicles for a demo.

public const int MaxValidVehicleCount = 1000

Field Value

int

Properties

CreationDate

Gets or sets the date the database was created. Default [DateTime.UtcNow].

public DateTime? CreationDate { get; set; }

Property Value

DateTime?

DateTime

DatabaseRetentionPeriod

Gets or sets the retention period for the demo database.

public DatabaseMaintenancePeriod? DatabaseRetentionPeriod { get; set; }

Property Value

DatabaseMaintenancePeriod?

int

EqualityContract 

protected virtual Type EqualityContract { get; }

Property Value

Type

FleetComposition

Gets or sets the FleetComposition of the demo.

public FleetComposition? FleetComposition { get; set; }

Property Value

FleetComposition

FleetComposition

HoursToExpiry

Gets or sets the number of hours before the demo expires. Default [int.Max].

[Obsolete("No longer needed, using DatabaseRetentionPeriod instead.")]
public int? HoursToExpiry { get; set; }

Property Value

int?

int

VehicleCount

Gets or sets the number of vehicles to simulate in the demo. Default [1] Maximum [1000].

public int? VehicleCount { get; set; }

Property Value

int?

int

Methods

ConvertDemoDatabaseRetentionPeriodToInt()

Convert hours to supported DatabaseMaintenancePeriod.

public int ConvertDemoDatabaseRetentionPeriodToInt()

Returns

int

The DatabaseRetentionPeriod.

ConvertToDemoDatabaseRetentionPeriod(int)

Convert hours to supported DatabaseMaintenancePeriod.

public static DatabaseMaintenancePeriod ConvertToDemoDatabaseRetentionPeriod(int hours)

Parameters

hours int

The hours value.

Returns

DatabaseMaintenancePeriod

The DatabaseRetentionPeriod.

Equals(DemoConfiguration?) 

public virtual bool Equals(DemoConfiguration? other)

Parameters

other DemoConfiguration

Returns

bool

Equals(object?) 

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

ExpirationDate()

The expiration date of the database.

public DateTime? ExpirationDate()

Returns

DateTime?

The expiration DateTime.

GetHashCode() 

public override int GetHashCode()

Returns

int

IsDatabaseRetentionPeriodValid(DatabaseMaintenancePeriod)

Checks if a DatabaseMaintenancePeriod is valid for use in DemoConfiguration.

public static bool IsDatabaseRetentionPeriodValid(DatabaseMaintenancePeriod databaseRetentionPeriod)

Parameters

databaseRetentionPeriod DatabaseMaintenancePeriod

The DatabaseMaintenancePeriod.

Returns

bool

True if valid, otherwise False.

IsEnabled()

Checks if the demo is enabled.

public bool IsEnabled()

Returns

bool

True if expired.

IsExpired()

Checks if the demo is expired.

public bool IsExpired()

Returns

bool

True if expired.

PrintMembers(StringBuilder) 

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString() 

public override string ToString()

Returns

string

Operators

operator ==(DemoConfiguration?, DemoConfiguration?) 

public static bool operator ==(DemoConfiguration? left, DemoConfiguration? right)

Parameters

left DemoConfiguration
right DemoConfiguration

Returns

bool

operator !=(DemoConfiguration?, DemoConfiguration?) 

public static bool operator !=(DemoConfiguration? left, DemoConfiguration? right)

Parameters

left DemoConfiguration
right DemoConfiguration

Returns

bool