com.interpss.dist

Interface DistBranch

All Superinterfaces:

Branch, BranchRef<AcscBranch>, com.hazelcast.nio.serialization.DataSerializable, org.eclipse.emf.ecore.EObject, ExtensionElement, IDistBranchAdaptation, NameTag, NetworkedElement, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

DistBranchImpl

public interface DistBranch
extends Branch, IDistBranchAdaptation, BranchRef<AcscBranch>

A representation of the model object 'Dist Branch'. Dist Branch class for distribution analysis.

The following features are supported:

• Branch Code
• Z1
• Z0
• ZUnit
• HShunt Y
• HShunt Y0
• Shunt YUnit
• Length
• Length Unit
• Primary Turn Ratio
• Secondary Turn Ratio
• Xfr Turn Ratio Unit
• Xfr Rating
• Xfr Rating Unit
• Primary Rated V
• Secondary Rated V
• Rated VUnit
• Primary Connect
• Secondary Connect
• Primary Grounding
• Secondary Grounding
• Load Schedule Data

See Also:

DistPackage.getDistBranch()

Method Summary

Modifier and Type	Method and Description
AcscBranch	getAcscBranch() get the referenced AcscBranch object
DistBranchCode	getBranchCode() Returns the value of the 'Branch Code' attribute.
org.apache.commons.math3.complex.Complex	getHShuntY() Returns the value of the 'HShunt Y' attribute.
org.apache.commons.math3.complex.Complex	getHShuntY0() Returns the value of the 'HShunt Y0' attribute.
double	getLength() Returns the value of the 'Length' attribute.
Unit.UnitType	getLengthUnit() Returns the value of the 'Length Unit' attribute.
LoadBranchData	getLoadScheduleData() Returns the value of the 'Load Schedule Data' containment reference.
XFormerConnectCode	getPrimaryConnect() Returns the value of the 'Primary Connect' attribute.
BusScGrounding	getPrimaryGrounding() Returns the value of the 'Primary Grounding' containment reference.
double	getPrimaryRatedV() Returns the value of the 'Primary Rated V' attribute.
double	getPrimaryTurnRatio() Returns the value of the 'Primary Turn Ratio' attribute.
Unit.UnitType	getRatedVUnit() Returns the value of the 'Rated VUnit' attribute.
XFormerConnectCode	getSecondaryConnect() Returns the value of the 'Secondary Connect' attribute.
BusScGrounding	getSecondaryGrounding() Returns the value of the 'Secondary Grounding' containment reference.
double	getSecondaryRatedV() Returns the value of the 'Secondary Rated V' attribute.
double	getSecondaryTurnRatio() Returns the value of the 'Secondary Turn Ratio' attribute.
Unit.UnitType	getShuntYUnit() Returns the value of the 'Shunt YUnit' attribute.
double	getXfrRating() Returns the value of the 'Xfr Rating' attribute.
Unit.UnitType	getXfrRatingUnit() Returns the value of the 'Xfr Rating Unit' attribute.
Unit.UnitType	getXfrTurnRatioUnit() Returns the value of the 'Xfr Turn Ratio Unit' attribute.
org.apache.commons.math3.complex.Complex	getZ0() Returns the value of the 'Z0' attribute.
org.apache.commons.math3.complex.Complex	getZ1() Returns the value of the 'Z1' attribute.
Unit.UnitType	getZUnit() Returns the value of the 'ZUnit' attribute.
void	setBranchCode(DistBranchCode value) Sets the value of the 'Branch Code' attribute.
void	setHShuntY(org.apache.commons.math3.complex.Complex value) Sets the value of the 'HShunt Y' attribute.
void	setHShuntY0(org.apache.commons.math3.complex.Complex value) Sets the value of the 'HShunt Y0' attribute.
void	setLength(double value) Sets the value of the 'Length' attribute.
void	setLengthUnit(Unit.UnitType value) Sets the value of the 'Length Unit' attribute.
void	setLoadScheduleData(LoadBranchData value) Sets the value of the 'Load Schedule Data' containment reference.
void	setPrimaryConnect(XFormerConnectCode value) Sets the value of the 'Primary Connect' attribute.
void	setPrimaryGrounding(BusScGrounding value) Sets the value of the 'Primary Grounding' containment reference.
void	setPrimaryRatedV(double value) Sets the value of the 'Primary Rated V' attribute.
void	setPrimaryTurnRatio(double value) Sets the value of the 'Primary Turn Ratio' attribute.
void	setRatedVUnit(Unit.UnitType value) Sets the value of the 'Rated VUnit' attribute.
void	setSecondaryConnect(XFormerConnectCode value) Sets the value of the 'Secondary Connect' attribute.
void	setSecondaryGrounding(BusScGrounding value) Sets the value of the 'Secondary Grounding' containment reference.
void	setSecondaryRatedV(double value) Sets the value of the 'Secondary Rated V' attribute.
void	setSecondaryTurnRatio(double value) Sets the value of the 'Secondary Turn Ratio' attribute.
void	setShuntYUnit(Unit.UnitType value) Sets the value of the 'Shunt YUnit' attribute.
void	setXfrRating(double value) Sets the value of the 'Xfr Rating' attribute.
void	setXfrRatingUnit(Unit.UnitType value) Sets the value of the 'Xfr Rating Unit' attribute.
void	setXfrTurnRatioUnit(Unit.UnitType value) Sets the value of the 'Xfr Turn Ratio Unit' attribute.
void	setZ0(org.apache.commons.math3.complex.Complex value) Sets the value of the 'Z0' attribute.
void	setZ1(org.apache.commons.math3.complex.Complex value) Sets the value of the 'Z1' attribute.
void	setZUnit(Unit.UnitType value) Sets the value of the 'ZUnit' 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.dist.IDistBranchAdaptation

toBreaker, toFeeder, toReactor, toXFormer

Methods inherited from interface com.interpss.core.net.ref.BranchRef

getBranch, setBranch

Method Detail

getBranchCode

DistBranchCode getBranchCode()

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

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

Returns:

the value of the 'Branch Code' attribute.

See Also:

DistBranchCode, setBranchCode(DistBranchCode), DistPackage.getDistBranch_BranchCode()

setBranchCode

void setBranchCode(DistBranchCode value)

Sets the value of the 'Branch Code' attribute.

Parameters:

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

See Also:

DistBranchCode, getBranchCode()

getZ1

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

Returns the value of the 'Z1' attribute.

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

Returns:

the value of the 'Z1' attribute.

See Also:

setZ1(Complex), DistPackage.getDistBranch_Z1()

setZ1

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

Sets the value of the 'Z1' attribute.

Parameters:

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

See Also:

getZ1()

getZ0

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

Returns the value of the 'Z0' attribute.

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

Returns:

the value of the 'Z0' attribute.

See Also:

setZ0(Complex), DistPackage.getDistBranch_Z0()

setZ0

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

Sets the value of the 'Z0' attribute.

Parameters:

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

See Also:

getZ0()

getZUnit

Unit.UnitType getZUnit()

Returns the value of the 'ZUnit' attribute. The default value is "".

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

Returns:

the value of the 'ZUnit' attribute.

See Also:

#setZUnit(UnitType), DistPackage.getDistBranch_ZUnit()

setZUnit

void setZUnit(Unit.UnitType value)

Sets the value of the 'ZUnit' attribute.

Parameters:

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

See Also:

getZUnit()

getHShuntY

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

Returns the value of the 'HShunt Y' attribute. The default value is "0.0".

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

Returns:

the value of the 'HShunt Y' attribute.

See Also:

setHShuntY(Complex), DistPackage.getDistBranch_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()

getHShuntY0

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

Returns the value of the 'HShunt Y0' attribute. The default value is "0.0".

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

Returns:

the value of the 'HShunt Y0' attribute.

See Also:

setHShuntY0(Complex), DistPackage.getDistBranch_HShuntY0()

setHShuntY0

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

Sets the value of the 'HShunt Y0' attribute.

Parameters:

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

See Also:

getHShuntY0()

getShuntYUnit

Unit.UnitType getShuntYUnit()

Returns the value of the 'Shunt YUnit' attribute. The default value is "".

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

Returns:

the value of the 'Shunt YUnit' attribute.

See Also:

#setShuntYUnit(UnitType), DistPackage.getDistBranch_ShuntYUnit()

setShuntYUnit

void setShuntYUnit(Unit.UnitType value)

Sets the value of the 'Shunt YUnit' attribute.

Parameters:

value - the new value of the 'Shunt YUnit' attribute.

See Also:

getShuntYUnit()

getLength

double getLength()

Returns the value of the 'Length' attribute. The default value is "1000".

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

Returns:

the value of the 'Length' attribute.

See Also:

setLength(double), DistPackage.getDistBranch_Length()

setLength

void setLength(double value)

Sets the value of the 'Length' attribute.

Parameters:

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

See Also:

getLength()

getLengthUnit

Unit.UnitType getLengthUnit()

Returns the value of the 'Length Unit' attribute. The default value is "". Ft or M

Returns:

the value of the 'Length Unit' attribute.

See Also:

#setLengthUnit(UnitType), DistPackage.getDistBranch_LengthUnit()

setLengthUnit

void setLengthUnit(Unit.UnitType value)

Sets the value of the 'Length Unit' attribute.

Parameters:

value - the new value of the 'Length Unit' attribute.

See Also:

getLengthUnit()

getPrimaryTurnRatio

double getPrimaryTurnRatio()

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

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

Returns:

the value of the 'Primary Turn Ratio' attribute.

See Also:

setPrimaryTurnRatio(double), DistPackage.getDistBranch_PrimaryTurnRatio()

setPrimaryTurnRatio

void setPrimaryTurnRatio(double value)

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

Parameters:

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

See Also:

getPrimaryTurnRatio()

getSecondaryTurnRatio

double getSecondaryTurnRatio()

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

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

Returns:

the value of the 'Secondary Turn Ratio' attribute.

See Also:

setSecondaryTurnRatio(double), DistPackage.getDistBranch_SecondaryTurnRatio()

setSecondaryTurnRatio

void setSecondaryTurnRatio(double value)

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

Parameters:

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

See Also:

getSecondaryTurnRatio()

getXfrTurnRatioUnit

Unit.UnitType getXfrTurnRatioUnit()

Returns the value of the 'Xfr Turn Ratio Unit' attribute.

Returns:

the value of the 'Xfr Turn Ratio Unit' attribute.

See Also:

#setXfrTurnRatioUnit(UnitType), DistPackage.getDistBranch_XfrTurnRatioUnit()

setXfrTurnRatioUnit

void setXfrTurnRatioUnit(Unit.UnitType value)

Sets the value of the 'Xfr Turn Ratio Unit' attribute.

Parameters:

value - the new value of the 'Xfr Turn Ratio Unit' attribute.

See Also:

getXfrTurnRatioUnit()

getXfrRating

double getXfrRating()

Returns the value of the 'Xfr Rating' attribute. for Transformer Rated KVA

Returns:

the value of the 'Xfr Rating' attribute.

See Also:

setXfrRating(double), DistPackage.getDistBranch_XfrRating()

setXfrRating

void setXfrRating(double value)

Sets the value of the 'Xfr Rating' attribute.

Parameters:

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

See Also:

getXfrRating()

getXfrRatingUnit

Unit.UnitType getXfrRatingUnit()

Returns the value of the 'Xfr Rating Unit' attribute. The default value is "".

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

Returns:

the value of the 'Xfr Rating Unit' attribute.

See Also:

#setXfrRatingUnit(UnitType), DistPackage.getDistBranch_XfrRatingUnit()

setXfrRatingUnit

void setXfrRatingUnit(Unit.UnitType value)

Sets the value of the 'Xfr Rating Unit' attribute.

Parameters:

value - the new value of the 'Xfr Rating Unit' attribute.

See Also:

getXfrRatingUnit()

getPrimaryRatedV

double getPrimaryRatedV()

Returns the value of the 'Primary Rated V' attribute. The default value is "1.0".

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

Returns:

the value of the 'Primary Rated V' attribute.

See Also:

setPrimaryRatedV(double), DistPackage.getDistBranch_PrimaryRatedV()

setPrimaryRatedV

void setPrimaryRatedV(double value)

Sets the value of the 'Primary Rated V' attribute.

Parameters:

value - the new value of the 'Primary Rated V' attribute.

See Also:

getPrimaryRatedV()

getSecondaryRatedV

double getSecondaryRatedV()

Returns the value of the 'Secondary Rated V' attribute. The default value is "1.0".

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

Returns:

the value of the 'Secondary Rated V' attribute.

See Also:

setSecondaryRatedV(double), DistPackage.getDistBranch_SecondaryRatedV()

setSecondaryRatedV

void setSecondaryRatedV(double value)

Sets the value of the 'Secondary Rated V' attribute.

Parameters:

value - the new value of the 'Secondary Rated V' attribute.

See Also:

getSecondaryRatedV()

getRatedVUnit

Unit.UnitType getRatedVUnit()

Returns the value of the 'Rated VUnit' attribute. The default value is "". Volt or KV

Returns:

the value of the 'Rated VUnit' attribute.

See Also:

#setRatedVUnit(UnitType), DistPackage.getDistBranch_RatedVUnit()

setRatedVUnit

void setRatedVUnit(Unit.UnitType value)

Sets the value of the 'Rated VUnit' attribute.

Parameters:

value - the new value of the 'Rated VUnit' attribute.

See Also:

getRatedVUnit()

getPrimaryConnect

XFormerConnectCode getPrimaryConnect()

Returns the value of the 'Primary Connect' attribute. The default value is "Delta". The literals are from the enumeration XFormerConnectCode.

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

Returns:

the value of the 'Primary Connect' attribute.

See Also:

XFormerConnectCode, setPrimaryConnect(XFormerConnectCode), DistPackage.getDistBranch_PrimaryConnect()

setPrimaryConnect

void setPrimaryConnect(XFormerConnectCode value)

Sets the value of the 'Primary Connect' attribute.

Parameters:

value - the new value of the 'Primary Connect' attribute.

See Also:

XFormerConnectCode, getPrimaryConnect()

getSecondaryConnect

XFormerConnectCode getSecondaryConnect()

Returns the value of the 'Secondary Connect' attribute. The default value is "Wye". The literals are from the enumeration XFormerConnectCode.

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

Returns:

the value of the 'Secondary Connect' attribute.

See Also:

XFormerConnectCode, setSecondaryConnect(XFormerConnectCode), DistPackage.getDistBranch_SecondaryConnect()

setSecondaryConnect

void setSecondaryConnect(XFormerConnectCode value)

Sets the value of the 'Secondary Connect' attribute.

Parameters:

value - the new value of the 'Secondary Connect' attribute.

See Also:

XFormerConnectCode, getSecondaryConnect()

getPrimaryGrounding

BusScGrounding getPrimaryGrounding()

Returns the value of the 'Primary Grounding' containment reference.

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

Returns:

the value of the 'Primary Grounding' containment reference.

See Also:

setPrimaryGrounding(BusScGrounding), DistPackage.getDistBranch_PrimaryGrounding()

setPrimaryGrounding

void setPrimaryGrounding(BusScGrounding value)

Sets the value of the 'Primary Grounding' containment reference.

Parameters:

value - the new value of the 'Primary Grounding' containment reference.

See Also:

getPrimaryGrounding()

getSecondaryGrounding

BusScGrounding getSecondaryGrounding()

Returns the value of the 'Secondary Grounding' containment reference.

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

Returns:

the value of the 'Secondary Grounding' containment reference.

See Also:

setSecondaryGrounding(BusScGrounding), DistPackage.getDistBranch_SecondaryGrounding()

setSecondaryGrounding

void setSecondaryGrounding(BusScGrounding value)

Sets the value of the 'Secondary Grounding' containment reference.

Parameters:

value - the new value of the 'Secondary Grounding' containment reference.

See Also:

getSecondaryGrounding()

getLoadScheduleData

LoadBranchData getLoadScheduleData()

Returns the value of the 'Load Schedule Data' containment reference.

If the meaning of the 'Load Schedule Data' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Load Schedule Data' containment reference.

See Also:

setLoadScheduleData(LoadBranchData), DistPackage.getDistBranch_LoadScheduleData()

setLoadScheduleData

void setLoadScheduleData(LoadBranchData value)

Sets the value of the 'Load Schedule Data' containment reference.

Parameters:

value - the new value of the 'Load Schedule Data' containment reference.

See Also:

getLoadScheduleData()

getAcscBranch

AcscBranch getAcscBranch()

get the referenced AcscBranch object