Interface NamedInterface

All Known Subinterfaces:

AbsorberInterface, CompressorInterface, ControllerDeviceInterface, DistillationInterface, ExpanderInterface, HeaterInterface, HeatExchangerInterface, MeasurementDeviceInterface, MixerInterface, ModuleInterface, MultiStreamHeatExchangerInterface, PipeLineInterface, ProcessElementInterface, ProcessEquipmentInterface, PumpInterface, SeparatorInterface, SimulationInterface, SplitterInterface, StreamInterface, TrayInterface, ValveInterface

All Known Implementing Classes:

AdiabaticPipe, AdiabaticTwoPhasePipe, Adjuster, AdsorptionBed, AdsorptionDehydrationlModule, AirCooler, AmmoniaSynthesisReactor, AnaerobicDigester, AnnularLeakagePath, BatteryStorage, BerlSaddlePacking, BestPracticeHydrocarbonDewPoint, BiogasToGridModule, BiogasUpgrader, BiomassGasifier, BlackOilSeparator, BlowdownValve, Calculator, CementDegradationModel, CharCoalFilter, CheckValve, ChemicalReaction, CO2Electrolyzer, CO2RemovalModule, CombinedCycleSystem, CombustionEmissionsCalculator, ComponentSplitter, Compressor, CompressorMonitor, CompressorTrain, Condenser, ContractSpecification, ControllerDeviceBaseClass, ControlValve, Cooler, CricondenbarAnalyser, CryogenicSeparator, Crystallizer, DexpiProcessUnit, DexpiProcessUnit, DexpiStream, DexpiStream, DistillationColumn, DPCUModule, Draft_GERG2004, Draft_ISO18453, Dryer, Ejector, Electrolyzer, EndFlash, EnzymeTreatment, EquilibriumStream, ESDValve, ESPPump, Expander, ExpanderOld, FermentationReactor, Fermenter, Filter, FireDetector, FiredHeater, Flare, FlareStack, FlexiblePipe, FloatingSubstructure, FlowInducedVibrationAnalyser, FlowRateAdjuster, FlowSetter, FuelCell, FuelGasSystem, FurnaceBurner, GasChromotograpyhBase, GasDetector, GasFlotationUnit, GasificationSynthesisModule, GasScrubber, GasScrubberSimple, GasTurbine, GibbsReactor, GibbsReactorCO2, GlycolDehydrationlModule, GORfitter, H2SScavenger, Heater, HeatExchanger, HIPPSValve, HRSG, HydrateEquilibriumTemperatureAnalyser, HydrocarbonDewPointAnalyser, Hydrocyclone, Hydrocyclone, ImpurityMonitor, IncompressiblePipeFlow, InjectionConformanceMonitor, IntegratedSafetySystemExample.ESDController, IntegratedSafetySystemExample.HIPPSController, IronIonSaturationStream, LevelControlValve, LevelTransmitter, LiquidLiquidExtractor, LNGAgeingScenario, LNGHeatExchanger, LNGTank, LogicBlock, LoopedPipeNetwork, Manifold, ManwaySection, MeasurementDeviceBaseClass, MEGReclaimerModule, MembraneSeparator, MercuryRemovalBed, MeshSection, Mixer, MixerGasProcessingModule, ModelPredictiveController, MolarMassAnalyser, MoleFractionControllerUtil, MooringSystem, MPFMfitter, MultiCompartmentReservoir, MultiEffectEvaporator, MultiPhaseMeter, MultiphasePipe, MultiPortEquipment, MultiStreamHeatExchanger, MultiStreamHeatExchanger2, MultiVariableAdjuster, NamedBaseClass, NeqGasScrubber, NeqHeater, NeqSimUnit, NeqStream, NMVOCAnalyser, NozzleSection, OffshoreEnergySystem, OilLevelTransmitter, OnePhasePipeLine, Orifice, PackedColumn, PackedSection, Packing, PallRingPacking, pHProbe, PipeBeggsAndBrills, PipeFlowNetwork, PipeHagedornBrown, Pipeline, PipeMukherjeeAndBrill, PLEM, PLET, PlugFlowReactor, PressureControlValve, PressureDrop, PressureFilter, PressureTransmitter, ProcessEquipmentBaseClass, ProcessModule, ProcessModuleBaseClass, ProcessSystem, ProducedWaterTreatmentTrain, PropaneCoolingModule, PSDValve, Pump, PushButton, PyrolysisReactor, RachigRingPacking, RateBasedAbsorber, RateBasedPackedColumn, ReactiveTray, Reboiler, ReBoiler, Recycle, ReservoirCVDsim, ReservoirDiffLibsim, ReservoirTPsim, Riser, RotaryVacuumFilter, RuptureDisk, SafetyReliefValve, SafetyValve, ScalePotentialCheckStream, ScrewPress, ScrubColumn, SeparationTrainModule, SeparationTrainModuleSimple, Separator, SeparatorSection, SetPoint, Setter, SevereSlugAnalyser, ShortcutDistillationColumn, SimpleAbsorber, SimpleAdsorber, SimpleAmineAbsorber, SimpleFlowLine, SimpleReservoir, SimpleTEGAbsorber, SimpleTPoutPipeline, SimpleTray, SimulationBaseClass, SoftSensor, SolarPanel, SolidsCentrifuge, SolidsSeparator, Splitter, SpreadsheetBlock, Standard, Standard_AGA3, Standard_AGA7, Standard_ASTM_D2500, Standard_ASTM_D4052, Standard_ASTM_D4294, Standard_ASTM_D445, Standard_ASTM_D6377, Standard_ASTM_D86, Standard_ASTM_D97, Standard_BSW, Standard_EN16723, Standard_EN16726, Standard_GPA2145, Standard_GPA2172, Standard_ISO12213, Standard_ISO13443, Standard_ISO14687, Standard_ISO15112, Standard_ISO15403, Standard_ISO18453, Standard_ISO23874, Standard_ISO6578, Standard_ISO6974, Standard_ISO6976, Standard_ISO6976_2016, StaticMixer, StaticNeqMixer, StaticPhaseMixer, SteamHeater, SteamTurbine, StirredTankReactor, Stream, StreamMeasurementDeviceBaseClass, StreamSaturatorUtil, StreamTransition, SubseaBooster, SubseaJumper, SubseaManifold, SubseaPowerCable, SubseaTree, SubseaWell, SulfurDepositionAnalyser, SulfurFilter, SulfurSpecificationMethod, Tank, TemperatureTransmitter, ThreePhaseSeparator, ThrottlingValve, TopsidePiping, TransferFunctionBlock, TransientPipe, TransientWellbore, TubingPerformance, TubingPerformance, TurboExpanderCompressor, TwoFluidPipe, TwoPhasePipeLine, TwoPhaseSeparator, TwoPortEquipment, UKspecifications_ICF_SI, Umbilical, UnisimCalculator, UtilityAirSystem, ValveSection, VaneSection, VesselDepressurization, VirtualFlowMeter, VirtualStream, VLSolidTray, VolumeFlowTransmitter, WasteToEnergyCHPModule, WaterContentAnalyser, WaterCooler, WaterDewPointAnalyser, WaterHammerPipe, WaterLevelTransmitter, WaterStripperColumn, Well, WellAllocator, WellFlow, WellFlowlineNetwork, WellFluidModule, WellSystem, WindFarm, WindTurbine

public interface NamedInterface

NamedInterface interface.

Version:

$Id: $Id

Author:

ASMF

Method Summary

Modifier and Type	Method	Description
String	getName()	Getter for the field name.
default String	getTagName()	Retrieves the tag name of the process equipment.
String	getTagNumber()	Retrieves the tag number of the process equipment.
void	setName(String name)	Setter for the field name.
default void	setTagName(String tagName)	Sets the tag name for the process equipment.
void	setTagNumber(String tagNumber)	Sets the tag number 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

default 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

default String getTagName()

Retrieves the tag name of the process equipment.

Returns:

the tag name as a String.

setTagNumber

void setTagNumber(String tagNumber)

Sets the tag number for the process equipment.

Parameters:

tagNumber - a String representing the tag number

Throws:

IllegalArgumentException - if the tag number is null

getTagNumber

String getTagNumber()

Retrieves the tag number of the process equipment.

Returns:

the tag number as a String.