Class ConfigFile

Parses the contents of configuration files such as config.csv, .factory_config, and .assembly_config.

Hierarchy

ConfigFile

Index

Constructors

Properties

apiId? content file? firmwareVersion? header? parameters parseResult?

Accessors

containsSmmParameters firmwareId hasParseErrors numberOfParameters

Methods

requiresSmmSetupWizard toString

Constructors

constructor

new ConfigFile(content: string, file?: Pick<File, "name" | "type" | "size" | "lastModified">): ConfigFile
Parameters
- content: string
- Optional file: Pick<File, "name" | "type" | "size" | "lastModified">
Returns ConfigFile
- Defined in libs/motion-master-client/src/lib/config-file.ts:46

Properties

`Optional` `Readonly` apiId

apiId?: string

`Readonly` content

content: string

`Optional` `Readonly` file

file?: Pick<File, "name" | "type" | "size" | "lastModified">

`Optional` `Readonly` firmwareVersion

firmwareVersion?: string

`Optional` `Readonly` header

header?: string

parameters

parameters: ConfigParameter[]

`Optional` `Readonly` parseResult

parseResult?: ParseResult<string[]>

Accessors

containsSmmParameters

get containsSmmParameters(): boolean
Whether the file carries any safety parameter. Says nothing about how it has to be loaded — see requiresSmmSetupWizard for that.

Returns boolean
- Defined in libs/motion-master-client/src/lib/config-file.ts:96

firmwareId

get firmwareId(): undefined | string
Returns undefined | string
- Defined in libs/motion-master-client/src/lib/config-file.ts:88

hasParseErrors

get hasParseErrors(): boolean
Returns boolean
- Defined in libs/motion-master-client/src/lib/config-file.ts:111

numberOfParameters

get numberOfParameters(): number
Returns number
- Defined in libs/motion-master-client/src/lib/config-file.ts:115

Methods

requiresSmmSetupWizard

requiresSmmSetupWizard(deviceSupportsSafetyModule: boolean): boolean
Whether this file has to be loaded through the SMM Setup Wizard on a device that keeps its safety configuration on a detachable module. See requiresSmmSetupWizard.
Parameters
- deviceSupportsSafetyModule: boolean
Returns boolean
- Defined in libs/motion-master-client/src/lib/config-file.ts:104

toString

toString(): string
Returns string
- Defined in libs/motion-master-client/src/lib/config-file.ts:119

Generated using TypeDoc