Class ParameterGroup

Namespace

Geotab.Checkmate.ObjectModel.Engine

Assembly

Geotab.Checkmate.ObjectModel.dll

Standard Parameter Group Number (PGN). Where there is no parameter group it is represented by "ParameterGroupNoneId".

[ReportClass]
public class ParameterGroup : NameEntity, IEntity, IComparable, IIdentifiable

Inheritance

object

Entity

NameEntity

ParameterGroup

Implements

IEntity

IComparable

IIdentifiable

Derived

ParameterGroupNone

Inherited Members

NameEntity.CompareTo(object)

NameEntity.ToString()

Entity.GetReadOnly()

Entity.IsSystemEntity()

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

ParameterGroup()

Initializes a new instance of the ParameterGroup class. Initializes a new instance of the ParameterGroup class.

public ParameterGroup()

ParameterGroup(ParameterGroup)

Initializes a new instance of the ParameterGroup class. Copy constructor - initializes a new instance of the ParameterGroup class.

protected ParameterGroup(ParameterGroup parameterGroup)

Parameters

parameterGroup ParameterGroup

The PGN.

ParameterGroup(Id?, int?, string?, byte?)

Initializes a new instance of the ParameterGroup class. Initializes a new instance of the ParameterGroup class.

public ParameterGroup(Id? id, int? code, string? name, byte? dataLength)

Parameters

id Id

The. Id

code int?

The code of the PGN.

name string

The name of the PGN.

dataLength byte?

The data length of the PGN.

Properties

Code

Gets or sets the unique code of the PGN.

public int? Code { get; set; }

Property Value

int?

int

DataLength

Gets or sets the total length in bytes of the PGN.

public byte? DataLength { get; set; }

Property Value

byte?

Nullable<T> where T is. byte

Id

Gets or sets the unique identifier for this entity.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.ParameterGroupId })]
public override Id? Id { get; set; }

Property Value

Id

Id

Name

Gets or sets the name of this entity which identifies it and is used when displaying this entity.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.ParameterGroupName })]
public override string? Name { get; set; }

Property Value

string

string

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.

Equals(object?)

Compares two objects and returns whether they are equal or not.

public override bool Equals(object? obj)

Parameters

obj object

Object to compare to.

Returns

bool

Whether two objects are equal or not.

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.

SystemFromId(Id?)

Returns a system parameter group from the provided system Id else null if its a not a system parameter group.

public static ParameterGroup? SystemFromId(Id? id)

Parameters

id Id

The id.

Returns

ParameterGroup

The ParameterGroup from Id.