cim1.model

Class Terminal

java.lang.Object

cim1.model.CIMInstance

cim1.model.IdentifiedObject

cim1.model.Terminal

public class Terminal
extends IdentifiedObject

This file has been automatically generated by CIMGateway Description : This class "Terminal.java" represents the class Terminal extends IdentifiedObject + HasSecond_MutualCoupling 0..-1 MutualCoupling (inverseAssociation) + sequenceNumber 0..1 int + TieFlow 0..2 TieFlow + TopologicalNode 1..1 TopologicalNode + RegulatingControl 0..-1 RegulatingControl (inverseAssociation) + SvPowerFlow 0..1 SvPowerFlow + ConductingEquipment 1..1 ConductingEquipment + connected 1..1 boolean + OperationalLimitSet 0..-1 OperationalLimitSet (inverseAssociation) + HasFirst_MutualCoupling 0..-1 MutualCoupling (inverseAssociation)

Field Summary

Fields

Modifier and Type	Field and Description
ConductingEquipment	conductingEquipment Attribute "conductingEquipment" Comment from profile: ConductingEquipment has 1 or 2 terminals that may be connected to other ConductingEquipment terminals via ConnectivityNodes
boolean	connected Attribute "connected" Comment from profile: The terminal connection status.
java.util.List<MutualCoupling>	hasFirst_MutualCoupling Attribute "hasFirst_MutualCoupling" Comment from profile: Mutual couplings associated with the branch as the first branch.
java.util.List<MutualCoupling>	hasSecond_MutualCoupling Attribute "hasSecond_MutualCoupling" Comment from profile: Mutual couplings with the branch associated as the first branch.
java.lang.String	idConductingEquipment The id of the attribute "conductingEquipment" This id is mainly used to resolve links after parsing an instance
java.lang.String	idSvPowerFlow The id of the attribute "svPowerFlow" This id is mainly used to resolve links after parsing an instance
java.lang.String	idTopologicalNode The id of the attribute "topologicalNode" This id is mainly used to resolve links after parsing an instance
java.util.List<OperationalLimitSet>	operationalLimitSet Attribute "operationalLimitSet" Comment from profile: The operatinal limits sets that applie specifically to this terminal.
java.util.List<RegulatingControl>	regulatingControl Attribute "regulatingControl" Comment from profile: The terminal is regulated by a control.
int	sequenceNumber Attribute "sequenceNumber" Comment from profile: The orientation of the terminal connections for a multiple terminal conducting equipment.
SvPowerFlow	svPowerFlow Attribute "svPowerFlow" Comment from profile: The power flow state associated with the terminal.
java.util.List<TieFlow>	tieFlow Attribute "tieFlow" Comment from profile: The control area tie flows to which this terminal associates.
TopologicalNode	topologicalNode Attribute "topologicalNode" Comment from profile: The topological node associated with the terminal.

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	Terminal() Constructor of the class Terminal

Method Summary

Modifier and Type	Method and Description
void	addHasFirst_MutualCoupling(MutualCoupling hasFirst_MutualCouplingValue, boolean setInverse) Utility to add a value within the "hasFirst_MutualCoupling" ArrayList of "MutualCoupling"
void	addHasSecond_MutualCoupling(MutualCoupling hasSecond_MutualCouplingValue, boolean setInverse) Utility to add a value within the "hasSecond_MutualCoupling" ArrayList of "MutualCoupling"
void	addOperationalLimitSet(OperationalLimitSet operationalLimitSetValue, boolean setInverse) Utility to add a value within the "operationalLimitSet" ArrayList of "OperationalLimitSet"
void	addRegulatingControl(RegulatingControl regulatingControlValue, boolean setInverse) Utility to add a value within the "regulatingControl" ArrayList of "RegulatingControl"
void	addTieFlow(TieFlow tieFlowValue, boolean setInverse) Utility to add a value within the "tieFlow" ArrayList of "TieFlow"
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
Terminal	clone() Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances
boolean	conductingEquipmentIsSet() Utility to test if the value of "conductingEquipment" has been set
boolean	connectedIsSet() Utility to test if the value of "connected" has been set
void	copyBase(Terminal otherTerminal) 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 Terminal	create(java.lang.String id) Factory of the class
ConductingEquipment	getConductingEquipment() Utility to return the "conductingEquipment"
java.util.List<MutualCoupling>	getHasFirst_MutualCoupling() Utility to return the "hasFirst_MutualCoupling" List of "MutualCoupling" enum
java.util.List<MutualCoupling>	getHasSecond_MutualCoupling() Utility to return the "hasSecond_MutualCoupling" List of "MutualCoupling" enum
java.util.List<OperationalLimitSet>	getOperationalLimitSet() Utility to return the "operationalLimitSet" List of "OperationalLimitSet" enum
java.util.List<RegulatingControl>	getRegulatingControl() Utility to return the "regulatingControl" List of "RegulatingControl" enum
int	getSequenceNumber() Utility to return the "sequenceNumber" value
SvPowerFlow	getSvPowerFlow() Utility to return the "svPowerFlow"
java.util.List<TieFlow>	getTieFlow() Utility to return the "tieFlow" List of "TieFlow" enum
TopologicalNode	getTopologicalNode() Utility to return the "topologicalNode"
boolean	hasFirst_MutualCouplingIsSet() Utility to test if the value of "hasFirst_MutualCoupling" has been set
boolean	hasSecond_MutualCouplingIsSet() Utility to test if the value of "hasSecond_MutualCoupling" has been set
boolean	isConnected() Utility to return the "connected" 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	operationalLimitSetIsSet() Utility to test if the value of "operationalLimitSet" 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
boolean	regulatingControlIsSet() Utility to test if the value of "regulatingControl" has been set
void	resolveLinks(CIMModel model, CIMModel boundaryModel) Utility to resolve the links at the end of parsing
boolean	sequenceNumberIsSet() Utility to test if the value of "sequenceNumber" has been set
void	setConductingEquipment(ConductingEquipment conductingEquipmentValue, boolean setInverse) Utility to set the "conductingEquipmentValue"
void	setConnected(boolean connectedValue) Utility to set the "connected" value
void	setSequenceNumber(int sequenceNumberValue) Utility to set the "sequenceNumber" value
void	setSvPowerFlow(SvPowerFlow svPowerFlowValue, boolean setInverse) Utility to set the "svPowerFlowValue"
void	setTopologicalNode(TopologicalNode topologicalNodeValue, boolean setInverse) Utility to set the "topologicalNodeValue"
boolean	svPowerFlowIsSet() Utility to test if the value of "svPowerFlow" has been set
boolean	tieFlowIsSet() Utility to test if the value of "tieFlow" has been set
boolean	topologicalNodeIsSet() Utility to test if the value of "topologicalNode" 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

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

hasSecond_MutualCoupling

public java.util.List<MutualCoupling> hasSecond_MutualCoupling

Attribute "hasSecond_MutualCoupling" Comment from profile: Mutual couplings with the branch associated as the first branch.

sequenceNumber

public int sequenceNumber

Attribute "sequenceNumber" Comment from profile: The orientation of the terminal connections for a multiple terminal conducting equipment. The sequence numbering starts with 1 and additional terminals should follow in increasing order. The first terminal is the "starting point" for a two terminal branch. In the case of class TransformerWinding only one terminal is used so its sequenceNumber must be 1.

tieFlow

public java.util.List<TieFlow> tieFlow

Attribute "tieFlow" Comment from profile: The control area tie flows to which this terminal associates.

topologicalNode

public TopologicalNode topologicalNode

Attribute "topologicalNode" Comment from profile: The topological node associated with the terminal. This can be used as an alternative to the connectivity node path to topological node, 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.

idTopologicalNode

public java.lang.String idTopologicalNode

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

regulatingControl

public java.util.List<RegulatingControl> regulatingControl

Attribute "regulatingControl" Comment from profile: The terminal is regulated by a control.

svPowerFlow

public SvPowerFlow svPowerFlow

Attribute "svPowerFlow" Comment from profile: The power flow state associated with the terminal.

idSvPowerFlow

public java.lang.String idSvPowerFlow

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

conductingEquipment

public ConductingEquipment conductingEquipment

Attribute "conductingEquipment" Comment from profile: ConductingEquipment has 1 or 2 terminals that may be connected to other ConductingEquipment terminals via ConnectivityNodes

idConductingEquipment

public java.lang.String idConductingEquipment

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

connected

public boolean connected

Attribute "connected" Comment from profile: The terminal connection status. True implies the terminal is connected, and false implies the terminal is not connected. This is the result of topoplogical processing of a detailed Connectivity node and Switch model whether present in the model or not. A terminal that is not connected cannot support a current flow. A terminal that is connected may have flow. In general a multi-terminal device may simultaneously have connected and disconnected terminals. No other aspect of the algorithm for topological analysis is implied.

operationalLimitSet

public java.util.List<OperationalLimitSet> operationalLimitSet

Attribute "operationalLimitSet" Comment from profile: The operatinal limits sets that applie specifically to this terminal. Other operational limits sets may apply to this terminal through the association to Equipment.

hasFirst_MutualCoupling

public java.util.List<MutualCoupling> hasFirst_MutualCoupling

Attribute "hasFirst_MutualCoupling" Comment from profile: Mutual couplings associated with the branch as the first branch.

Constructor Detail

Terminal

protected Terminal()

Constructor of the class Terminal

Method Detail

getHasSecond_MutualCoupling

public java.util.List<MutualCoupling> getHasSecond_MutualCoupling()

Utility to return the "hasSecond_MutualCoupling" List of "MutualCoupling" enum

Returns:

the list of the attributes "hasSecond_MutualCoupling"

addHasSecond_MutualCoupling

public void addHasSecond_MutualCoupling(MutualCoupling hasSecond_MutualCouplingValue,
                                        boolean setInverse)
                                 throws LinkageException

Utility to add a value within the "hasSecond_MutualCoupling" ArrayList of "MutualCoupling"

Parameters:

hasSecond_MutualCouplingValue - value to add within the ArrayList

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

Throws:

LinkageException

hasSecond_MutualCouplingIsSet

public boolean hasSecond_MutualCouplingIsSet()

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

Returns:

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

getSequenceNumber

public int getSequenceNumber()

Utility to return the "sequenceNumber" value

Returns:

the value of the attribute "sequenceNumber"

setSequenceNumber

public void setSequenceNumber(int sequenceNumberValue)

Utility to set the "sequenceNumber" value

Parameters:

sequenceNumberValue - value to set

sequenceNumberIsSet

public boolean sequenceNumberIsSet()

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

Returns:

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

getTieFlow

public java.util.List<TieFlow> getTieFlow()

Utility to return the "tieFlow" List of "TieFlow" enum

Returns:

the list of the attributes "tieFlow"

addTieFlow

public void addTieFlow(TieFlow tieFlowValue,
                       boolean setInverse)
                throws LinkageException

Utility to add a value within the "tieFlow" ArrayList of "TieFlow"

Parameters:

tieFlowValue - value to add within the ArrayList

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

Throws:

LinkageException

tieFlowIsSet

public boolean tieFlowIsSet()

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

Returns:

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

getTopologicalNode

public TopologicalNode getTopologicalNode()

Utility to return the "topologicalNode"

Returns:

the value of the attribute "topologicalNode"

topologicalNodeIsSet

public boolean topologicalNodeIsSet()

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

Returns:

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

setTopologicalNode

public void setTopologicalNode(TopologicalNode topologicalNodeValue,
                               boolean setInverse)
                        throws LinkageException

Utility to set the "topologicalNodeValue"

Parameters:

topologicalNodeValue - instance to set

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

Throws:

LinkageException

getRegulatingControl

public java.util.List<RegulatingControl> getRegulatingControl()

Utility to return the "regulatingControl" List of "RegulatingControl" enum

Returns:

the list of the attributes "regulatingControl"

addRegulatingControl

public void addRegulatingControl(RegulatingControl regulatingControlValue,
                                 boolean setInverse)
                          throws LinkageException

Utility to add a value within the "regulatingControl" ArrayList of "RegulatingControl"

Parameters:

regulatingControlValue - value to add within the ArrayList

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

Throws:

LinkageException

regulatingControlIsSet

public boolean regulatingControlIsSet()

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

Returns:

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

getSvPowerFlow

public SvPowerFlow getSvPowerFlow()

Utility to return the "svPowerFlow"

Returns:

the value of the attribute "svPowerFlow"

svPowerFlowIsSet

public boolean svPowerFlowIsSet()

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

Returns:

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

setSvPowerFlow

public void setSvPowerFlow(SvPowerFlow svPowerFlowValue,
                           boolean setInverse)
                    throws LinkageException

Utility to set the "svPowerFlowValue"

Parameters:

svPowerFlowValue - instance to set

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

Throws:

LinkageException

getConductingEquipment

public ConductingEquipment getConductingEquipment()

Utility to return the "conductingEquipment"

Returns:

the value of the attribute "conductingEquipment"

conductingEquipmentIsSet

public boolean conductingEquipmentIsSet()

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

Returns:

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

setConductingEquipment

public void setConductingEquipment(ConductingEquipment conductingEquipmentValue,
                                   boolean setInverse)
                            throws LinkageException

Utility to set the "conductingEquipmentValue"

Parameters:

conductingEquipmentValue - instance to set

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

Throws:

LinkageException

isConnected

public boolean isConnected()

Utility to return the "connected" value

Returns:

the value of the attribute "connected"

setConnected

public void setConnected(boolean connectedValue)

Utility to set the "connected" value

Parameters:

connectedValue - value to set

connectedIsSet

public boolean connectedIsSet()

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

Returns:

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

getOperationalLimitSet

public java.util.List<OperationalLimitSet> getOperationalLimitSet()

Utility to return the "operationalLimitSet" List of "OperationalLimitSet" enum

Returns:

the list of the attributes "operationalLimitSet"

addOperationalLimitSet

public void addOperationalLimitSet(OperationalLimitSet operationalLimitSetValue,
                                   boolean setInverse)
                            throws LinkageException

Utility to add a value within the "operationalLimitSet" ArrayList of "OperationalLimitSet"

Parameters:

operationalLimitSetValue - value to add within the ArrayList

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

Throws:

LinkageException

operationalLimitSetIsSet

public boolean operationalLimitSetIsSet()

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

Returns:

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

getHasFirst_MutualCoupling

public java.util.List<MutualCoupling> getHasFirst_MutualCoupling()

Utility to return the "hasFirst_MutualCoupling" List of "MutualCoupling" enum

Returns:

the list of the attributes "hasFirst_MutualCoupling"

addHasFirst_MutualCoupling

public void addHasFirst_MutualCoupling(MutualCoupling hasFirst_MutualCouplingValue,
                                       boolean setInverse)
                                throws LinkageException

Utility to add a value within the "hasFirst_MutualCoupling" ArrayList of "MutualCoupling"

Parameters:

hasFirst_MutualCouplingValue - value to add within the ArrayList

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

Throws:

LinkageException

hasFirst_MutualCouplingIsSet

public boolean hasFirst_MutualCouplingIsSet()

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

Returns:

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

create

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

Factory of the class

Parameters:

id - id of the class Terminal 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(Terminal otherTerminal)

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:

otherTerminal - 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 Terminal 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