com.interpss.core.aclf.adj

Interface TapControl

All Superinterfaces:

BaseBusBranchControl, BranchFlowControl, com.hazelcast.nio.serialization.DataSerializable, org.eclipse.emf.ecore.EObject, IAclfAdjustment, NameTag, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

TapControlImpl

public interface TapControl
extends BranchFlowControl

A representation of the model object 'Tap VControl'. TapControl is designed to use transformer tap (on the from side or to side) to control a remote bus voltage or the branch Q flow of the parent Xfr. The bus could be the transformer's terminal bus or any bus in the network. For the branch Q flow control, the branch has to the transformer itself.

The following features are supported:

• Tap Control Type
• Tap Step Size
• Tap Steps
• Compensate Z
• Vc Gen PV Bus
• Vc Bus Id
• Vc Bus

See Also:

AclfAdjustPackage.getTapControl()

Method Summary

Modifier and Type	Method and Description
org.apache.commons.math3.complex.Complex	getCompensateZ() Returns the value of the 'Compensate Z' attribute.
double	getMvarFlowCalculated(Unit.UnitType unit, double baseKva) Get mvar flow calculated in the unit specified
double	getMvarSpecified() Get mvar control specification in the PU
double	getMvarSpecified(Unit.UnitType unit, double baseKva) Get mvar control specification in the unit specified
BusBranchControlType	getTapControlType() Returns the value of the 'Tap Control Type' attribute.
int	getTapSteps() Returns the value of the 'Tap Steps' attribute.
double	getTapStepSize() Returns the value of the 'Tap Step Size' attribute.
LimitType	getTurnRatioLimit() get xfr turn ratio limit
BaseAclfBus<?,?>	getVcBus() Returns the value of the 'Vc Bus' reference.
java.lang.String	getVcBusId() Returns the value of the 'Vc Bus Id' attribute.
double	getVSpecified() get Voltage control specification
double	getVSpecified(Unit.UnitType unit) Get voltage control specification in the unit specified
boolean	isVcBusOnFromSide() Check if the Voltage Control bus is on the from side.
boolean	isVcGenPVBus() Returns the value of the 'Vc Gen PV Bus' attribute.
void	setCompensateZ(org.apache.commons.math3.complex.Complex value) Sets the value of the 'Compensate Z' attribute.
void	setMvarSpecified(double q) Set Mvar control specification in PU
void	setMvarSpecified(double q, Unit.UnitType unit, double baseKva) Set Mvar specification in the unit specified
void	setTapControlType(BusBranchControlType value) Sets the value of the 'Tap Control Type' attribute.
void	setTapSteps(int value) Sets the value of the 'Tap Steps' attribute.
void	setTapStepSize(double value) Sets the value of the 'Tap Step Size' attribute.
void	setTurnRatioLimit(LimitType limit) Set xfr turn ratio limit
void	setVcBus(BaseAclfBus<?,?> value) Sets the value of the 'Vc Bus' reference.
void	setVcBusId(java.lang.String value) Sets the value of the 'Vc Bus Id' attribute.
void	setVcBusOnFromSide(boolean b) Set the side of the control bus, who's voltge to be controlled.
void	setVcGenPVBus(boolean value) Sets the value of the 'Vc Gen PV Bus' attribute.
void	setVSpecified(double v) Set voltage control specified in PU
void	setVSpecified(double v, Unit.UnitType unit) Set voltage control specification in the unit specified

Methods inherited from interface com.interpss.core.aclf.adj.BranchFlowControl

getControlLimit, getControlSpec, getParentBranch, isControlOnFromSide, isFlowFrom2To, isMeteredOnFromSide, setControlLimit, setControlOnFromSide, setControlSpec, setFlowFrom2To, setMeteredOnFromSide, setParentBranch

Methods inherited from interface com.interpss.core.aclf.adj.BaseBusBranchControl

getAdjControlType, getControlMode, getDesiredControlRange, isAdjustStatus, isControlStatus, setAdjControlType, setAdjustStatus, setControlMode, setControlStatus, setDesiredControlRange

Methods inherited from interface com.interpss.core.net.NameTag

checkData, checkData, getDesc, getId, getName, getNumber, getStatusChangeInfo, hzCopy, isActive, isStatus, jsonCopy, setDesc, setId, setName, setNumber, setStatus, setStatusChangeInfo

Methods inherited from interface com.hazelcast.nio.serialization.DataSerializable

readData, writeData

Methods inherited from interface com.interpss.core.aclf.adj.IAclfAdjustment

needAdjust, performAdjust

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getTapControlType

BusBranchControlType getTapControlType()

Returns the value of the 'Tap Control Type' attribute. The default value is "BusVoltage". The literals are from the enumeration BusBranchControlType.

If the meaning of the 'Control Type' attribute isn't clear, there really should be more of a description here...

Tap control type, BusVoltage | MvarFlow

Returns:

the value of the 'Tap Control Type' attribute.

See Also:

BusBranchControlType, setTapControlType(BusBranchControlType), AclfAdjustPackage.getTapControl_TapControlType()

setTapControlType

void setTapControlType(BusBranchControlType value)

Sets the value of the 'Tap Control Type' attribute.

Parameters:

value - the new value of the 'Tap Control Type' attribute.

See Also:

BusBranchControlType, getTapControlType()

isVcBusOnFromSide

boolean isVcBusOnFromSide()

Check if the Voltage Control bus is on the from side.

setVcBusOnFromSide

void setVcBusOnFromSide(boolean b)

Set the side of the control bus, who's voltge to be controlled. BranchFlowControl.meteredOnFromSide is used to hold the value

Parameters:

b - boolean value

getTurnRatioLimit

LimitType getTurnRatioLimit()

get xfr turn ratio limit

getVSpecified

double getVSpecified()

get Voltage control specification

getVSpecified

double getVSpecified(Unit.UnitType unit)

Get voltage control specification in the unit specified

Parameters:

unit - voltage unit

setTurnRatioLimit

void setTurnRatioLimit(LimitType limit)

Set xfr turn ratio limit

setVSpecified

void setVSpecified(double v)

Set voltage control specified in PU

Parameters:

v - votage specified

setVSpecified

void setVSpecified(double v,
                   Unit.UnitType unit)

Set voltage control specification in the unit specified

Parameters:

v - voltage specified

unit - voltage unit

getTapStepSize

double getTapStepSize()

Returns the value of the 'Tap Step Size' attribute. The default value is "0.0". 0 if continous tap adjustment

Returns:

the value of the 'Tap Step Size' attribute.

See Also:

setTapStepSize(double), AclfAdjustPackage.getTapControl_TapStepSize()

setTapStepSize

void setTapStepSize(double value)

Sets the value of the 'Tap Step Size' attribute.

Parameters:

value - the new value of the 'Tap Step Size' attribute.

See Also:

getTapStepSize()

getTapSteps

int getTapSteps()

Returns the value of the 'Tap Steps' attribute. The default value is "20". number of steps for the tap adjustment

Returns:

the value of the 'Tap Steps' attribute.

See Also:

setTapSteps(int), AclfAdjustPackage.getTapControl_TapSteps()

setTapSteps

void setTapSteps(int value)

Sets the value of the 'Tap Steps' attribute.

Parameters:

value - the new value of the 'Tap Steps' attribute.

See Also:

getTapSteps()

getCompensateZ

org.apache.commons.math3.complex.Complex getCompensateZ()

Returns the value of the 'Compensate Z' attribute.

If the meaning of the 'Compensate Z' attribute isn't clear, there really should be more of a description here...

tap control compensate Z

Returns:

the value of the 'Compensate Z' attribute.

See Also:

setCompensateZ(Complex), AclfAdjustPackage.getTapControl_CompensateZ()

setCompensateZ

void setCompensateZ(org.apache.commons.math3.complex.Complex value)

Sets the value of the 'Compensate Z' attribute.

Parameters:

value - the new value of the 'Compensate Z' attribute.

See Also:

getCompensateZ()

isVcGenPVBus

boolean isVcGenPVBus()

Returns the value of the 'Vc Gen PV Bus' attribute. The default value is "false". the Voltage Control bus is a generator PV bus. In this case, TapControl only becomes effective when the PV bus is inactive because of gen QLimit violation.

Returns:

the value of the 'Vc Gen PV Bus' attribute.

See Also:

setVcGenPVBus(boolean), AclfAdjustPackage.getTapControl_VcGenPVBus()

setVcGenPVBus

void setVcGenPVBus(boolean value)

Sets the value of the 'Vc Gen PV Bus' attribute.

Parameters:

value - the new value of the 'Vc Gen PV Bus' attribute.

See Also:

isVcGenPVBus()

getVcBusId

java.lang.String getVcBusId()

Returns the value of the 'Vc Bus Id' attribute. The default value is "NOT_DEFINED". Voltage control bus id for serialization purpose.

Returns:

the value of the 'Vc Bus Id' attribute.

See Also:

setVcBusId(String), AclfAdjustPackage.getTapControl_VcBusId()

setVcBusId

void setVcBusId(java.lang.String value)

Sets the value of the 'Vc Bus Id' attribute.

Parameters:

value - the new value of the 'Vc Bus Id' attribute.

See Also:

getVcBusId()

getVcBus

BaseAclfBus<?,?> getVcBus()

Returns the value of the 'Vc Bus' reference.

If the meaning of the 'Vc Bus' reference isn't clear, there really should be more of a description here...

reference to the bus whose voltage to be controlled by this TapControl object

Returns:

the value of the 'Vc Bus' reference.

See Also:

setVcBus(BaseAclfBus), AclfAdjustPackage.getTapControl_VcBus()

setVcBus

void setVcBus(BaseAclfBus<?,?> value)

Sets the value of the 'Vc Bus' reference.

Parameters:

value - the new value of the 'Vc Bus' reference.

See Also:

getVcBus()

getMvarSpecified

double getMvarSpecified()

Get mvar control specification in the PU

getMvarSpecified

double getMvarSpecified(Unit.UnitType unit,
                        double baseKva)

Get mvar control specification in the unit specified

Parameters:

unit - mvar unit

baseKva - base kva for mvar unit conversion

getMvarFlowCalculated

double getMvarFlowCalculated(Unit.UnitType unit,
                             double baseKva)

Get mvar flow calculated in the unit specified

Parameters:

unit - mvar flow unit

baseKva - base kva for mvar unit conversion

setMvarSpecified

void setMvarSpecified(double q)

Set Mvar control specification in PU

Parameters:

q - mvar specified

setMvarSpecified

void setMvarSpecified(double q,
                      Unit.UnitType unit,
                      double baseKva)

Set Mvar specification in the unit specified

Parameters:

q - mvar specified

unit - mvar specified unit

baseKva - base kva for unit conversion