Class ReferenceDesignationGenerator.DesignationEntry

java.lang.Object

neqsim.process.equipment.iec81346.ReferenceDesignationGenerator.DesignationEntry

All Implemented Interfaces:

Serializable

Enclosing class:

ReferenceDesignationGenerator

public static class ReferenceDesignationGenerator.DesignationEntry
extends Object
implements Serializable

Represents a single generated IEC 81346 designation entry.

Each entry captures the mapping from a NeqSim equipment name to its IEC 81346 reference designation, along with classification metadata.

Version:

1.0

Author:

Even Solbraa

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final String	equipmentName	The original equipment name in NeqSim.
private final String	equipmentType	The simple class name of the equipment (e.g.
private final String	functionArea	The function area identifier (e.g.
private final IEC81346LetterCode	letterCode	The IEC 81346-2 letter code.
private final String	referenceDesignation	The full IEC 81346 reference designation string.
private final int	sequenceNumber	The sequence number within the letter code category.
private static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
DesignationEntry(String equipmentName, String equipmentType, String referenceDesignation, IEC81346LetterCode letterCode, int sequenceNumber, String functionArea)	Creates a new designation entry.

Method Summary

Modifier and Type	Method	Description
String	getEquipmentName()	Returns the original equipment name in NeqSim.
String	getEquipmentType()	Returns the simple class name of the equipment.
String	getFunctionArea()	Returns the function area identifier.
IEC81346LetterCode	getLetterCode()	Returns the IEC 81346-2 letter code.
String	getReferenceDesignation()	Returns the full IEC 81346 reference designation string.
int	getSequenceNumber()	Returns the sequence number within the letter code category.
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

equipmentName

private final String equipmentName

The original equipment name in NeqSim.

equipmentType

private final String equipmentType

The simple class name of the equipment (e.g. "Separator", "Compressor").

referenceDesignation

private final String referenceDesignation

The full IEC 81346 reference designation string.

letterCode

private final IEC81346LetterCode letterCode

The IEC 81346-2 letter code.

sequenceNumber

private final int sequenceNumber

The sequence number within the letter code category.

functionArea

private final String functionArea

The function area identifier (e.g. "A1", "A2").

Constructor Details

DesignationEntry

public DesignationEntry(String equipmentName,
 String equipmentType,
 String referenceDesignation,
 IEC81346LetterCode letterCode,
 int sequenceNumber,
 String functionArea)

Creates a new designation entry.

Parameters:

equipmentName - the original equipment name

equipmentType - the simple class name of the equipment

referenceDesignation - the full reference designation string

letterCode - the IEC 81346-2 letter code

sequenceNumber - the sequence number within the letter code category

functionArea - the function area identifier

Method Details

getEquipmentName

public String getEquipmentName()

Returns the original equipment name in NeqSim.

Returns:

the equipment name

getEquipmentType

public String getEquipmentType()

Returns the simple class name of the equipment.

Returns:

the equipment type, e.g. "Separator", "Compressor"

getReferenceDesignation

public String getReferenceDesignation()

Returns the full IEC 81346 reference designation string.

Returns:

the reference designation, e.g. "=A1-B1+P1.M1"

getLetterCode

public IEC81346LetterCode getLetterCode()

Returns the IEC 81346-2 letter code.

Returns:

the letter code

getSequenceNumber

public int getSequenceNumber()

Returns the sequence number within the letter code category.

Returns:

the sequence number (1-based)

getFunctionArea

public String getFunctionArea()

Returns the function area identifier.

Returns:

the function area, e.g. "A1"

toString

public String toString()

Overrides:

toString in class Object