EikonalWorks User's Manual
  • Workbench
  • IntensityView
  • Core Calculations
Search Results for

    Show / Hide Table of Contents
    • Overview and Client Examples
    • Complete Agent Reference
    • File Input and Output
      • OpenFile
      • SaveFile
      • RemoveLid
    • Queries
      • GetParameter
      • GetProperty
      • GetPropertyField
    • Properties and Flux
      • SetProperty
      • SetLuminousFlux
      • SetLampFlux
      • SetLampNumber
      • SetInputPower
      • SetEmitterLOR
      • SetPhotometryUnit
    • Photometric Transforms
      • SetSymmetryData
      • SetResolution
      • RotateEuler
      • RotateQuaternion
      • Scale
      • AutoAlignPhotometry
      • Smoothen
    • Geometry
      • SetGeometry
    • Luminaire and Channel Management
      • ConfigureLuminaire
      • DuplicateLuminaire
      • MoveMesh
      • RemoveMesh
      • Combine
    • Map Modification
      • PaintBrush
      • FillSelection
      • ScaleAdd
      • CloneTool
      • ApplyTransform
    • Roadway Scenarios
      • LoadRoadwayScenarioFile
      • SaveRoadwayScenarioFile
    • View
      • SetCoordinateSystem
    • Session and History
      • Undo
      • Redo
      • StartCommandServer
      • StopCommandServer

    SetProperty

    Set a typed metadata field on one or more intensity models.

    Undo support: Registered as undoable; see limitations below.

    Syntax

    SetProperty <fieldName> <emitterId> [<emitterId> ...] -> <value>
    

    Parameters

    Use the exact internal field name. Strings can be quoted; numeric values must fit the field range; booleans accept true/false, yes/no, 1/0 or on/off; enumerations require an exact choice. Lists use semicolon-separated entries; key/value lists use key=value; dates use the date field format; images use an existing file path.

    Example

    SetProperty Manufacturer 12 -> "Example Optics"
    

    Example IDs are placeholders; replace them with IDs from your current session.

    Response

    OK after applying; parser/type errors report ERROR. Missing targets or fields can be skipped; verify with GetPropertyField.

    Notes

    Nullable numeric, date and image fields accept clear, remove, none or null. These words are literal text for string fields. Empty quoted strings are discarded by the command tokenizer. Document-level fields affect the parent document.

    Implementation: EikonalWorksTools/EWIntensityView/src/actions/edit/SetPropertyFieldAction.h.

    See API connection, grammar and client examples for quoting, error handling and model IDs.

    In this article
    Back to top Generated by DocFX