cim1.model

Class PhaseTapChanger

java.lang.Object

cim1.model.CIMInstance

cim1.model.IdentifiedObject

cim1.model.TapChanger

cim1.model.PhaseTapChanger

public class PhaseTapChanger
extends TapChanger

This file has been automatically generated by CIMGateway Description : This class "PhaseTapChanger.java" represents the class PhaseTapChanger extends TapChanger + windingConnectionAngle 0..1 float + voltageStepIncrementOutOfPhase 0..1 float + phaseTapChangerType 1..1 PhaseTapChangerKind + stepPhaseShiftIncrement 0..1 float + TransformerWinding 1..1 TransformerWinding + xStepMin 0..1 float + xStepMax 0..1 float

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	idTransformerWinding The id of the attribute "transformerWinding" This id is mainly used to resolve links after parsing an instance
PhaseTapChangerKind	phaseTapChangerType Attribute "phaseTapChangerType" Comment from profile: The type of phase shifter construction.
float	stepPhaseShiftIncrement Attribute "stepPhaseShiftIncrement" Comment from profile: Phase shift per step position.
TransformerWinding	transformerWinding Attribute "transformerWinding" Comment from profile: The transformer winding to which the phase tap changer belongs.
float	voltageStepIncrementOutOfPhase Attribute "voltageStepIncrementOutOfPhase" Comment from profile: The voltage step increment on the out of phase winding.
float	windingConnectionAngle Attribute "windingConnectionAngle" Comment from profile: The phase angle between the in-phase winding and the out-of -phase winding used for creating phase shift.
float	xStepMax Attribute "xStepMax" Comment from profile: The reactance at the maximum tap step.
float	xStepMin Attribute "xStepMin" Comment from profile: The reactance at the minimum tap step.

Fields inherited from class cim1.model.TapChanger

highStep, idRegulatingControl, idSvTapStep, lowStep, neutralStep, neutralU, regulatingControl, stepVoltageIncrement, svTapStep

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

Method Summary

Modifier and Type	Method and Description
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
PhaseTapChanger	clone() Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances
void	copyBase(PhaseTapChanger otherPhaseTapChanger) 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 PhaseTapChanger	create(java.lang.String id) Factory of the class
PhaseTapChangerKind	getPhaseTapChangerType() Utility to return the "phaseTapChangerType" enum
float	getStepPhaseShiftIncrement() Utility to return the "stepPhaseShiftIncrement" value
TransformerWinding	getTransformerWinding() Utility to return the "transformerWinding"
float	getVoltageStepIncrementOutOfPhase() Utility to return the "voltageStepIncrementOutOfPhase" value
float	getWindingConnectionAngle() Utility to return the "windingConnectionAngle" value
float	getXStepMax() Utility to return the "xStepMax" value
float	getXStepMin() Utility to return the "xStepMin" 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	phaseTapChangerTypeIsSet() Utility to test if the value of "phaseTapChangerType" 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	setPhaseTapChangerType(PhaseTapChangerKind phaseTapChangerTypeValue) Utility to set the "phaseTapChangerType" enum
void	setStepPhaseShiftIncrement(float stepPhaseShiftIncrementValue) Utility to set the "stepPhaseShiftIncrement" value
void	setTransformerWinding(TransformerWinding transformerWindingValue, boolean setInverse) Utility to set the "transformerWindingValue"
void	setVoltageStepIncrementOutOfPhase(float voltageStepIncrementOutOfPhaseValue) Utility to set the "voltageStepIncrementOutOfPhase" value
void	setWindingConnectionAngle(float windingConnectionAngleValue) Utility to set the "windingConnectionAngle" value
void	setXStepMax(float xStepMaxValue) Utility to set the "xStepMax" value
void	setXStepMin(float xStepMinValue) Utility to set the "xStepMin" value
boolean	stepPhaseShiftIncrementIsSet() Utility to test if the value of "stepPhaseShiftIncrement" has been set
boolean	transformerWindingIsSet() Utility to test if the value of "transformerWinding" has been set
boolean	voltageStepIncrementOutOfPhaseIsSet() Utility to test if the value of "voltageStepIncrementOutOfPhase" has been set
boolean	windingConnectionAngleIsSet() Utility to test if the value of "windingConnectionAngle" 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	xStepMaxIsSet() Utility to test if the value of "xStepMax" has been set
boolean	xStepMinIsSet() Utility to test if the value of "xStepMin" has been set

Methods inherited from class cim1.model.TapChanger

copyBase, getHighStep, getLowStep, getNeutralStep, getNeutralU, getRegulatingControl, getStepVoltageIncrement, getSvTapStep, highStepIsSet, lowStepIsSet, neutralStepIsSet, neutralUIsSet, regulatingControlIsSet, setHighStep, setLowStep, setNeutralStep, setNeutralU, setRegulatingControl, setStepVoltageIncrement, setSvTapStep, stepVoltageIncrementIsSet, svTapStepIsSet

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

windingConnectionAngle

public float windingConnectionAngle

Attribute "windingConnectionAngle" Comment from profile: The phase angle between the in-phase winding and the out-of -phase winding used for creating phase shift. It is only possible to have a symmemtrical transformer if this angle is 90 degrees.This is required if PST is Asymmetrical

voltageStepIncrementOutOfPhase

public float voltageStepIncrementOutOfPhase

Attribute "voltageStepIncrementOutOfPhase" Comment from profile: The voltage step increment on the out of phase winding. This voltage step on the out of phase winding of the phase shifter. Similar to TapChanger.voltageStepIncrement, but it is applied only to the out of phase winding.This is required if PST is Asymmetrical.

phaseTapChangerType

public PhaseTapChangerKind phaseTapChangerType

Attribute "phaseTapChangerType" Comment from profile: The type of phase shifter construction.

stepPhaseShiftIncrement

public float stepPhaseShiftIncrement

Attribute "stepPhaseShiftIncrement" Comment from profile: Phase shift per step position. A positive value indicates a positive phase shift from the winding where the tap is located to the other winding (for a two-winding transformer).The actual phase shift increment might be more accureatly computed from the symmetrical or asymmetrical models or a tap step table lookup if those are available.

transformerWinding

public TransformerWinding transformerWinding

Attribute "transformerWinding" Comment from profile: The transformer winding to which the phase tap changer belongs.

idTransformerWinding

public java.lang.String idTransformerWinding

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

xStepMin

public float xStepMin

Attribute "xStepMin" Comment from profile: The reactance at the minimum tap step.

xStepMax

public float xStepMax

Attribute "xStepMax" Comment from profile: The reactance at the maximum tap step.

Constructor Detail

PhaseTapChanger

protected PhaseTapChanger()

Constructor of the class PhaseTapChanger

Method Detail

getWindingConnectionAngle

public float getWindingConnectionAngle()

Utility to return the "windingConnectionAngle" value

Returns:

the value of the attribute "windingConnectionAngle"

setWindingConnectionAngle

public void setWindingConnectionAngle(float windingConnectionAngleValue)

Utility to set the "windingConnectionAngle" value

Parameters:

windingConnectionAngleValue - value to set

windingConnectionAngleIsSet

public boolean windingConnectionAngleIsSet()

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

Returns:

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

getVoltageStepIncrementOutOfPhase

public float getVoltageStepIncrementOutOfPhase()

Utility to return the "voltageStepIncrementOutOfPhase" value

Returns:

the value of the attribute "voltageStepIncrementOutOfPhase"

setVoltageStepIncrementOutOfPhase

public void setVoltageStepIncrementOutOfPhase(float voltageStepIncrementOutOfPhaseValue)

Utility to set the "voltageStepIncrementOutOfPhase" value

Parameters:

voltageStepIncrementOutOfPhaseValue - value to set

voltageStepIncrementOutOfPhaseIsSet

public boolean voltageStepIncrementOutOfPhaseIsSet()

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

Returns:

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

getPhaseTapChangerType

public PhaseTapChangerKind getPhaseTapChangerType()

Utility to return the "phaseTapChangerType" enum

Returns:

the value of the attribute "phaseTapChangerType"

setPhaseTapChangerType

public void setPhaseTapChangerType(PhaseTapChangerKind phaseTapChangerTypeValue)

Utility to set the "phaseTapChangerType" enum

Parameters:

phaseTapChangerTypeValue - operand to set

phaseTapChangerTypeIsSet

public boolean phaseTapChangerTypeIsSet()

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

Returns:

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

getStepPhaseShiftIncrement

public float getStepPhaseShiftIncrement()

Utility to return the "stepPhaseShiftIncrement" value

Returns:

the value of the attribute "stepPhaseShiftIncrement"

setStepPhaseShiftIncrement

public void setStepPhaseShiftIncrement(float stepPhaseShiftIncrementValue)

Utility to set the "stepPhaseShiftIncrement" value

Parameters:

stepPhaseShiftIncrementValue - value to set

stepPhaseShiftIncrementIsSet

public boolean stepPhaseShiftIncrementIsSet()

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

Returns:

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

getTransformerWinding

public TransformerWinding getTransformerWinding()

Utility to return the "transformerWinding"

Returns:

the value of the attribute "transformerWinding"

transformerWindingIsSet

public boolean transformerWindingIsSet()

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

Returns:

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

setTransformerWinding

public void setTransformerWinding(TransformerWinding transformerWindingValue,
                                  boolean setInverse)
                           throws LinkageException

Utility to set the "transformerWindingValue"

Parameters:

transformerWindingValue - instance to set

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

Throws:

LinkageException

getXStepMin

public float getXStepMin()

Utility to return the "xStepMin" value

Returns:

the value of the attribute "xStepMin"

setXStepMin

public void setXStepMin(float xStepMinValue)

Utility to set the "xStepMin" value

Parameters:

xStepMinValue - value to set

xStepMinIsSet

public boolean xStepMinIsSet()

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

Returns:

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

getXStepMax

public float getXStepMax()

Utility to return the "xStepMax" value

Returns:

the value of the attribute "xStepMax"

setXStepMax

public void setXStepMax(float xStepMaxValue)

Utility to set the "xStepMax" value

Parameters:

xStepMaxValue - value to set

xStepMaxIsSet

public boolean xStepMaxIsSet()

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

Returns:

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

create

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

Factory of the class

Parameters:

id - id of the class PhaseTapChanger 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 TapChanger

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 TapChanger

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 TapChanger

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 TapChanger

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 TapChanger

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 TapChanger

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 TapChanger

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 TapChanger

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(PhaseTapChanger otherPhaseTapChanger)

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:

otherPhaseTapChanger - 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 TapChanger

Parameters:

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

clone

public PhaseTapChanger 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 TapChanger

Returns:

a clone of this instance