Class DexpiLayoutConfig

java.lang.Object
neqsim.process.processmodel.dexpi.DexpiLayoutConfig
public final class DexpiLayoutConfig extends Object
Configuration class for DEXPI layout parameters.

Provides configurable spacing, colors, and sizing values for the auto-layout engine. Users can create a custom configuration and pass it to the export methods to control drawing appearance.

Version:
1.0
Author:
NeqSim

  • Field Details

    • xSpacing

      private double xSpacing
      Horizontal spacing between equipment columns (mm in drawing space).

    • yBranchOffset

      private double yBranchOffset
      Vertical spacing for branch lines below the main process line.

    • xStart

      private double xStart
      Starting X coordinate for the first equipment column.

    • yBase

      private double yBase
      Base Y coordinate for the main process line.

    • defaultScale

      private double defaultScale
      Default scale factor for equipment shapes.

    • fontName

      private String fontName
      Font name for all labels and text.

    • tagFontHeight

      private double tagFontHeight
      Font height for equipment tag name labels.

    • processLineWeight

      private double processLineWeight
      Line weight for process piping lines.

    • signalLineWeight

      private double signalLineWeight
      Line weight for signal/instrument lines.

    • lineColorR

      private String lineColorR
      Process line colour - red component (0-1).

    • lineColorG

      private String lineColorG
      Process line colour - green component (0-1).

    • lineColorB

      private String lineColorB
      Process line colour - blue component (0-1).

    • borderMargin

      private double borderMargin
      Drawing border margin (mm).

    • batteryLimitPadding

      private double batteryLimitPadding
      Battery limit boundary padding around equipment (mm).

    • instrumentOffsetY

      private double instrumentOffsetY
      Vertical offset from process line to instrument bubble center.

    • instrumentXSpacing

      private double instrumentXSpacing
      Horizontal spacing between instrument bubbles on the same equipment.

    • showStreamTable

      private boolean showStreamTable
      Whether to include the stream data table at the bottom of the drawing.

    • showSymbolLegend

      private boolean showSymbolLegend
      Whether to include the symbol legend box.

    • showRevisionHistory

      private boolean showRevisionHistory
      Whether to include the revision history table.

    • showBatteryLimit

      private boolean showBatteryLimit
      Whether to include the battery limit boundary.

    • showFlowArrows

      private boolean showFlowArrows
      Whether to include flow direction arrows on connection lines.

    • showStreamLabels

      private boolean showStreamLabels
      Whether to include stream number labels on connection lines.

    • showEquipmentBars

      private boolean showEquipmentBars
      Whether to show equipment bar labels with simulation data.

    • showInsulationMarks

      private boolean showInsulationMarks
      Whether to show insulation markings on lines.

    • showFailPositionMarkers

      private boolean showFailPositionMarkers
      Whether to show fail position markers on valves.

    • showSilMarkers

      private boolean showSilMarkers
      Whether to show SIL level markers on instruments.

    • showOrientationMarkers

      private boolean showOrientationMarkers
      Whether to show orientation markers on equipment.

  • Constructor Details

    • DexpiLayoutConfig

      public DexpiLayoutConfig()
      Creates a default layout configuration.

  • Method Details

    • getXSpacing

      public double getXSpacing()
      Gets the horizontal spacing between equipment columns.
      Returns:
      X spacing in mm

    • setXSpacing

      public DexpiLayoutConfig setXSpacing(double xSpacing)
      Sets the horizontal spacing between equipment columns.
      Parameters:
      xSpacing - X spacing in mm
      Returns:
      this config for method chaining

    • getYBranchOffset

      public double getYBranchOffset()
      Gets the vertical branch offset.
      Returns:
      Y branch offset in mm

    • setYBranchOffset

      public DexpiLayoutConfig setYBranchOffset(double yBranchOffset)
      Sets the vertical branch offset.
      Parameters:
      yBranchOffset - Y branch offset in mm
      Returns:
      this config for method chaining

    • getXStart

      public double getXStart()
      Gets the starting X coordinate.
      Returns:
      X start position in mm

    • setXStart

      public DexpiLayoutConfig setXStart(double xStart)
      Sets the starting X coordinate.
      Parameters:
      xStart - X start position in mm
      Returns:
      this config for method chaining

    • getYBase

      public double getYBase()
      Gets the base Y coordinate for the main process line.
      Returns:
      Y base position in mm

    • setYBase

      public DexpiLayoutConfig setYBase(double yBase)
      Sets the base Y coordinate for the main process line.
      Parameters:
      yBase - Y base position in mm
      Returns:
      this config for method chaining

    • getDefaultScale

      public double getDefaultScale()
      Gets the default scale factor for equipment shapes.
      Returns:
      scale factor

    • setDefaultScale

      public DexpiLayoutConfig setDefaultScale(double defaultScale)
      Sets the default scale factor for equipment shapes.
      Parameters:
      defaultScale - scale factor
      Returns:
      this config for method chaining

    • getFontName

      public String getFontName()
      Gets the font name for labels.
      Returns:
      font name

    • setFontName

      public DexpiLayoutConfig setFontName(String fontName)
      Sets the font name for labels.
      Parameters:
      fontName - font name
      Returns:
      this config for method chaining

    • getTagFontHeight

      public double getTagFontHeight()
      Gets the tag font height.
      Returns:
      font height in mm

    • setTagFontHeight

      public DexpiLayoutConfig setTagFontHeight(double tagFontHeight)
      Sets the tag font height.
      Parameters:
      tagFontHeight - font height in mm
      Returns:
      this config for method chaining

    • getProcessLineWeight

      public double getProcessLineWeight()
      Gets the process line weight.
      Returns:
      line weight in mm

    • setProcessLineWeight

      public DexpiLayoutConfig setProcessLineWeight(double processLineWeight)
      Sets the process line weight.
      Parameters:
      processLineWeight - line weight in mm
      Returns:
      this config for method chaining

    • getSignalLineWeight

      public double getSignalLineWeight()
      Gets the signal line weight.
      Returns:
      line weight in mm

    • setSignalLineWeight

      public DexpiLayoutConfig setSignalLineWeight(double signalLineWeight)
      Sets the signal line weight.
      Parameters:
      signalLineWeight - line weight in mm
      Returns:
      this config for method chaining

    • getLineColorR

      public String getLineColorR()
      Gets the process line colour red component.
      Returns:
      red component (0-1)

    • getLineColorG

      public String getLineColorG()
      Gets the process line colour green component.
      Returns:
      green component (0-1)

    • getLineColorB

      public String getLineColorB()
      Gets the process line colour blue component.
      Returns:
      blue component (0-1)

    • setLineColor

      public DexpiLayoutConfig setLineColor(String r, String g, String b)
      Sets the process line colour components.
      Parameters:
      r - red component (0-1)
      g - green component (0-1)
      b - blue component (0-1)
      Returns:
      this config for method chaining

    • getBorderMargin

      public double getBorderMargin()
      Gets the drawing border margin.
      Returns:
      margin in mm

    • setBorderMargin

      public DexpiLayoutConfig setBorderMargin(double borderMargin)
      Sets the drawing border margin.
      Parameters:
      borderMargin - margin in mm
      Returns:
      this config for method chaining

    • getBatteryLimitPadding

      public double getBatteryLimitPadding()
      Gets the battery limit padding.
      Returns:
      padding in mm

    • setBatteryLimitPadding

      public DexpiLayoutConfig setBatteryLimitPadding(double batteryLimitPadding)
      Sets the battery limit padding.
      Parameters:
      batteryLimitPadding - padding in mm
      Returns:
      this config for method chaining

    • getInstrumentOffsetY

      public double getInstrumentOffsetY()
      Gets the instrument offset Y.
      Returns:
      offset in mm

    • setInstrumentOffsetY

      public DexpiLayoutConfig setInstrumentOffsetY(double instrumentOffsetY)
      Sets the instrument offset Y.
      Parameters:
      instrumentOffsetY - offset in mm
      Returns:
      this config for method chaining

    • getInstrumentXSpacing

      public double getInstrumentXSpacing()
      Gets the instrument X spacing.
      Returns:
      spacing in mm

    • setInstrumentXSpacing

      public DexpiLayoutConfig setInstrumentXSpacing(double instrumentXSpacing)
      Sets the instrument X spacing.
      Parameters:
      instrumentXSpacing - spacing in mm
      Returns:
      this config for method chaining

    • isShowStreamTable

      public boolean isShowStreamTable()
      Returns whether the stream table should be shown.
      Returns:
      true if stream table is shown

    • setShowStreamTable

      public DexpiLayoutConfig setShowStreamTable(boolean showStreamTable)
      Sets whether the stream table should be shown.
      Parameters:
      showStreamTable - true to show stream table
      Returns:
      this config for method chaining

    • isShowSymbolLegend

      public boolean isShowSymbolLegend()
      Returns whether the symbol legend should be shown.
      Returns:
      true if symbol legend is shown

    • setShowSymbolLegend

      public DexpiLayoutConfig setShowSymbolLegend(boolean showSymbolLegend)
      Sets whether the symbol legend should be shown.
      Parameters:
      showSymbolLegend - true to show symbol legend
      Returns:
      this config for method chaining

    • isShowRevisionHistory

      public boolean isShowRevisionHistory()
      Returns whether the revision history should be shown.
      Returns:
      true if revision history is shown

    • setShowRevisionHistory

      public DexpiLayoutConfig setShowRevisionHistory(boolean showRevisionHistory)
      Sets whether the revision history should be shown.
      Parameters:
      showRevisionHistory - true to show revision history
      Returns:
      this config for method chaining

    • isShowBatteryLimit

      public boolean isShowBatteryLimit()
      Returns whether the battery limit boundary should be shown.
      Returns:
      true if battery limit is shown

    • setShowBatteryLimit

      public DexpiLayoutConfig setShowBatteryLimit(boolean showBatteryLimit)
      Sets whether the battery limit boundary should be shown.
      Parameters:
      showBatteryLimit - true to show battery limit
      Returns:
      this config for method chaining

    • isShowFlowArrows

      public boolean isShowFlowArrows()
      Returns whether flow arrows are shown on connection lines.
      Returns:
      true if flow arrows are shown

    • setShowFlowArrows

      public DexpiLayoutConfig setShowFlowArrows(boolean showFlowArrows)
      Sets whether flow arrows are shown on connection lines.
      Parameters:
      showFlowArrows - true to show flow arrows
      Returns:
      this config for method chaining

    • isShowStreamLabels

      public boolean isShowStreamLabels()
      Returns whether stream labels are shown.
      Returns:
      true if stream labels are shown

    • setShowStreamLabels

      public DexpiLayoutConfig setShowStreamLabels(boolean showStreamLabels)
      Sets whether stream labels are shown.
      Parameters:
      showStreamLabels - true to show stream labels
      Returns:
      this config for method chaining

    • isShowEquipmentBars

      public boolean isShowEquipmentBars()
      Returns whether equipment bar labels with simulation data are shown.
      Returns:
      true if equipment bars are shown

    • setShowEquipmentBars

      public DexpiLayoutConfig setShowEquipmentBars(boolean showEquipmentBars)
      Sets whether equipment bar labels with simulation data are shown.
      Parameters:
      showEquipmentBars - true to show equipment bars
      Returns:
      this config for method chaining

    • isShowInsulationMarks

      public boolean isShowInsulationMarks()
      Returns whether insulation marks are shown.
      Returns:
      true if insulation marks are shown

    • setShowInsulationMarks

      public DexpiLayoutConfig setShowInsulationMarks(boolean showInsulationMarks)
      Sets whether insulation marks are shown.
      Parameters:
      showInsulationMarks - true to show insulation marks
      Returns:
      this config for method chaining

    • isShowFailPositionMarkers

      public boolean isShowFailPositionMarkers()
      Returns whether fail position markers are shown on valves.
      Returns:
      true if fail position markers are shown

    • setShowFailPositionMarkers

      public DexpiLayoutConfig setShowFailPositionMarkers(boolean showFailPositionMarkers)
      Sets whether fail position markers are shown on valves.
      Parameters:
      showFailPositionMarkers - true to show fail position markers
      Returns:
      this config for method chaining

    • isShowSilMarkers

      public boolean isShowSilMarkers()
      Returns whether SIL markers are shown on instruments.
      Returns:
      true if SIL markers are shown

    • setShowSilMarkers

      public DexpiLayoutConfig setShowSilMarkers(boolean showSilMarkers)
      Sets whether SIL markers are shown on instruments.
      Parameters:
      showSilMarkers - true to show SIL markers
      Returns:
      this config for method chaining

    • isShowOrientationMarkers

      public boolean isShowOrientationMarkers()
      Returns whether orientation markers are shown on equipment.
      Returns:
      true if orientation markers are shown

    • setShowOrientationMarkers

      public DexpiLayoutConfig setShowOrientationMarkers(boolean showOrientationMarkers)
      Sets whether orientation markers are shown on equipment.
      Parameters:
      showOrientationMarkers - true to show orientation markers
      Returns:
      this config for method chaining