cim1.model

Class TopologicalNode

java.lang.Object

cim1.model.CIMInstance

cim1.model.IdentifiedObject

cim1.model.TopologicalNode

public class TopologicalNode
extends IdentifiedObject

This file has been automatically generated by CIMGateway Description : This class "TopologicalNode.java" represents the class TopologicalNode extends IdentifiedObject + equivalent 0..1 boolean + x0PerX 0..1 float + AngleRef_TopologicalIsland 0..1 TopologicalIsland + SvVoltage 0..1 SvVoltage + ConnectivityNodeContainer 0..1 ConnectivityNodeContainer + Terminal 0..-1 Terminal (inverseAssociation) + sShortCircuit 0..1 float + TopologicalIsland 1..1 TopologicalIsland + BaseVoltage 1..1 BaseVoltage + r0PerR 0..1 float + ControlArea 0..1 ControlArea + xPerR 0..1 float

Field Summary

Fields

Modifier and Type	Field and Description
TopologicalIsland	angleRef_TopologicalIsland Attribute "angleRef_TopologicalIsland" Comment from profile: The island for which the node is an angle reference.
BaseVoltage	baseVoltage Attribute "baseVoltage" Comment from profile: The base voltage of the topologocial node.The base voltage of the TopologicalNode should match the BaseVoltage of the containing VoltageLevel if such a containing VoltageLevel is specified.
ConnectivityNodeContainer	connectivityNodeContainer Attribute "connectivityNodeContainer" Comment from profile: A TopologicalNode object used for an X-node will not be contained, thus this association is specified as optional in the profile.
ControlArea	controlArea Attribute "controlArea" Comment from profile: The control area into which the node is included.
boolean	equivalent Attribute "equivalent" Comment from profile: The topological node is equivalent and not real equipment.If this is missing, it is assumed to be False.
java.lang.String	idAngleRef_TopologicalIsland The id of the attribute "angleRef_TopologicalIsland" This id is mainly used to resolve links after parsing an instance
java.lang.String	idBaseVoltage The id of the attribute "baseVoltage" This id is mainly used to resolve links after parsing an instance
java.lang.String	idConnectivityNodeContainer The id of the attribute "connectivityNodeContainer" This id is mainly used to resolve links after parsing an instance
java.lang.String	idControlArea The id of the attribute "controlArea" This id is mainly used to resolve links after parsing an instance
java.lang.String	idSvVoltage The id of the attribute "svVoltage" This id is mainly used to resolve links after parsing an instance
java.lang.String	idTopologicalIsland The id of the attribute "topologicalIsland" This id is mainly used to resolve links after parsing an instance
float	r0PerR Attribute "r0PerR" Comment from profile: The ratio of zero sequence resistance to positive sequence resistance.This is for Short Circuit only.
float	sShortCircuit Attribute "sShortCircuit" Comment from profile: The short circuit apparent power drawn at this node when faulted.This is for Short Circuit only.
SvVoltage	svVoltage Attribute "svVoltage" Comment from profile: The state voltage associated with the topological node.
java.util.List<Terminal>	terminal Attribute "terminal" Comment from profile: The terminals associated with the topological node.
TopologicalIsland	topologicalIsland Attribute "topologicalIsland" Comment from profile: A topological node belongs to a topological island
float	x0PerX Attribute "x0PerX" Comment from profile: The ratio of zero sequence reactance per positive sequence reactance.This is for Short Circuit only.
float	xPerR Attribute "xPerR" Comment from profile: Ratio of positive sequence reactance per postive sequence resistance.This is for Short Circuit only.

Fields inherited from class cim1.model.IdentifiedObject

aliasName, description, name

Fields inherited from class cim1.model.CIMInstance

addedToUnresolved, fromBoundary, id, subset

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TopologicalNode() Constructor of the class TopologicalNode

Method Summary

Modifier and Type	Method and Description
void	addTerminal(Terminal terminalValue, boolean setInverse) Utility to add a value within the "terminal" ArrayList of "Terminal"
boolean	angleRef_TopologicalIslandIsSet() Utility to test if the value of "angleRef_TopologicalIsland" has been set
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
TopologicalNode	clone() Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances
boolean	connectivityNodeContainerIsSet() Utility to test if the value of "connectivityNodeContainer" has been set
boolean	controlAreaIsSet() Utility to test if the value of "controlArea" has been set
void	copyBase(TopologicalNode otherTopologicalNode) 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 TopologicalNode	create(java.lang.String id) Factory of the class
boolean	equivalentIsSet() Utility to test if the value of "equivalent" has been set
TopologicalIsland	getAngleRef_TopologicalIsland() Utility to return the "angleRef_TopologicalIsland"
BaseVoltage	getBaseVoltage() Utility to return the "baseVoltage"
ConnectivityNodeContainer	getConnectivityNodeContainer() Utility to return the "connectivityNodeContainer"
ControlArea	getControlArea() Utility to return the "controlArea"
float	getR0PerR() Utility to return the "r0PerR" value
float	getSShortCircuit() Utility to return the "sShortCircuit" value
SvVoltage	getSvVoltage() Utility to return the "svVoltage"
java.util.List<Terminal>	getTerminal() Utility to return the "terminal" List of "Terminal" enum
TopologicalIsland	getTopologicalIsland() Utility to return the "topologicalIsland"
float	getX0PerX() Utility to return the "x0PerX" value
float	getXPerR() Utility to return the "xPerR" value
boolean	isEquivalent() Utility to return the "equivalent" value
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
boolean	r0PerRIsSet() Utility to test if the value of "r0PerR" has been set
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	setAngleRef_TopologicalIsland(TopologicalIsland angleRef_TopologicalIslandValue, boolean setInverse) Utility to set the "angleRef_TopologicalIslandValue"
void	setBaseVoltage(BaseVoltage baseVoltageValue, boolean setInverse) Utility to set the "baseVoltageValue"
void	setConnectivityNodeContainer(ConnectivityNodeContainer connectivityNodeContainerValue, boolean setInverse) Utility to set the "connectivityNodeContainerValue"
void	setControlArea(ControlArea controlAreaValue, boolean setInverse) Utility to set the "controlAreaValue"
void	setEquivalent(boolean equivalentValue) Utility to set the "equivalent" value
void	setR0PerR(float r0PerRValue) Utility to set the "r0PerR" value
void	setSShortCircuit(float sShortCircuitValue) Utility to set the "sShortCircuit" value
void	setSvVoltage(SvVoltage svVoltageValue, boolean setInverse) Utility to set the "svVoltageValue"
void	setTopologicalIsland(TopologicalIsland topologicalIslandValue, boolean setInverse) Utility to set the "topologicalIslandValue"
void	setX0PerX(float x0PerXValue) Utility to set the "x0PerX" value
void	setXPerR(float xPerRValue) Utility to set the "xPerR" value
boolean	sShortCircuitIsSet() Utility to test if the value of "sShortCircuit" has been set
boolean	svVoltageIsSet() Utility to test if the value of "svVoltage" has been set
boolean	terminalIsSet() Utility to test if the value of "terminal" has been set
boolean	topologicalIslandIsSet() Utility to test if the value of "topologicalIsland" 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
boolean	x0PerXIsSet() Utility to test if the value of "x0PerX" has been set
boolean	xPerRIsSet() Utility to test if the value of "xPerR" has been set

Methods inherited from class cim1.model.IdentifiedObject

aliasNameIsSet, copyBase, descriptionIsSet, getAliasName, getDescription, getName, nameIsSet, setAliasName, setDescription, setName

Methods inherited from class cim1.model.CIMInstance

addToUnresolved, copyBase, getId, getSubset, isAddedToUnresolved, isFromBoundary, removeFromUnresolved, setFromBoundary, setId

Methods inherited from class java.lang.Object

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

Field Detail

equivalent

public boolean equivalent

Attribute "equivalent" Comment from profile: The topological node is equivalent and not real equipment.If this is missing, it is assumed to be False. If it is an X-Node, this equivalent is required.

x0PerX

public float x0PerX

Attribute "x0PerX" Comment from profile: The ratio of zero sequence reactance per positive sequence reactance.This is for Short Circuit only.

angleRef_TopologicalIsland

public TopologicalIsland angleRef_TopologicalIsland

Attribute "angleRef_TopologicalIsland" Comment from profile: The island for which the node is an angle reference. Normally there is one angle reference node for each island.

idAngleRef_TopologicalIsland

public java.lang.String idAngleRef_TopologicalIsland

The id of the attribute "angleRef_TopologicalIsland" This id is mainly used to resolve links after parsing an instance

svVoltage

public SvVoltage svVoltage

Attribute "svVoltage" Comment from profile: The state voltage associated with the topological node.

idSvVoltage

public java.lang.String idSvVoltage

The id of the attribute "svVoltage" This id is mainly used to resolve links after parsing an instance

connectivityNodeContainer

public ConnectivityNodeContainer connectivityNodeContainer

Attribute "connectivityNodeContainer" Comment from profile: A TopologicalNode object used for an X-node will not be contained, thus this association is specified as optional in the profile.

idConnectivityNodeContainer

public java.lang.String idConnectivityNodeContainer

The id of the attribute "connectivityNodeContainer" This id is mainly used to resolve links after parsing an instance

terminal

public java.util.List<Terminal> terminal

Attribute "terminal" Comment from profile: The terminals associated with the topological node. This can be used as an alternative to the connectivity node path to terminal, thus making it unneccesary to model connedtivity nodes in some cases. Note that the if connectivity nodes are in the model, this association would proably not be used.

sShortCircuit

public float sShortCircuit

Attribute "sShortCircuit" Comment from profile: The short circuit apparent power drawn at this node when faulted.This is for Short Circuit only.

topologicalIsland

public TopologicalIsland topologicalIsland

Attribute "topologicalIsland" Comment from profile: A topological node belongs to a topological island

idTopologicalIsland

public java.lang.String idTopologicalIsland

The id of the attribute "topologicalIsland" This id is mainly used to resolve links after parsing an instance

baseVoltage

public BaseVoltage baseVoltage

Attribute "baseVoltage" Comment from profile: The base voltage of the topologocial node.The base voltage of the TopologicalNode should match the BaseVoltage of the containing VoltageLevel if such a containing VoltageLevel is specified.

idBaseVoltage

public java.lang.String idBaseVoltage

The id of the attribute "baseVoltage" This id is mainly used to resolve links after parsing an instance

r0PerR

public float r0PerR

Attribute "r0PerR" Comment from profile: The ratio of zero sequence resistance to positive sequence resistance.This is for Short Circuit only.

controlArea

public ControlArea controlArea

Attribute "controlArea" Comment from profile: The control area into which the node is included.

idControlArea

public java.lang.String idControlArea

The id of the attribute "controlArea" This id is mainly used to resolve links after parsing an instance

xPerR

public float xPerR

Attribute "xPerR" Comment from profile: Ratio of positive sequence reactance per postive sequence resistance.This is for Short Circuit only.

Constructor Detail

TopologicalNode

protected TopologicalNode()

Constructor of the class TopologicalNode

Method Detail

isEquivalent

public boolean isEquivalent()

Utility to return the "equivalent" value

Returns:

the value of the attribute "equivalent"

setEquivalent

public void setEquivalent(boolean equivalentValue)

Utility to set the "equivalent" value

Parameters:

equivalentValue - value to set

equivalentIsSet

public boolean equivalentIsSet()

Utility to test if the value of "equivalent" has been set

Returns:

boolean if true the attribute "equivalent" is already set if false isn't yet

getX0PerX

public float getX0PerX()

Utility to return the "x0PerX" value

Returns:

the value of the attribute "x0PerX"

setX0PerX

public void setX0PerX(float x0PerXValue)

Utility to set the "x0PerX" value

Parameters:

x0PerXValue - value to set

x0PerXIsSet

public boolean x0PerXIsSet()

Utility to test if the value of "x0PerX" has been set

Returns:

boolean if true the attribute "x0PerX" is already set if false isn't yet

getAngleRef_TopologicalIsland

public TopologicalIsland getAngleRef_TopologicalIsland()

Utility to return the "angleRef_TopologicalIsland"

Returns:

the value of the attribute "angleRef_TopologicalIsland"

angleRef_TopologicalIslandIsSet

public boolean angleRef_TopologicalIslandIsSet()

Utility to test if the value of "angleRef_TopologicalIsland" has been set

Returns:

boolean if true the attribute "angleRef_TopologicalIsland" is already set if false it isn't yet

setAngleRef_TopologicalIsland

public void setAngleRef_TopologicalIsland(TopologicalIsland angleRef_TopologicalIslandValue,
                                          boolean setInverse)
                                   throws LinkageException

Utility to set the "angleRef_TopologicalIslandValue"

Parameters:

angleRef_TopologicalIslandValue - instance to set

setInverse - boolean to specify whether to set the inverse association or not

Throws:

LinkageException

getSvVoltage

public SvVoltage getSvVoltage()

Utility to return the "svVoltage"

Returns:

the value of the attribute "svVoltage"

svVoltageIsSet

public boolean svVoltageIsSet()

Utility to test if the value of "svVoltage" has been set

Returns:

boolean if true the attribute "svVoltage" is already set if false it isn't yet

setSvVoltage

public void setSvVoltage(SvVoltage svVoltageValue,
                         boolean setInverse)
                  throws LinkageException

Utility to set the "svVoltageValue"

Parameters:

svVoltageValue - instance to set

setInverse - boolean to specify whether to set the inverse association or not

Throws:

LinkageException

getConnectivityNodeContainer

public ConnectivityNodeContainer getConnectivityNodeContainer()

Utility to return the "connectivityNodeContainer"

Returns:

the value of the attribute "connectivityNodeContainer"

connectivityNodeContainerIsSet

public boolean connectivityNodeContainerIsSet()

Utility to test if the value of "connectivityNodeContainer" has been set

Returns:

boolean if true the attribute "connectivityNodeContainer" is already set if false it isn't yet

setConnectivityNodeContainer

public void setConnectivityNodeContainer(ConnectivityNodeContainer connectivityNodeContainerValue,
                                         boolean setInverse)
                                  throws LinkageException

Utility to set the "connectivityNodeContainerValue"

Parameters:

connectivityNodeContainerValue - instance to set

setInverse - boolean to specify whether to set the inverse association or not

Throws:

LinkageException

getTerminal

public java.util.List<Terminal> getTerminal()

Utility to return the "terminal" List of "Terminal" enum

Returns:

the list of the attributes "terminal"

addTerminal

public void addTerminal(Terminal terminalValue,
                        boolean setInverse)
                 throws LinkageException

Utility to add a value within the "terminal" ArrayList of "Terminal"

Parameters:

terminalValue - value to add within the ArrayList

setInverse - boolean to specify whether to set the inverse association or not

Throws:

LinkageException

terminalIsSet

public boolean terminalIsSet()

Utility to test if the value of "terminal" has been set

Returns:

boolean if true the attribute "terminal" is already set if false it isn't yet

getSShortCircuit

public float getSShortCircuit()

Utility to return the "sShortCircuit" value

Returns:

the value of the attribute "sShortCircuit"

setSShortCircuit

public void setSShortCircuit(float sShortCircuitValue)

Utility to set the "sShortCircuit" value

Parameters:

sShortCircuitValue - value to set

sShortCircuitIsSet

public boolean sShortCircuitIsSet()

Utility to test if the value of "sShortCircuit" has been set

Returns:

boolean if true the attribute "sShortCircuit" is already set if false isn't yet

getTopologicalIsland

public TopologicalIsland getTopologicalIsland()

Utility to return the "topologicalIsland"

Returns:

the value of the attribute "topologicalIsland"

topologicalIslandIsSet

public boolean topologicalIslandIsSet()

Utility to test if the value of "topologicalIsland" has been set

Returns:

boolean if true the attribute "topologicalIsland" is already set if false it isn't yet

setTopologicalIsland

public void setTopologicalIsland(TopologicalIsland topologicalIslandValue,
                                 boolean setInverse)
                          throws LinkageException

Utility to set the "topologicalIslandValue"

Parameters:

topologicalIslandValue - instance to set

setInverse - boolean to specify whether to set the inverse association or not

Throws:

LinkageException

getBaseVoltage

public BaseVoltage getBaseVoltage()

Utility to return the "baseVoltage"

Returns:

the value of the attribute "baseVoltage"

baseVoltageIsSet

public boolean baseVoltageIsSet()

Utility to test if the value of "baseVoltage" has been set

Returns:

boolean if true the attribute "baseVoltage" is already set if false it isn't yet

setBaseVoltage

public void setBaseVoltage(BaseVoltage baseVoltageValue,
                           boolean setInverse)
                    throws LinkageException

Utility to set the "baseVoltageValue"

Parameters:

baseVoltageValue - instance to set

setInverse - boolean to specify whether to set the inverse association or not

Throws:

LinkageException

getR0PerR

public float getR0PerR()

Utility to return the "r0PerR" value

Returns:

the value of the attribute "r0PerR"

setR0PerR

public void setR0PerR(float r0PerRValue)

Utility to set the "r0PerR" value

Parameters:

r0PerRValue - value to set

r0PerRIsSet

public boolean r0PerRIsSet()

Utility to test if the value of "r0PerR" has been set

Returns:

boolean if true the attribute "r0PerR" is already set if false isn't yet

getControlArea

public ControlArea getControlArea()

Utility to return the "controlArea"

Returns:

the value of the attribute "controlArea"

controlAreaIsSet

public boolean controlAreaIsSet()

Utility to test if the value of "controlArea" has been set

Returns:

boolean if true the attribute "controlArea" is already set if false it isn't yet

setControlArea

public void setControlArea(ControlArea controlAreaValue,
                           boolean setInverse)
                    throws LinkageException

Utility to set the "controlAreaValue"

Parameters:

controlAreaValue - instance to set

setInverse - boolean to specify whether to set the inverse association or not

Throws:

LinkageException

getXPerR

public float getXPerR()

Utility to return the "xPerR" value

Returns:

the value of the attribute "xPerR"

setXPerR

public void setXPerR(float xPerRValue)

Utility to set the "xPerR" value

Parameters:

xPerRValue - value to set

xPerRIsSet

public boolean xPerRIsSet()

Utility to test if the value of "xPerR" has been set

Returns:

boolean if true the attribute "xPerR" is already set if false isn't yet

create

public static TopologicalNode create(java.lang.String id)

Factory of the class

Parameters:

id - id of the class TopologicalNode to create

Returns:

the class created

clearContent

public void clearContent(Subset subset)

Utility to "clear" the content of a class when a subset is invalidated

Overrides:

clearContent in class IdentifiedObject

Parameters:

subset - subset to clean

readAttribute

public void readAttribute(java.lang.String class_name,
                          java.lang.String attr_name,
                          java.lang.String value,
                          CIMModel model)
                   throws InterpretationException

Utility to read an attribute This function is called by the CIMModel

Overrides:

readAttribute in class IdentifiedObject

Parameters:

class_name - the read name of class

attr_name - the read name of attribute

value - the read value of the attribute

model - the interface to the model this class belongs to

Throws:

InterpretationException

readResource

public void readResource(java.lang.String class_name,
                         java.lang.String resource_name,
                         java.lang.String id,
                         CIMModel model)
                  throws InterpretationException,
                         LinkageException

Utility to read a reference to a resource This function is called by the CIMModel

Overrides:

readResource in class IdentifiedObject

Parameters:

class_name - the read name of class

resource_name - the read name of the associated resource

id - the id of the associated resource

model - the model this class belongs to

Throws:

InterpretationException

LinkageException

write

public void write(javax.xml.stream.XMLStreamWriter xmlsw,
                  boolean writeID)

Utility to write the content into the CIM XML format

Overrides:

write in class IdentifiedObject

Parameters:

writeID - specifies whether to write the XML "id" attribute (this is used for describing concrete class)

xmlsw - XMLStreamWriter where are stored the elements to write

write

public 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

Overrides:

write in class IdentifiedObject

Parameters:

subset - the subset defining the context in which to write this class

writeID - 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 write

resolveLinks

public void resolveLinks(CIMModel model,
                         CIMModel boundaryModel)
                  throws LinkageException

Utility to resolve the links at the end of parsing

Overrides:

resolveLinks in class IdentifiedObject

Parameters:

model - the model this class belongs to

boundaryModel - the model that gather data about the boundarySet, used as a resource force links resolving

Throws:

Linkage - Exception

LinkageException

modelConsistency

public ConsistencyCheck modelConsistency(Subset subset)

Utility to check whether this class is consistent according to a subset

Overrides:

modelConsistency in class IdentifiedObject

Parameters:

subset - the subset defining the context in which to check whether this class is consistent

Returns:

a ConsistencyCheck instance whose boolean attribute (consistent) indicates if this class is consistent and whose String attribute (message) indicates why this class is not consistent if it is not

modelConsistency

public ConsistencyCheck modelConsistency()

Utility to check whether this class is consistent in a "merged" context

Overrides:

modelConsistency in class IdentifiedObject

Returns:

a ConsistencyCheck instance whose boolean attribute (consistent) indicates if this class is consistent and whose String attribute (message) indicates why this class is not consistent if it is not

copyBase

public void copyBase(TopologicalNode otherTopologicalNode)

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

Parameters:

otherTopologicalNode - the instance to copy

clearAssociations

protected void clearAssociations(Subset subset)

Utility to clear the associations of this class belonging to a specific subset

Overrides:

clearAssociations in class IdentifiedObject

Parameters:

subset - the subset from which to clear the associations of this class

clone

public TopologicalNode clone()

Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances

Overrides:

clone in class IdentifiedObject

Returns:

a clone of this instance