cim1.model

Class TapChanger

java.lang.Object

cim1.model.CIMInstance

cim1.model.IdentifiedObject

cim1.model.TapChanger

Direct Known Subclasses:

PhaseTapChanger, RatioTapChanger

public class TapChanger
extends IdentifiedObject

This file has been automatically generated by CIMGateway Description : This class "TapChanger.java" represents the class TapChanger extends IdentifiedObject + highStep 1..1 int + neutralU 1..1 float + neutralStep 1..1 int + RegulatingControl 0..1 RegulatingControl + SvTapStep 0..1 SvTapStep + stepVoltageIncrement 0..1 float + lowStep 1..1 int

Field Summary

Fields

Modifier and Type	Field and Description
int	highStep Attribute "highStep" Comment from profile: Highest possible tap step position, advance from neutral
java.lang.String	idRegulatingControl The id of the attribute "regulatingControl" This id is mainly used to resolve links after parsing an instance
java.lang.String	idSvTapStep The id of the attribute "svTapStep" This id is mainly used to resolve links after parsing an instance
int	lowStep Attribute "lowStep" Comment from profile: Lowest possible tap step position, retard from neutral
int	neutralStep Attribute "neutralStep" Comment from profile: The neutralStep value cannot be higher than the highStep value or lower than the lowStep value.
float	neutralU Attribute "neutralU" Comment from profile: Voltage at which the winding operates at the neutral tap setting.
RegulatingControl	regulatingControl
float	stepVoltageIncrement Attribute "stepVoltageIncrement" Comment from profile: This is required for RatioTapChanger.
SvTapStep	svTapStep Attribute "svTapStep" Comment from profile: The tap step state associated with the tap changer.

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

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
TapChanger	clone() Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances
void	copyBase(TapChanger otherTapChanger) 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 TapChanger	create(java.lang.String id) Factory of the class
int	getHighStep() Utility to return the "highStep" value
int	getLowStep() Utility to return the "lowStep" value
int	getNeutralStep() Utility to return the "neutralStep" value
float	getNeutralU() Utility to return the "neutralU" value
RegulatingControl	getRegulatingControl() Utility to return the "regulatingControl"
float	getStepVoltageIncrement() Utility to return the "stepVoltageIncrement" value
SvTapStep	getSvTapStep() Utility to return the "svTapStep"
boolean	highStepIsSet() Utility to test if the value of "highStep" has been set
boolean	lowStepIsSet() Utility to test if the value of "lowStep" has been set
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	neutralStepIsSet() Utility to test if the value of "neutralStep" has been set
boolean	neutralUIsSet() Utility to test if the value of "neutralU" 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
void	setHighStep(int highStepValue) Utility to set the "highStep" value
void	setLowStep(int lowStepValue) Utility to set the "lowStep" value
void	setNeutralStep(int neutralStepValue) Utility to set the "neutralStep" value
void	setNeutralU(float neutralUValue) Utility to set the "neutralU" value
void	setRegulatingControl(RegulatingControl regulatingControlValue, boolean setInverse) Utility to set the "regulatingControlValue"
void	setStepVoltageIncrement(float stepVoltageIncrementValue) Utility to set the "stepVoltageIncrement" value
void	setSvTapStep(SvTapStep svTapStepValue, boolean setInverse) Utility to set the "svTapStepValue"
boolean	stepVoltageIncrementIsSet() Utility to test if the value of "stepVoltageIncrement" has been set
boolean	svTapStepIsSet() Utility to test if the value of "svTapStep" 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

highStep

public int highStep

Attribute "highStep" Comment from profile: Highest possible tap step position, advance from neutral

neutralU

public float neutralU

Attribute "neutralU" Comment from profile: Voltage at which the winding operates at the neutral tap setting.

neutralStep

public int neutralStep

Attribute "neutralStep" Comment from profile: The neutralStep value cannot be higher than the highStep value or lower than the lowStep value.

regulatingControl

public RegulatingControl regulatingControl

idRegulatingControl

public java.lang.String idRegulatingControl

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

svTapStep

public SvTapStep svTapStep

Attribute "svTapStep" Comment from profile: The tap step state associated with the tap changer.

idSvTapStep

public java.lang.String idSvTapStep

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

stepVoltageIncrement

public float stepVoltageIncrement

Attribute "stepVoltageIncrement" Comment from profile: This is required for RatioTapChanger. It is Optional for most phase shifters since these are not used to regulate voltages

lowStep

public int lowStep

Attribute "lowStep" Comment from profile: Lowest possible tap step position, retard from neutral

Constructor Detail

TapChanger

protected TapChanger()

Constructor of the class TapChanger

Method Detail

getHighStep

public int getHighStep()

Utility to return the "highStep" value

Returns:

the value of the attribute "highStep"

setHighStep

public void setHighStep(int highStepValue)

Utility to set the "highStep" value

Parameters:

highStepValue - value to set

highStepIsSet

public boolean highStepIsSet()

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

Returns:

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

getNeutralU

public float getNeutralU()

Utility to return the "neutralU" value

Returns:

the value of the attribute "neutralU"

setNeutralU

public void setNeutralU(float neutralUValue)

Utility to set the "neutralU" value

Parameters:

neutralUValue - value to set

neutralUIsSet

public boolean neutralUIsSet()

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

Returns:

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

getNeutralStep

public int getNeutralStep()

Utility to return the "neutralStep" value

Returns:

the value of the attribute "neutralStep"

setNeutralStep

public void setNeutralStep(int neutralStepValue)

Utility to set the "neutralStep" value

Parameters:

neutralStepValue - value to set

neutralStepIsSet

public boolean neutralStepIsSet()

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

Returns:

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

getRegulatingControl

public RegulatingControl getRegulatingControl()

Utility to return the "regulatingControl"

Returns:

the value of the attribute "regulatingControl"

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

setRegulatingControl

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

Utility to set the "regulatingControlValue"

Parameters:

regulatingControlValue - instance to set

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

Throws:

LinkageException

getSvTapStep

public SvTapStep getSvTapStep()

Utility to return the "svTapStep"

Returns:

the value of the attribute "svTapStep"

svTapStepIsSet

public boolean svTapStepIsSet()

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

Returns:

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

setSvTapStep

public void setSvTapStep(SvTapStep svTapStepValue,
                         boolean setInverse)
                  throws LinkageException

Utility to set the "svTapStepValue"

Parameters:

svTapStepValue - instance to set

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

Throws:

LinkageException

getStepVoltageIncrement

public float getStepVoltageIncrement()

Utility to return the "stepVoltageIncrement" value

Returns:

the value of the attribute "stepVoltageIncrement"

setStepVoltageIncrement

public void setStepVoltageIncrement(float stepVoltageIncrementValue)

Utility to set the "stepVoltageIncrement" value

Parameters:

stepVoltageIncrementValue - value to set

stepVoltageIncrementIsSet

public boolean stepVoltageIncrementIsSet()

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

Returns:

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

getLowStep

public int getLowStep()

Utility to return the "lowStep" value

Returns:

the value of the attribute "lowStep"

setLowStep

public void setLowStep(int lowStepValue)

Utility to set the "lowStep" value

Parameters:

lowStepValue - value to set

lowStepIsSet

public boolean lowStepIsSet()

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

Returns:

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

create

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

Factory of the class

Parameters:

id - id of the class TapChanger 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(TapChanger otherTapChanger)

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:

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