public class ConductingEquipment extends Equipment
Modifier and Type | Field and Description |
---|---|
BaseVoltage |
baseVoltage
Attribute "baseVoltage"
Comment from profile:
Use association to ConductingEquipment only when there is no VoltageLevel container used.The profile requires a BaseVoltage associaton on ConductingEquipment subtypes of classes ACLineSegment and TransformerWinding.
|
java.lang.String |
idBaseVoltage
The id of the attribute "baseVoltage"
This id is mainly used to resolve links after parsing an instance
|
java.util.List<Terminal> |
terminals
Attribute "terminals"
Comment from profile:
ConductingEquipment has 1 or 2 terminals that may be connected to other ConductingEquipment terminals via ConnectivityNodes
|
equivalent, idMemberOf_EquipmentContainer, memberOf_EquipmentContainer
aliasName, description, name
addedToUnresolved, fromBoundary, id, subset
Modifier | Constructor and Description |
---|---|
protected |
ConductingEquipment()
Constructor of the class ConductingEquipment
|
Modifier and Type | Method and Description |
---|---|
void |
addTerminals(Terminal terminalsValue,
boolean setInverse)
Utility to add a value within the "terminals" ArrayList of
"Terminal"
|
boolean |
baseVoltageIsSet()
Utility to test if the value of "baseVoltage" has been set
|
protected void |
clearAssociations(Subset subset)
Utility to clear the associations of this class belonging to a
specific subset
|
void |
clearContent(Subset subset)
Utility to "clear" the content of a class when a subset is invalidated
|
ConductingEquipment |
clone()
Utility returning a copy of the "base" of this instance
This utility does not copy the associations with other instances
|
void |
copyBase(ConductingEquipment otherConductingEquipment)
Utility to copy the "base" of an other instance of the same class
This utility does not copy the associations with other instances from
the instance to copy
|
static ConductingEquipment |
create(java.lang.String id)
Factory of the class
|
BaseVoltage |
getBaseVoltage()
Utility to return the "baseVoltage"
|
java.util.List<Terminal> |
getTerminals()
Utility to return the "terminals" List of
"Terminal" enum
|
ConsistencyCheck |
modelConsistency()
Utility to check whether this class is consistent in a "merged" context
|
ConsistencyCheck |
modelConsistency(Subset subset)
Utility to check whether this class is consistent according to a subset
|
void |
readAttribute(java.lang.String class_name,
java.lang.String attr_name,
java.lang.String value,
CIMModel model)
Utility to read an attribute
This function is called by the CIMModel
|
void |
readResource(java.lang.String class_name,
java.lang.String resource_name,
java.lang.String id,
CIMModel model)
Utility to read a reference to a resource
This function is called by the CIMModel
|
void |
resolveLinks(CIMModel model,
CIMModel boundaryModel)
Utility to resolve the links at the end of parsing
|
void |
setBaseVoltage(BaseVoltage baseVoltageValue,
boolean setInverse)
Utility to set the "baseVoltageValue"
|
boolean |
terminalsIsSet()
Utility to test if the value of "terminals" has been set
|
void |
write(javax.xml.stream.XMLStreamWriter xmlsw,
boolean writeID)
Utility to write the content into the CIM XML format
|
void |
write(javax.xml.stream.XMLStreamWriter xmlsw,
Subset subset,
boolean writeID)
Utility to write the content this class into the CIM/XML format according
to a subset
|
copyBase, equivalentIsSet, getMemberOf_EquipmentContainer, isEquivalent, memberOf_EquipmentContainerIsSet, setEquivalent, setMemberOf_EquipmentContainer
aliasNameIsSet, copyBase, descriptionIsSet, getAliasName, getDescription, getName, nameIsSet, setAliasName, setDescription, setName
addToUnresolved, copyBase, getId, getSubset, isAddedToUnresolved, isFromBoundary, removeFromUnresolved, setFromBoundary, setId
public java.util.List<Terminal> terminals
public BaseVoltage baseVoltage
public java.lang.String idBaseVoltage
protected ConductingEquipment()
public java.util.List<Terminal> getTerminals()
public void addTerminals(Terminal terminalsValue, boolean setInverse) throws LinkageException
terminalsValue
- value to add within the ArrayListsetInverse
- boolean to specify whether to set the inverse association or notLinkageException
public boolean terminalsIsSet()
public BaseVoltage getBaseVoltage()
public boolean baseVoltageIsSet()
public void setBaseVoltage(BaseVoltage baseVoltageValue, boolean setInverse) throws LinkageException
baseVoltageValue
- instance to setsetInverse
- boolean to specify whether to set the inverse association
or notLinkageException
public static ConductingEquipment create(java.lang.String id)
id
- id of the class ConductingEquipment to createpublic void clearContent(Subset subset)
clearContent
in class Equipment
subset
- subset to cleanpublic void readAttribute(java.lang.String class_name, java.lang.String attr_name, java.lang.String value, CIMModel model) throws InterpretationException
readAttribute
in class Equipment
class_name
- the read name of classattr_name
- the read name of attributevalue
- the read value of the attributemodel
- the interface to the model this class belongs toInterpretationException
public void readResource(java.lang.String class_name, java.lang.String resource_name, java.lang.String id, CIMModel model) throws InterpretationException, LinkageException
readResource
in class Equipment
class_name
- the read name of classresource_name
- the read name of the associated resourceid
- the id of the associated resourcemodel
- the model this class belongs toInterpretationException
LinkageException
public void write(javax.xml.stream.XMLStreamWriter xmlsw, boolean writeID)
public void write(javax.xml.stream.XMLStreamWriter xmlsw, Subset subset, boolean writeID)
public void resolveLinks(CIMModel model, CIMModel boundaryModel) throws LinkageException
resolveLinks
in class Equipment
model
- the model this class belongs toboundaryModel
- the model that gather data about the boundarySet, used
as a resource force links resolvingLinkage
- ExceptionLinkageException
public ConsistencyCheck modelConsistency(Subset subset)
modelConsistency
in class Equipment
subset
- the subset defining the context in which to check whether this class is consistentpublic ConsistencyCheck modelConsistency()
modelConsistency
in class Equipment
public void copyBase(ConductingEquipment otherConductingEquipment)
otherConductingEquipment
- the instance to copyprotected void clearAssociations(Subset subset)
clearAssociations
in class Equipment
subset
- the subset from which to clear the associations of this classpublic ConductingEquipment clone()