com.interpss.core.algo.path

Interface NetPathWalkAlgorithm<TBus extends Bus,TBranch extends Branch>

All Superinterfaces:

com.hazelcast.nio.serialization.DataSerializable, org.eclipse.emf.ecore.EObject, INetBVisitor<TBus,TBranch>, NameTag, org.eclipse.emf.common.notify.Notifier

All Known Subinterfaces:

ActivePowerPathWalkAlgorithm, CurentPathWalkAlgorithm, LossAllocationAlgorithm

All Known Implementing Classes:

CurentPathWalkAlgorithmImpl, DistPathLfAlgorithm, LossAllocationAlgorithmImpl, NetPathWalkAlgorithmImpl

public interface NetPathWalkAlgorithm<TBus extends Bus,TBranch extends Branch>
extends NameTag, INetBVisitor<TBus,TBranch>

A base for network flow path walk algorithm implementation. The walk could be along the flow path or opposite to the flow path. For example, one can walk through a network along/opposite to the active power flow path after load flow converged. The walk through algorithm is implemented in the visit method, which is a generic implementation of network path walk-through. - The walk could be along the network flow path direction (source -> sink) or in opposite direction (sink -> source) - For the source -> sink direction, the walk starts from buses with only out-direction branches and ends with buses with only into-direction branches. - bus object walking includes 1) if source -> sink direction and no into-direction branch, turn the bus.walkStatus = true and perform some action to the bus object 2) if source -> sink direction, turn all out-direction branches walkStatus = true, and perform some action to the branch object A generic algorithm to walk along/opposite path. The path direction itself is domain problem specific. For example, the walk could be along active power flow or current flow direction.

The following features are supported:

• Direction
• Bus Walker
• Branch Walker

See Also:

PathAlgorithmPackage.getNetPathWalkAlgorithm()

Field Summary

Fields inherited from interface com.interpss.core.common.visitor.INetBVisitor

copyright

Method Summary

Modifier and Type	Method and Description
void	branchWalkThough(Network<?,?> net, INetVisitor<?,?> initForWalk, IBranchBVisitor branchVisitor) explictly walk through branches in the network, used, for example, for prototype an algorithm
void	busWalkThough(Network<?,?> net, INetVisitor<?,?> initForWalk, IBusBVisitor busVisitor) explictly walk through buses in the network, used, for example, for prototype an algorithm
IBranchPathWalker	getBranchWalker() Returns the value of the 'Branch Walker' reference.
IBusPathWalker	getBusWalker() Returns the value of the 'Bus Walker' reference.
NetPathWalkDirectionEnum	getDirection() Returns the value of the 'Direction' attribute.
void	setBranchWalker(IBranchPathWalker value) Sets the value of the 'Branch Walker' reference.
void	setBusWalker(IBusPathWalker value) Sets the value of the 'Bus Walker' reference.
void	setDirection(NetPathWalkDirectionEnum value) Sets the value of the 'Direction' attribute.

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.common.visitor.INetBVisitor

visit

Method Detail

getDirection

NetPathWalkDirectionEnum getDirection()

Returns the value of the 'Direction' attribute. The literals are from the enumeration NetPathWalkDirectionEnum.

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

network walk-through direction: along the path or opposite to the path.

Returns:

the value of the 'Direction' attribute.

See Also:

NetPathWalkDirectionEnum, setDirection(NetPathWalkDirectionEnum), PathAlgorithmPackage.getNetPathWalkAlgorithm_Direction()

setDirection

void setDirection(NetPathWalkDirectionEnum value)

Sets the value of the 'Direction' attribute.

Parameters:

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

See Also:

NetPathWalkDirectionEnum, getDirection()

getBusWalker

IBusPathWalker getBusWalker()

Returns the value of the 'Bus Walker' reference.

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

network walk-through bus visitor.

Returns:

the value of the 'Bus Walker' reference.

See Also:

setBusWalker(IBusPathWalker), PathAlgorithmPackage.getNetPathWalkAlgorithm_BusWalker()

setBusWalker

void setBusWalker(IBusPathWalker value)

Sets the value of the 'Bus Walker' reference.

Parameters:

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

See Also:

getBusWalker()

getBranchWalker

IBranchPathWalker getBranchWalker()

Returns the value of the 'Branch Walker' reference.

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

network walk-through branch visitor.

Returns:

the value of the 'Branch Walker' reference.

See Also:

setBranchWalker(IBranchPathWalker), PathAlgorithmPackage.getNetPathWalkAlgorithm_BranchWalker()

setBranchWalker

void setBranchWalker(IBranchPathWalker value)

Sets the value of the 'Branch Walker' reference.

Parameters:

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

See Also:

getBranchWalker()

busWalkThough

void busWalkThough(Network<?,?> net,
                   INetVisitor<?,?> initForWalk,
                   IBusBVisitor busVisitor)

explictly walk through buses in the network, used, for example, for prototype an algorithm

Parameters:

net - network object

initForWalk - network visitor for the initial walk step

busVisitor - bus visitor for the initial walk step

branchWalkThough

void branchWalkThough(Network<?,?> net,
                      INetVisitor<?,?> initForWalk,
                      IBranchBVisitor branchVisitor)

explictly walk through branches in the network, used, for example, for prototype an algorithm

Parameters:

net - network object

initForWalk - network visitor for the initial walk step

branchVisitor - branch visitor for the initial walk step