Class TechnicalRequirementsDocument

java.lang.Object
neqsim.process.mechanicaldesign.torg.TechnicalRequirementsDocument
All Implemented Interfaces:
Serializable
public class TechnicalRequirementsDocument extends Object implements Serializable
Represents a Technical Requirements Document (TORG) that specifies design standards and methods to be used in process design for a project.

A TORG typically contains:

  • Project identification and metadata
  • Design standards to be applied per equipment category
  • Company-specific design requirements
  • Material specifications
  • Safety factors and margins
  • Environmental conditions (ambient temperature, seismic zone, etc.)

Example usage: 

TechnicalRequirementsDocument torg = TechnicalRequirementsDocument.builder()
    .projectId("PROJECT-001").projectName("Offshore Gas Platform").companyIdentifier("Equinor")
    .addStandard("pressure vessel design code", StandardType.ASME_VIII_DIV1)
    .addStandard("separator process design", StandardType.API_12J)
    .addStandard("pipeline design codes", StandardType.NORSOK_L_001).minAmbientTemperature(-40.0)
    .maxAmbientTemperature(45.0).build();

// Apply to a process system
processSystem.setTechnicalRequirements(torg);
Version:
1.0
Author:
esol
See Also:

  • Field Details

  • Constructor Details

    • TechnicalRequirementsDocument

      private TechnicalRequirementsDocument(TechnicalRequirementsDocument.Builder builder)
      Private constructor - use Builder.
      Parameters:
      builder - the builder instance

  • Method Details

    • builder

      public static TechnicalRequirementsDocument.Builder builder()
      Create a new builder.
      Returns:
      new Builder instance

    • getProjectId

      public String getProjectId()
      Get the project identifier.
      Returns:
      project ID

    • getProjectName

      public String getProjectName()
      Get the project name.
      Returns:
      project name

    • getCompanyIdentifier

      public String getCompanyIdentifier()
      Get the company identifier.
      Returns:
      company identifier

    • getRevision

      public String getRevision()
      Get the document revision.
      Returns:
      revision string

    • getIssueDate

      public String getIssueDate()
      Get the issue date.
      Returns:
      issue date in ISO format

    • getStandardsForCategory

      public List<StandardType> getStandardsForCategory(String category)
      Get standards for a specific design category.
      Parameters:
      category - the design category (e.g., "pressure vessel design code")
      Returns:
      list of applicable standards, empty if none defined

    • getStandardsForEquipment

      public List<StandardType> getStandardsForEquipment(String equipmentType)
      Get standards specifically assigned to an equipment type.
      Parameters:
      equipmentType - the equipment type (e.g., "Separator")
      Returns:
      list of applicable standards, empty if none defined

    • getAllApplicableStandards

      public List<StandardType> getAllApplicableStandards(String equipmentType)
      Get all applicable standards for a given equipment type. This combines equipment-specific standards with category-based standards.
      Parameters:
      equipmentType - the equipment type
      Returns:
      combined list of applicable standards

    • getDefinedCategories

      public Set<String> getDefinedCategories()
      Get all design standard categories defined in this TORG.
      Returns:
      set of category names

    • getEnvironmentalConditions

      public TechnicalRequirementsDocument.EnvironmentalConditions getEnvironmentalConditions()
      Get environmental conditions.
      Returns:
      environmental conditions, or null if not defined

    • getSafetyFactors

      public TechnicalRequirementsDocument.SafetyFactors getSafetyFactors()
      Get safety factors.
      Returns:
      safety factors, or null if not defined

    • getMaterialSpecifications

      public TechnicalRequirementsDocument.MaterialSpecifications getMaterialSpecifications()
      Get material specifications.
      Returns:
      material specifications, or null if not defined

    • getCustomParameter

      public Object getCustomParameter(String key)
      Get a custom parameter value.
      Parameters:
      key - parameter key
      Returns:
      parameter value, or null if not found

    • getCustomParameter

      public <T> T getCustomParameter(String key, Class<T> type)
      Get a custom parameter as a specific type.
      Type Parameters:
      T - the expected type
      Parameters:
      key - parameter key
      type - the class of the expected type
      Returns:
      parameter value cast to the type, or null if not found or wrong type

    • hasStandardsForCategory

      public boolean hasStandardsForCategory(String category)
      Check if this TORG has standards defined for a category.
      Parameters:
      category - the design category
      Returns:
      true if standards are defined

    • toString

      public String toString()
      Overrides:
      toString in class Object