com.interpss.core.aclf.adj

Interface BranchFlowControl

All Superinterfaces:

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

All Known Subinterfaces:

PSXfrPControl, TapControl

All Known Implementing Classes:

BranchFlowControlImpl, PSXfrPControlImpl, TapControlImpl

public interface BranchFlowControl
extends BaseBusBranchControl

A representation of the model object 'Flow Control'. Aclf branch adjustment/control base class

The following features are supported:

• Parent Branch
• Control Limit
• Control On From Side
• Control Spec
• Flow From2 To
• Metered On From Side

See Also:

AclfAdjustPackage.getBranchFlowControl()

Method Summary

Modifier and Type	Method and Description
LimitType	getControlLimit() Returns the value of the 'Control Limit' attribute.
double	getControlSpec() Returns the value of the 'Control Spec' attribute.
AclfBranch	getParentBranch() Returns the value of the 'Parent Branch' reference.
boolean	isControlOnFromSide() Returns the value of the 'Control On From Side' attribute.
boolean	isFlowFrom2To() Returns the value of the 'Flow From2 To' attribute.
boolean	isMeteredOnFromSide() Returns the value of the 'Metered On From Side' attribute.
void	setControlLimit(LimitType value) Sets the value of the 'Control Limit' attribute.
void	setControlOnFromSide(boolean value) Sets the value of the 'Control On From Side' attribute.
void	setControlSpec(double value) Sets the value of the 'Control Spec' attribute.
void	setFlowFrom2To(boolean value) Sets the value of the 'Flow From2 To' attribute.
void	setMeteredOnFromSide(boolean value) Sets the value of the 'Metered On From Side' attribute.
void	setParentBranch(AclfBranch value) Sets the value of the 'Parent Branch' reference.

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

getParentBranch

AclfBranch getParentBranch()

Returns the value of the 'Parent Branch' reference.

If the meaning of the 'Parent Branch' container reference isn't clear, there really should be more of a description here...

Aclf branch adjustment/control parent Aclf Branch object

Returns:

the value of the 'Parent Branch' reference.

See Also:

setParentBranch(AclfBranch), AclfAdjustPackage.getBranchFlowControl_ParentBranch()

setParentBranch

void setParentBranch(AclfBranch value)

Sets the value of the 'Parent Branch' reference.

Parameters:

value - the new value of the 'Parent Branch' reference.

See Also:

getParentBranch()

getControlLimit

LimitType getControlLimit()

Returns the value of the 'Control Limit' attribute.

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

Aclf branch adjustment/control control limit. For TapControl, it is the Xfr turn ratio limit. For PsXfrPControl, it is the PsXfr shifting angle limit.

Returns:

the value of the 'Control Limit' attribute.

See Also:

setControlLimit(LimitType), AclfAdjustPackage.getBranchFlowControl_ControlLimit()

setControlLimit

void setControlLimit(LimitType value)

Sets the value of the 'Control Limit' attribute.

Parameters:

value - the new value of the 'Control Limit' attribute.

See Also:

getControlLimit()

isControlOnFromSide

boolean isControlOnFromSide()

Returns the value of the 'Control On From Side' attribute.

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

For TapControl, specify control tap on from or to side. For PSXfrControl, specify control angle on from or to side.

Returns:

the value of the 'Control On From Side' attribute.

See Also:

setControlOnFromSide(boolean), AclfAdjustPackage.getBranchFlowControl_ControlOnFromSide()

setControlOnFromSide

void setControlOnFromSide(boolean value)

Sets the value of the 'Control On From Side' attribute.

Parameters:

value - the new value of the 'Control On From Side' attribute.

See Also:

isControlOnFromSide()

getControlSpec

double getControlSpec()

Returns the value of the 'Control Spec' attribute.

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

Aclf branch adjustment/control value specification

Returns:

the value of the 'Control Spec' attribute.

See Also:

setControlSpec(double), AclfAdjustPackage.getBranchFlowControl_ControlSpec()

setControlSpec

void setControlSpec(double value)

Sets the value of the 'Control Spec' attribute.

Parameters:

value - the new value of the 'Control Spec' attribute.

See Also:

getControlSpec()

isFlowFrom2To

boolean isFlowFrom2To()

Returns the value of the 'Flow From2 To' attribute.

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

For TapControl, it is for Mvar flow direction, For PSXfrControl, it is for Mw flow direction

Returns:

the value of the 'Flow From2 To' attribute.

See Also:

setFlowFrom2To(boolean), AclfAdjustPackage.getBranchFlowControl_FlowFrom2To()

setFlowFrom2To

void setFlowFrom2To(boolean value)

Sets the value of the 'Flow From2 To' attribute.

Parameters:

value - the new value of the 'Flow From2 To' attribute.

See Also:

isFlowFrom2To()

isMeteredOnFromSide

boolean isMeteredOnFromSide()

Returns the value of the 'Metered On From Side' attribute.

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

Aclf branch adjustment/control attribute indicating meter location

Returns:

the value of the 'Metered On From Side' attribute.

See Also:

setMeteredOnFromSide(boolean), AclfAdjustPackage.getBranchFlowControl_MeteredOnFromSide()

setMeteredOnFromSide

void setMeteredOnFromSide(boolean value)

Sets the value of the 'Metered On From Side' attribute.

Parameters:

value - the new value of the 'Metered On From Side' attribute.

See Also:

isMeteredOnFromSide()