SettingsManagerService

public struct SettingsManagerService : Codable, Equatable

A struct that is used as the top level container of a model used to decode Settings JSON data.

The struct matches the structure of the Settings JSON exactly and is not currently used to service a struct that models the JSON differently. It embeds nested structs representing arrays in the JSON data.

Note

Unlike the other JSON service structs in the framework this struct names the properties the same as the keys in the JSON to avoid the requirement for CodingKey enums. The simplicity of the Settings JSON structure allows the struct to take advantage of the Codable protocol automatic key generation feature.

The properties are settable variables so that settings can be changed programmatically during the run of a client application – this feature is designed specifically for use during unit testing.

  • A Bool mapped to the suppressAllClarityLogs key in the Settings JSON data.

    Declaration

    Swift

    var suppressAllClarityLogs: Bool

  • A Bool mapped to the printAllClarityLogs key in the Settings JSON data

    Declaration

    Swift

    var printAllClarityLogs: Bool

  • A Bool mapped to the logFunctionNamesOnly key in the Settings JSON data

    Declaration

    Swift

    var logFunctionNamesOnly: Bool

  • A Bool mapped to the logIsolatedPrintNumbersOnly key in the Settings JSON data

    Declaration

    Swift

    var logIsolatedPrintNumbersOnly: Bool

  • A Bool mapped to the isolatedPrintNumbers key in the Settings JSON data

    Declaration

    Swift

    var isolatedPrintNumbers: [Int]

  • A Bool mapped to the suppressLogFunctionNames key in the Settings JSON data

    Declaration

    Swift

    var suppressLogFunctionNames: Bool

  • A Bool mapped to the isolatedEntities key in the Settings JSON data

    Declaration

    Swift

    var isolatedEntities: [IsolatedEntity]

  • A Bool mapped to the isolatedFunctions key in the Settings JSON data

    Declaration

    Swift

    var isolatedFunctions: [IsolatedFunction]

  • A Bool mapped to the calculateFunctionNumbersRelativeToEntity key in the Settings JSON data

    Declaration

    Swift

    var calculateFunctionNumbersRelativeToEntity: Bool

  • A Bool mapped to the calculateNodeNumbersRelativeToFunction key in the Settings JSON data

    Declaration

    Swift

    var calculateNodeNumbersRelativeToFunction: Bool

  • A Bool mapped to the displayNodePrintNumberWhenUsingRelativeNumbering key in the Settings JSON data

    Declaration

    Swift

    var displayNodePrintNumberWhenUsingRelativeNumbering: Bool

  • A Bool mapped to the displayNodeSequenceWithoutDescriptions key in the Settings JSON data

    Declaration

    Swift

    var displayNodeSequenceWithoutDescriptions: Bool

  • A Bool mapped to the listAllUsedPrintNumbers key in the Settings JSON data

    Declaration

    Swift

    var listAllUsedPrintNumbers: Bool

  • A Bool mapped to the listAllUsedPrintNumbersByEntityCode key in the Settings JSON data

    Declaration

    Swift

    var listAllUsedPrintNumbersByEntityCode: Bool

  • A Bool mapped to the listHighestUsedPrintNumber key in the Settings JSON data

    Declaration

    Swift

    var listHighestUsedPrintNumber: Bool

  • A Bool mapped to the alertOrphanedPrintNumbersDetected key in the Settings JSON data

    Declaration

    Swift

    var alertOrphanedPrintNumbersDetected: Bool

  • A struct embedded inside an SettingsManagerService struct that is used as a nested layer within an intermediate service model used to decode Settings JSON data.

    The struct models an array of JSON objects mapped to the isolatedEntities key in the Settings JSON data.

    See more

    Declaration

    Swift

    public struct IsolatedEntity : Codable, Equatable

  • A struct embedded inside an SettingsManagerService struct that is used as a nested layer within an intermediate service model used to decode Settings JSON data.

    The struct models an array of JSON objects mapped to the isolatedFunctions key in the Settings JSON data.

    See more

    Declaration

    Swift

    public struct IsolatedFunction : Codable, Equatable