Interface CanIdentifierGeneratorControlProps

Properties of the CanIdentifierGeneratorControl React component.

interface CanIdentifierGeneratorControlProps {
    canIdentifier: string;
    canIdentifierGeneratorSettingsError?: MutableRefObject<boolean>;
    canIdentifierType: canIdentifierType;
    collapsed?: boolean;
    collapsedChange?: (value: boolean) => void;
    collapsible?: boolean;
    disabled?: boolean;
    identifierGeneratorType: canIdentifierGeneratorType;
    maxCanIdentifier: string;
    minCanIdentifier: string;
    onChange: (
        newCanIdentifier: string,
        newIdentifierGeneratorType: canIdentifierGeneratorType,
        newMinCanIdentifier: string,
        newMaxCanIdentifier: string,
        newIdentifierType: canIdentifierType,
    ) => void;
    onErrorsChange?: (errors: boolean) => void;
    showSelectMessageDialogChange: (value: boolean) => void;
    showSignalValuesTable: (value: boolean) => void;
}

Properties

canIdentifier canIdentifierGeneratorSettingsError? canIdentifierType collapsed? collapsedChange? collapsible? disabled? identifierGeneratorType maxCanIdentifier minCanIdentifier onChange onErrorsChange? showSelectMessageDialogChange showSignalValuesTable

Properties

canIdentifier

canIdentifier: string

The CAN identifier.

OptionalcanIdentifierGeneratorSettingsError

canIdentifierGeneratorSettingsError?: MutableRefObject<boolean>

The current error state.

canIdentifierType

canIdentifierType: canIdentifierType

The CAN identifier type that will be used, 'extended' or 'standard'.

Optionalcollapsed

collapsed?: boolean

Current collapse state of the SectionControl.

OptionalcollapsedChange

collapsedChange?: (value: boolean) => void

Callback that will be called when collapse state has changed.

Type declaration

    • (value: boolean): void

    • Parameters

      • value: boolean

        The new collapse state.

      Returns void

Optionalcollapsible

collapsible?: boolean

Set to true if the SectionControl should be collapsible.

Optionaldisabled

disabled?: boolean

Set to true to disable this control.

identifierGeneratorType

identifierGeneratorType: canIdentifierGeneratorType

The generator type: 'constant' | 'random' | 'scan' 'constant': The CAN identifier set to canIdentifier will be used for all generated messages. 'random': A random CAN identifier between minCanIdentifier and maxCanIdentifier will be used. 'scan': A CAN identifier will be picked from minCanIdentifier to maxCanIdentifier.

maxCanIdentifier

maxCanIdentifier: string

The max CAN identifier that will be used if identifierGeneratorType is 'random' or 'scan'.

minCanIdentifier

minCanIdentifier: string

The min CAN identifier that will be used if identifierGeneratorType is 'random' or 'scan'.

onChange

onChange: (
    newCanIdentifier: string,
    newIdentifierGeneratorType: canIdentifierGeneratorType,
    newMinCanIdentifier: string,
    newMaxCanIdentifier: string,
    newIdentifierType: canIdentifierType,
) => void

Callback that will be called when the CAN identifier(s) has changed.

Type declaration

    • (
          newCanIdentifier: string,
          newIdentifierGeneratorType: canIdentifierGeneratorType,
          newMinCanIdentifier: string,
          newMaxCanIdentifier: string,
          newIdentifierType: canIdentifierType,
      ): void

    • Parameters

      • newCanIdentifier: string

        The new constant CAN identifier.

      • newIdentifierGeneratorType: canIdentifierGeneratorType

        The new generator type.

      • newMinCanIdentifier: string

        The new min CAN identifier.

      • newMaxCanIdentifier: string

        The new max CAN identifier.

      • newIdentifierType: canIdentifierType

      Returns void

OptionalonErrorsChange

onErrorsChange?: (errors: boolean) => void

Callback that will be called when the errors state has changed.

Type declaration

    • (errors: boolean): void

    • Parameters

      • errors: boolean

        The new errors state.

      Returns void

showSelectMessageDialogChange

showSelectMessageDialogChange: (value: boolean) => void

Callback for specifying if the select message dialog should be visible.

showSignalValuesTable

showSignalValuesTable: (value: boolean) => void

Callback for specifying if the signal values table should be visible.

Settings

Member Visibility

On This Page

Properties