com.interpss.core.aclf

Interface AclfBranch

All Superinterfaces:

Branch, com.hazelcast.nio.serialization.DataSerializable, org.eclipse.emf.ecore.EObject, ExtensionElement, IAclfBranch, IAclfBranchAdaptation, IAclfBranchAdjustment, IAclfBranchFunc, NameTag, NetworkedElement, org.eclipse.emf.common.notify.Notifier

All Known Subinterfaces:

AcscBranch, DStabBranch, OpfBranch, SEBranch, Static3PBranch

All Known Implementing Classes:

AclfBranchImpl, AcscBranchImpl, DStabBranchImpl, OpfBranchImpl, SEBranchImpl, Static3PBranchImpl

public interface AclfBranch
extends Branch, IAclfBranch, IAclfBranchFunc, IAclfBranchAdaptation, IAclfBranchAdjustment

A representation of the model object 'Branch'. AclfBranch class is for storing branch information for AC loadflow analysis. AclfBranch could be extended using IAclfbranch interface.

The following features are supported:

• Branch Code
• Z
• ZMultiply Factor
• Xfr ZTable Number
• HShunt Y
• From Turn Ratio
• To Turn Ratio
• From Shunt Y
• To Shunt Y
• From PS Xfr Angle
• To PS Xfr Angle
• Rating Mva1
• Rating Mva2
• Rating Mva3
• Rating Amps
• Flow Control
• Loss Factor

See Also:

AclfPackage.getAclfBranch()

Method Summary

Modifier and Type	Method and Description
double	current(Unit.UnitType unit) Calculate branch current in the unit specified.
org.apache.commons.math3.complex.Complex	getAdjustedZ()
AclfBranchCode	getBranchCode() Returns the value of the 'Branch Code' attribute.
BranchFlowControl	getFlowControl() Returns the value of the 'Flow Control' containment reference.
BaseAclfBus<?,?>	getFromAclfBus() Get the from side AclfBus
double	getFromPSXfrAngle() Returns the value of the 'From PS Xfr Angle' attribute.
org.apache.commons.math3.complex.Complex	getFromShuntY() Returns the value of the 'From Shunt Y' attribute.
double	getFromTurnRatio() Returns the value of the 'From Turn Ratio' attribute.
org.apache.commons.math3.complex.Complex	getHShuntY() Returns the value of the 'HShunt Y' attribute.
double	getLossFactor() Returns the value of the 'Loss Factor' attribute.
double	getRatingAmps() Returns the value of the 'Rating Amps' attribute.
double	getRatingMva1() Returns the value of the 'Rating Mva1' attribute.
double	getRatingMva2() Returns the value of the 'Rating Mva2' attribute.
double	getRatingMva3() Returns the value of the 'Rating Mva3' attribute.
BaseAclfBus<?,?>	getToAclfBus() Get the to side AclfBus
double	getToPSXfrAngle() Returns the value of the 'To PS Xfr Angle' attribute.
org.apache.commons.math3.complex.Complex	getToShuntY() Returns the value of the 'To Shunt Y' attribute.
double	getToTurnRatio() Returns the value of the 'To Turn Ratio' attribute.
int	getXfrZTableNumber() Returns the value of the 'Xfr ZTable Number' attribute.
org.apache.commons.math3.complex.Complex	getY() Get branch Y in pu
org.apache.commons.math3.complex.Complex	getZ() Returns the value of the 'Z' attribute.
org.apache.commons.math3.complex.Complex	getZMultiplyFactor() Returns the value of the 'ZMultiply Factor' attribute.
boolean	isLine() check if the branch object is a Line branch
boolean	isPSXfr() check if the branch object is a PSXfr branch
boolean	isXfr() check if the branch object is a Xfr branch
org.apache.commons.math3.complex.Complex	powerFrom2To() Calculate branch power flow at the from side, from->to direction in the unit specified
org.apache.commons.math3.complex.Complex	powerFrom2To(Unit.UnitType unit) Calculate branch power flow at the from side, from->to direction in the unit specified
org.apache.commons.math3.complex.Complex	powerTo2From() Calculate branch power flow at the to side, to->from direction in the unit specified
org.apache.commons.math3.complex.Complex	powerTo2From(Unit.UnitType unit) Calculate branch power flow at the to side, to->from direction in the unit specified
void	setBranchCode(AclfBranchCode value) Sets the value of the 'Branch Code' attribute.
void	setFlowControl(BranchFlowControl value) Sets the value of the 'Flow Control' containment reference.
void	setFromPSXfrAngle(double value) Sets the value of the 'From PS Xfr Angle' attribute.
void	setFromShuntY(org.apache.commons.math3.complex.Complex value) Sets the value of the 'From Shunt Y' attribute.
void	setFromTurnRatio(double value) Sets the value of the 'From Turn Ratio' attribute.
void	setHShuntY(org.apache.commons.math3.complex.Complex value) Sets the value of the 'HShunt Y' attribute.
void	setLossFactor(double value) Sets the value of the 'Loss Factor' attribute.
void	setRatingAmps(double value) Sets the value of the 'Rating Amps' attribute.
void	setRatingMva1(double value) Sets the value of the 'Rating Mva1' attribute.
void	setRatingMva2(double value) Sets the value of the 'Rating Mva2' attribute.
void	setRatingMva3(double value) Sets the value of the 'Rating Mva3' attribute.
void	setToPSXfrAngle(double value) Sets the value of the 'To PS Xfr Angle' attribute.
void	setToShuntY(org.apache.commons.math3.complex.Complex value) Sets the value of the 'To Shunt Y' attribute.
void	setToTurnRatio(double value) Sets the value of the 'To Turn Ratio' attribute.
void	setXfrZTableNumber(int value) Sets the value of the 'Xfr ZTable Number' attribute.
void	setZ(org.apache.commons.math3.complex.Complex value) Sets the value of the 'Z' attribute.
void	setZMultiplyFactor(org.apache.commons.math3.complex.Complex value) Sets the value of the 'ZMultiply Factor' attribute.

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

getCircuitNumber, getFromBus, getFromBusId, getNetwork, getOppositeBus, getOriginalBranchId, getToBus, getToBusId, isFromBus, isFromSideMetered, isGroundBranch, isToBus, reconnect, setAttributes, setAttributes, setCircuitNumber, setFromBus, setFromSideMetered, setNetwork, setOriginalBranchId, setToBus, toString

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

getExtensionObject, setExtensionObject

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

getArea, getAreaId, getExtSeqNumber, getIntFlag, getOwner, getOwnerId, getSortNumber, getWeight, getZone, getZoneId, isBooleanFlag, setArea, setAreaId, setBooleanFlag, setExtSeqNumber, setIntFlag, setOwner, setOwnerId, setSortNumber, setWeight, setZone, setZoneId

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

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

readData, writeData

Methods inherited from interface com.interpss.core.aclf.IAclfBranch

b11ft, b11tf, b1ft, b1tf, yff, yft, ytf, ytt

Methods inherited from interface com.interpss.core.aclf.IAclfBranchFunc

getHigherBaseVoltage, hasSameBaseVoltage, isConnect2RefBus, isZeroZBranch, loss, loss, mvaFlow, pqFlow, ratingViolation, voltageDrop

Methods inherited from interface com.interpss.core.aclf.IAclfBranchAdaptation

toLine, toPSXfr, toXfr

Methods inherited from interface com.interpss.core.aclf.IAclfBranchAdjustment

getPSXfrPControl, getTapControl, isPSXfrPControl, isTapControl

Method Detail

getBranchCode

AclfBranchCode getBranchCode()

Returns the value of the 'Branch Code' attribute. The default value is "Line". The literals are from the enumeration AclfBranchCode.

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

branch code

Returns:

the value of the 'Branch Code' attribute.

See Also:

AclfBranchCode, setBranchCode(AclfBranchCode), AclfPackage.getAclfBranch_BranchCode()

setBranchCode

void setBranchCode(AclfBranchCode value)

Sets the value of the 'Branch Code' attribute.

Parameters:

value - the new value of the 'Branch Code' attribute.

See Also:

AclfBranchCode, getBranchCode()

getZ

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

Returns the value of the 'Z' attribute.

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

branch z

Returns:

the value of the 'Z' attribute.

See Also:

setZ(Complex), AclfPackage.getAclfBranch_Z()

getAdjustedZ

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

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

Get branch adjusted Z in pu, branch.z * multiplyFactor

getHShuntY

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

Returns the value of the 'HShunt Y' attribute.

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

branch half shunt Y

Returns:

the value of the 'HShunt Y' attribute.

See Also:

setHShuntY(Complex), AclfPackage.getAclfBranch_HShuntY()

setHShuntY

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

Sets the value of the 'HShunt Y' attribute.

Parameters:

value - the new value of the 'HShunt Y' attribute.

See Also:

getHShuntY()

getFromTurnRatio

double getFromTurnRatio()

Returns the value of the 'From Turn Ratio' attribute. The default value is "1.0".

If the meaning of the 'From Turn Ratio' attribute isn't clear, there really should be more of a description here...

branch from side xfr turn ratio

Returns:

the value of the 'From Turn Ratio' attribute.

See Also:

setFromTurnRatio(double), AclfPackage.getAclfBranch_FromTurnRatio()

setFromTurnRatio

void setFromTurnRatio(double value)

Sets the value of the 'From Turn Ratio' attribute.

Parameters:

value - the new value of the 'From Turn Ratio' attribute.

See Also:

getFromTurnRatio()

getToTurnRatio

double getToTurnRatio()

Returns the value of the 'To Turn Ratio' attribute. The default value is "1.0".

If the meaning of the 'To Turn Ratio' attribute isn't clear, there really should be more of a description here...

branch to side xfr turn ratio

Returns:

the value of the 'To Turn Ratio' attribute.

See Also:

setToTurnRatio(double), AclfPackage.getAclfBranch_ToTurnRatio()

setToTurnRatio

void setToTurnRatio(double value)

Sets the value of the 'To Turn Ratio' attribute.

Parameters:

value - the new value of the 'To Turn Ratio' attribute.

See Also:

getToTurnRatio()

getFromShuntY

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

Returns the value of the 'From Shunt Y' attribute.

If the meaning of the 'From Shunt Y' attribute isn't clear, there really should be more of a description here...

branch from side shunt Y

Returns:

the value of the 'From Shunt Y' attribute.

See Also:

setFromShuntY(Complex), AclfPackage.getAclfBranch_FromShuntY()

setFromShuntY

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

Sets the value of the 'From Shunt Y' attribute.

Parameters:

value - the new value of the 'From Shunt Y' attribute.

See Also:

getFromShuntY()

getToShuntY

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

Returns the value of the 'To Shunt Y' attribute.

If the meaning of the 'To Shunt Y' attribute isn't clear, there really should be more of a description here...

branch to side shunt Y

Returns:

the value of the 'To Shunt Y' attribute.

See Also:

setToShuntY(Complex), AclfPackage.getAclfBranch_ToShuntY()

setToShuntY

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

Sets the value of the 'To Shunt Y' attribute.

Parameters:

value - the new value of the 'To Shunt Y' attribute.

See Also:

getToShuntY()

getFromPSXfrAngle

double getFromPSXfrAngle()

Returns the value of the 'From PS Xfr Angle' attribute. The default value is "0.0".

If the meaning of the 'From PS Xfr Angle' attribute isn't clear, there really should be more of a description here...

branch from side PSXfr angle

Returns:

the value of the 'From PS Xfr Angle' attribute.

See Also:

setFromPSXfrAngle(double), AclfPackage.getAclfBranch_FromPSXfrAngle()

setFromPSXfrAngle

void setFromPSXfrAngle(double value)

Sets the value of the 'From PS Xfr Angle' attribute.

Parameters:

value - the new value of the 'From PS Xfr Angle' attribute.

See Also:

getFromPSXfrAngle()

getToPSXfrAngle

double getToPSXfrAngle()

Returns the value of the 'To PS Xfr Angle' attribute. The default value is "0.0".

If the meaning of the 'To PS Xfr Angle' attribute isn't clear, there really should be more of a description here...

branch to side PSXfr angle

Returns:

the value of the 'To PS Xfr Angle' attribute.

See Also:

setToPSXfrAngle(double), AclfPackage.getAclfBranch_ToPSXfrAngle()

setToPSXfrAngle

void setToPSXfrAngle(double value)

Sets the value of the 'To PS Xfr Angle' attribute.

Parameters:

value - the new value of the 'To PS Xfr Angle' attribute.

See Also:

getToPSXfrAngle()

getRatingMva1

double getRatingMva1()

Returns the value of the 'Rating Mva1' attribute. The default value is "0.0".

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

branch mva rating-1

Specified by:

getRatingMva1 in interface IAclfBranch

Returns:

the value of the 'Rating Mva1' attribute.

See Also:

setRatingMva1(double), AclfPackage.getAclfBranch_RatingMva1()

setRatingMva1

void setRatingMva1(double value)

Sets the value of the 'Rating Mva1' attribute.

Parameters:

value - the new value of the 'Rating Mva1' attribute.

See Also:

getRatingMva1()

getRatingMva2

double getRatingMva2()

Returns the value of the 'Rating Mva2' attribute. The default value is "0.0".

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

branch mva rating-2

Specified by:

getRatingMva2 in interface IAclfBranch

Returns:

the value of the 'Rating Mva2' attribute.

See Also:

setRatingMva2(double), AclfPackage.getAclfBranch_RatingMva2()

setRatingMva2

void setRatingMva2(double value)

Sets the value of the 'Rating Mva2' attribute.

Parameters:

value - the new value of the 'Rating Mva2' attribute.

See Also:

getRatingMva2()

getRatingMva3

double getRatingMva3()

Returns the value of the 'Rating Mva3' attribute. The default value is "0.0".

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

branch mva rating-3

Specified by:

getRatingMva3 in interface IAclfBranch

Returns:

the value of the 'Rating Mva3' attribute.

See Also:

setRatingMva3(double), AclfPackage.getAclfBranch_RatingMva3()

setRatingMva3

void setRatingMva3(double value)

Sets the value of the 'Rating Mva3' attribute.

Parameters:

value - the new value of the 'Rating Mva3' attribute.

See Also:

getRatingMva3()

getRatingAmps

double getRatingAmps()

Returns the value of the 'Rating Amps' attribute. The default value is "0.0".

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

branch current rating

Returns:

the value of the 'Rating Amps' attribute.

See Also:

setRatingAmps(double), AclfPackage.getAclfBranch_RatingAmps()

setRatingAmps

void setRatingAmps(double value)

Sets the value of the 'Rating Amps' attribute.

Parameters:

value - the new value of the 'Rating Amps' attribute.

See Also:

getRatingAmps()

getLossFactor

double getLossFactor()

Returns the value of the 'Loss Factor' attribute. The default value is "1.0". branch loss factor

Returns:

the value of the 'Loss Factor' attribute.

See Also:

setLossFactor(double), AclfPackage.getAclfBranch_LossFactor()

setLossFactor

void setLossFactor(double value)

Sets the value of the 'Loss Factor' attribute.

Parameters:

value - the new value of the 'Loss Factor' attribute.

See Also:

getLossFactor()

getFlowControl

BranchFlowControl getFlowControl()

Returns the value of the 'Flow Control' containment reference. flowControl for storing TapControl or PsXfrPControl

Returns:

the value of the 'Flow Control' containment reference.

See Also:

setFlowControl(BranchFlowControl), AclfPackage.getAclfBranch_FlowControl()

setFlowControl

void setFlowControl(BranchFlowControl value)

Sets the value of the 'Flow Control' containment reference.

Parameters:

value - the new value of the 'Flow Control' containment reference.

See Also:

getFlowControl()

getFromAclfBus

BaseAclfBus<?,?> getFromAclfBus()

Get the from side AclfBus

getToAclfBus

BaseAclfBus<?,?> getToAclfBus()

Get the to side AclfBus

current

double current(Unit.UnitType unit)

Calculate branch current in the unit specified. For Xfr or PSXfr branch, current is calculated at the high voltage side. The current does not include the effect of to from-side shunt Y and the to-side shunt Y.

Parameters:

unit - unit of the current

powerFrom2To

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

Calculate branch power flow at the from side, from->to direction in the unit specified

powerFrom2To

org.apache.commons.math3.complex.Complex powerFrom2To(Unit.UnitType unit)

Calculate branch power flow at the from side, from->to direction in the unit specified

Parameters:

unit - unit of the power flow

powerTo2From

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

Calculate branch power flow at the to side, to->from direction in the unit specified

powerTo2From

org.apache.commons.math3.complex.Complex powerTo2From(Unit.UnitType unit)

Calculate branch power flow at the to side, to->from direction in the unit specified

Parameters:

unit - unit of the power flow

getY

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

Get branch Y in pu

isLine

boolean isLine()

check if the branch object is a Line branch

isXfr

boolean isXfr()

check if the branch object is a Xfr branch

isPSXfr

boolean isPSXfr()

check if the branch object is a PSXfr branch

setZ

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

Sets the value of the 'Z' attribute.

Parameters:

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

See Also:

getZ()

getZMultiplyFactor

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

Returns the value of the 'ZMultiply Factor' attribute. The default value is "1.0". branch z multiplying factor

Returns:

the value of the 'ZMultiply Factor' attribute.

See Also:

setZMultiplyFactor(Complex), AclfPackage.getAclfBranch_ZMultiplyFactor()

setZMultiplyFactor

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

Sets the value of the 'ZMultiply Factor' attribute.

Parameters:

value - the new value of the 'ZMultiply Factor' attribute.

See Also:

getZMultiplyFactor()

getXfrZTableNumber

int getXfrZTableNumber()

Returns the value of the 'Xfr ZTable Number' attribute. The default value is "0". Xfr Z adjustment Table number, default = 0, indicating no link to the table.

Returns:

the value of the 'Xfr ZTable Number' attribute.

See Also:

setXfrZTableNumber(int), AclfPackage.getAclfBranch_XfrZTableNumber()

setXfrZTableNumber

void setXfrZTableNumber(int value)

Sets the value of the 'Xfr ZTable Number' attribute.

Parameters:

value - the new value of the 'Xfr ZTable Number' attribute.

See Also:

getXfrZTableNumber()