public class Substation extends EquipmentContainer
Modifier and Type | Field and Description |
---|---|
java.util.List<VoltageLevel> |
contains_VoltageLevels
Attribute "contains_VoltageLevels"
Comment from profile:
The association is used in the naming hierarchy.
|
java.lang.String |
idRegion
The id of the attribute "region"
This id is mainly used to resolve links after parsing an instance
|
SubGeographicalRegion |
region
Attribute "region"
Comment from profile:
The association is used in the naming hierarchy.
|
contains_Equipments
topologicalNode
aliasName, description, name
addedToUnresolved, fromBoundary, id, subset
Modifier | Constructor and Description |
---|---|
protected |
Substation()
Constructor of the class Substation
|
Modifier and Type | Method and Description |
---|---|
void |
addContains_VoltageLevels(VoltageLevel contains_VoltageLevelsValue,
boolean setInverse)
Utility to add a value within the "contains_VoltageLevels" ArrayList of
"VoltageLevel"
|
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
|
Substation |
clone()
Utility returning a copy of the "base" of this instance
This utility does not copy the associations with other instances
|
boolean |
contains_VoltageLevelsIsSet()
Utility to test if the value of "contains_VoltageLevels" has been set
|
void |
copyBase(Substation otherSubstation)
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 Substation |
create(java.lang.String id)
Factory of the class
|
java.util.List<VoltageLevel> |
getContains_VoltageLevels()
Utility to return the "contains_VoltageLevels" List of
"VoltageLevel" enum
|
SubGeographicalRegion |
getRegion()
Utility to return the "region"
|
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
|
boolean |
regionIsSet()
Utility to test if the value of "region" has been set
|
void |
resolveLinks(CIMModel model,
CIMModel boundaryModel)
Utility to resolve the links at the end of parsing
|
void |
setRegion(SubGeographicalRegion regionValue,
boolean setInverse)
Utility to set the "regionValue"
|
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
|
addContains_Equipments, contains_EquipmentsIsSet, copyBase, getContains_Equipments
addTopologicalNode, copyBase, getTopologicalNode, topologicalNodeIsSet
aliasNameIsSet, copyBase, descriptionIsSet, getAliasName, getDescription, getName, nameIsSet, setAliasName, setDescription, setName
addToUnresolved, copyBase, getId, getSubset, isAddedToUnresolved, isFromBoundary, removeFromUnresolved, setFromBoundary, setId
public SubGeographicalRegion region
public java.lang.String idRegion
public java.util.List<VoltageLevel> contains_VoltageLevels
public SubGeographicalRegion getRegion()
public boolean regionIsSet()
public void setRegion(SubGeographicalRegion regionValue, boolean setInverse) throws LinkageException
regionValue
- instance to setsetInverse
- boolean to specify whether to set the inverse association
or notLinkageException
public java.util.List<VoltageLevel> getContains_VoltageLevels()
public void addContains_VoltageLevels(VoltageLevel contains_VoltageLevelsValue, boolean setInverse) throws LinkageException
contains_VoltageLevelsValue
- value to add within the ArrayListsetInverse
- boolean to specify whether to set the inverse association or notLinkageException
public boolean contains_VoltageLevelsIsSet()
public static Substation create(java.lang.String id)
id
- id of the class Substation to createpublic void clearContent(Subset subset)
clearContent
in class EquipmentContainer
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 EquipmentContainer
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 EquipmentContainer
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)
write
in class EquipmentContainer
writeID
- specifies whether to write the XML "id" attribute (this is used for describing concrete class)xmlsw
- XMLStreamWriter where are stored the elements to writepublic void write(javax.xml.stream.XMLStreamWriter xmlsw, Subset subset, boolean writeID)
write
in class EquipmentContainer
subset
- the subset defining the context in which to write this classwriteID
- specifies whether to write the XML "id" attribute (this is used for describing concrete class)xmlsw
- the stream in which are stored the elements to writepublic void resolveLinks(CIMModel model, CIMModel boundaryModel) throws LinkageException
resolveLinks
in class EquipmentContainer
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 EquipmentContainer
subset
- the subset defining the context in which to check whether this class is consistentpublic ConsistencyCheck modelConsistency()
modelConsistency
in class EquipmentContainer
public void copyBase(Substation otherSubstation)
otherSubstation
- the instance to copyprotected void clearAssociations(Subset subset)
clearAssociations
in class EquipmentContainer
subset
- the subset from which to clear the associations of this classpublic Substation clone()
clone
in class EquipmentContainer