Class CustomParameter

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

A custom parameter extends the parameters already supported by MyGeotab. This enables one to add a parameter to MyGeotab that is not explicitly supported in the user interface.

public class CustomParameter

Inheritance

object

CustomParameter

Derived

ProtobufCustomParameter

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

CustomParameter()

Initializes a new instance of the CustomParameter class.

public CustomParameter()

CustomParameter(string, int, bool, byte[])

Initializes a new instance of the CustomParameter class.

public CustomParameter(string description, int offset, bool isEnabled, byte[] bytes)

Parameters

description string

The description.

offset int

The offset.

isEnabled bool

if set to true [is enabled].

bytes byte[]

The bytes.

Properties

Bytes

Gets or sets the byte values of the parameter starting at offset.

public byte[]? Bytes { get; set; }

Property Value

byte[]

byte buffer.

Description

Gets or sets the description of CustomParameter that is displayed to the user. It does not in any way relate to the data that is actually stored in the parameter itself.

public string? Description { get; set; }

Property Value

string

string

IsEnabled

Gets or sets a value indicating whether enables or disables this parameter. If disabled, the parameter won't be sent and the values 0 will be sent in the buffer.

public bool IsEnabled { get; set; }

Property Value

bool

bool

Offset

Gets or sets the offset into the parameter area where this CustomParameter will be written to.

public int Offset { get; set; }

Property Value

int

int

Methods

Equals(object?)

Determines whether the specified object, is equal to this instance.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with this instance.

Returns

bool

true if the specified object is equal to this instance; otherwise, false.

GetHashCode()

Returns a hash code for this instance.

public override int GetHashCode()

Returns

int

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

IsBitMappedOptionParameter(CustomParameter)

Returns [true] if the custom parameter affects a bitmap options byte or [false] otherwise.

public static bool IsBitMappedOptionParameter(CustomParameter parameter)

Parameters

parameter CustomParameter

The parameter.

Returns

bool

bool

IsDriverBlocklistParameter(CustomParameter)

Checks whether a parameter is a Driver Blacklist parameter.

public static bool IsDriverBlocklistParameter(CustomParameter parameter)

Parameters

parameter CustomParameter

The CustomParameter to check.

Returns

bool

true if the CustomParameter is a Driver Blacklist parameter or. false

IsNotOverlapping(IEnumerable<CustomParameter>)

Validates that the given set of parameters is valid (no overlaps and doesn't collide with known parameters.

public static bool IsNotOverlapping(IEnumerable<CustomParameter> parameters)

Parameters

parameters IEnumerable<CustomParameter>

The parameters.

Returns

bool

true if valid, false otherwise.

IsResetDriverIdAtIgnitionOff(List<CustomParameter>?)

Check if "Reset Driver ID at Ignition Off" parameter is set.

public static bool IsResetDriverIdAtIgnitionOff(List<CustomParameter>? parameters)

Parameters

parameters List<CustomParameter>

The parameters.

Returns

bool

bool