Interface NamedInterface

All Known Subinterfaces:
AbsorberInterface, CompressorInterface, DistillationInterface, ExpanderInterface, HeaterInterface, HeatExchangerInterface, MeasurementDeviceInterface, MixerInterface, ModuleInterface, MultiStreamHeatExchangerInterface, PipeLineInterface, ProcessEquipmentInterface, PumpInterface, SeparatorInterface, SimulationInterface, SplitterInterface, StreamInterface, TrayInterface, ValveInterface
All Known Implementing Classes:
AdiabaticPipe, AdiabaticTwoPhasePipe, Adjuster, AdsorptionDehydrationlModule, AirCooler, BatteryStorage, BerlSaddlePacking, BestPracticeHydrocarbonDewPoint, BlowdownValve, Calculator, CharCoalFilter, CheckValve, ChemicalReaction, CO2Electrolyzer, CO2RemovalModule, CombustionEmissionsCalculator, ComponentSplitter, Compressor, CompressorMonitor, Condenser, ContractSpecification, ControllerDeviceBaseClass, ControlValve, Cooler, CricondenbarAnalyser, DexpiProcessUnit, DexpiProcessUnit, DexpiStream, DexpiStream, DistillationColumn, DPCUModule, Draft_GERG2004, Draft_ISO18453, Ejector, Electrolyzer, EquilibriumStream, ESDValve, ESPPump, Expander, ExpanderOld, Filter, FireDetector, Flare, FlareStack, FlowInducedVibrationAnalyser, FlowRateAdjuster, FlowSetter, FuelCell, FurnaceBurner, GasChromotograpyhBase, GasDetector, GasScrubber, GasScrubberSimple, GasTurbine, GibbsReactor, GibbsReactorCO2, GlycolDehydrationlModule, GORfitter, Heater, HeatExchanger, HIPPSValve, HydrateEquilibriumTemperatureAnalyser, HydrocarbonDewPointAnalyser, Hydrocyclone, Hydrocyclone, IncompressiblePipeFlow, IntegratedSafetySystemExample.ESDController, IntegratedSafetySystemExample.HIPPSController, IronIonSaturationStream, LevelControlValve, LevelTransmitter, Manifold, ManwaySection, MeasurementDeviceBaseClass, MEGReclaimerModule, MembraneSeparator, MeshSection, Mixer, MixerGasProcessingModule, ModelPredictiveController, MolarMassAnalyser, MoleFractionControllerUtil, MPFMfitter, MultiPhaseMeter, MultiStreamHeatExchanger, MultiStreamHeatExchanger2, NamedBaseClass, NeqGasScrubber, NeqHeater, NeqSimUnit, NeqStream, NMVOCAnalyser, NozzleSection, OilLevelTransmitter, OnePhasePipeLine, Orifice, PackedSection, Packing, PallRingPacking, pHProbe, PipeBeggsAndBrills, PipeFlowNetwork, Pipeline, PressureControlValve, PressureDrop, PressureTransmitter, ProcessEquipmentBaseClass, ProcessModule, ProcessModuleBaseClass, ProcessSystem, ProducedWaterTreatmentTrain, PropaneCoolingModule, PSDValve, Pump, PushButton, RachigRingPacking, Reboiler, ReBoiler, Recycle, ReservoirCVDsim, ReservoirDiffLibsim, ReservoirTPsim, RuptureDisk, SafetyReliefValve, SafetyValve, ScalePotentialCheckStream, SeparationTrainModule, SeparationTrainModuleSimple, Separator, SeparatorSection, SetPoint, Setter, SevereSlugAnalyser, SimpleAbsorber, SimpleAdsorber, SimpleFlowLine, SimpleReservoir, SimpleTEGAbsorber, SimpleTPoutPipeline, SimpleTray, SimulationBaseClass, SoftSensor, SolarPanel, Splitter, Standard, Standard_ASTM_D6377, Standard_ISO15403, Standard_ISO6578, Standard_ISO6974, Standard_ISO6976, Standard_ISO6976_2016, StaticMixer, StaticNeqMixer, StaticPhaseMixer, SteamHeater, Stream, StreamMeasurementDeviceBaseClass, StreamSaturatorUtil, StreamTransition, SubseaWell, SulfurSpecificationMethod, Tank, TemperatureTransmitter, ThreePhaseSeparator, ThrottlingValve, TransientPipe, TubingPerformance, TubingPerformance, TurboExpanderCompressor, TwoFluidPipe, TwoPhasePipeLine, TwoPhaseSeparator, TwoPortEquipment, UKspecifications_ICF_SI, ValveSection, VaneSection, VesselDepressurization, VirtualFlowMeter, VirtualStream, VLSolidTray, VolumeFlowTransmitter, WaterContentAnalyser, WaterCooler, WaterDewPointAnalyser, WaterHammerPipe, WaterLevelTransmitter, WaterStripperColumn, Well, WellAllocator, WellFlow, WellFlowlineNetwork, WellFluidModule, WellSystem, WindTurbine

public interface NamedInterface

NamedInterface interface.

Version:
$Id: $Id
Author:
ASMF
  • Method Summary

    Modifier and Type
    Method
    Description
    Getter for the field name.
    Retrieves the tag name of the process equipment.
    void
    Setter for the field name.
    void
    setTagName(String tagName)
    Sets the tag name for the process equipment.
  • Method Details

    • getName

      String getName()

      Getter for the field name.

      Returns:
      a String object
    • setName

      void setName(String name)

      Setter for the field name.

      Parameters:
      name - a String object
    • setTagName

      void setTagName(String tagName)
      Sets the tag name for the process equipment.
      Parameters:
      tagName - a String representing the tag name
      Throws:
      IllegalArgumentException - if the tag name is null
    • getTagName

      String getTagName()
      Retrieves the tag name of the process equipment.
      Returns:
      the tag name as a String.