com.interpss.core.algo.mslf

Interface BaseMultiStateLfAlgorithm<TNet extends AclfNetwork>

All Superinterfaces:

com.hazelcast.nio.serialization.DataSerializable, org.eclipse.emf.ecore.EObject, NameTag, NetworkRef<TNet>, org.eclipse.emf.common.notify.Notifier

All Known Subinterfaces:

MultiNetDclfAlgorithm<TNet>, MultiStateAclfAlgorithm<TNet>, MultiStateDclfAlgorithm<TNet>

All Known Implementing Classes:

BaseMultiStateLfAlgorithmImpl, MultiNetDclfAlgorithmImpl, MultiStateAclfAlgorithmImpl, MultiStateDclfAlgorithmImpl

public interface BaseMultiStateLfAlgorithm<TNet extends AclfNetwork>
extends NetworkRef<TNet>

A representation of the model object 'FS Loadflow Algorithm'. Base class for defining a multiple state algorithm object. It contains a basecase AclfNetwork object, a set of cloned AclfNetwork objects.

The following features are supported:

• One Net2 Multi Lf Algo
• Fixed Structure
• NOf Lf Algoritms
• Ms Aclf Net List

See Also:

MslfAlgorithmPackage.getBaseMultiStateLfAlgorithm()

Method Summary

Modifier and Type	Method and Description
void	addMsAclfNet(java.lang.String netName, AclfNetwork aclfNet) add an aclfNet object to the msAclfNetList, it only applies to fixedStructure = false
AclfNetwork	createClonedAclfNet(java.lang.String netName) create a new clonedAclfNet object, it only applies to fixedStructure = false
AclfNetwork	createClonedSubAclfNet(java.lang.String netName, java.util.Set<java.lang.String> busIdSet, boolean equivHvdc) create a new cloned SubAclfNet object based on the busIdSet, it only applies to fixedStructure = false
java.util.TreeMap<java.lang.String,NameTag>	createNetAlgoTree() create a BaseNet/ClonedNet/DclfAlgo|AclfAlgo tree map using the object.name as the key element.
AclfNetwork	getClonedAclfNet(int netNo) get a cloned AclfNet object by net number (0 ..
AclfNetwork	getClonedAclfNet(java.lang.String netId) get a cloned AclfNet object by net id.
org.eclipse.emf.common.util.EList<AclfNetwork>	getMsAclfNetList() Returns the value of the 'Ms Aclf Net List' containment reference list.
int[]	getNOfLfAlgoritms() Returns the value of the 'NOf Lf Algoritms' attribute.
boolean	isFixedStructure() Returns the value of the 'Fixed Structure' attribute.
boolean	isOneNet2MultiLfAlgo() Returns the value of the 'One Net2 Multi Lf Algo' attribute.
void	setFixedStructure(boolean value) Sets the value of the 'Fixed Structure' attribute.
void	setNOfLfAlgoritms(int[] value) Sets the value of the 'NOf Lf Algoritms' attribute.
void	setOneNet2MultiLfAlgo(boolean value) Sets the value of the 'One Net2 Multi Lf Algo' attribute.

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

getNetwork, setNetwork

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

Method Detail

isOneNet2MultiLfAlgo

boolean isOneNet2MultiLfAlgo()

Returns the value of the 'One Net2 Multi Lf Algo' attribute. The default value is "false". If true, the cloned AclfNetwork object and the SenAnalysisAlgorithm object has 1 - many relationship. If false, the cloned AclfNetwork object and the SenAnalysisAlgorithm object has 1 - 1 relationship

Returns:

the value of the 'One Net2 Multi Lf Algo' attribute.

See Also:

setOneNet2MultiLfAlgo(boolean), MslfAlgorithmPackage.getBaseMultiStateLfAlgorithm_OneNet2MultiLfAlgo()

setOneNet2MultiLfAlgo

void setOneNet2MultiLfAlgo(boolean value)

Sets the value of the 'One Net2 Multi Lf Algo' attribute.

Parameters:

value - the new value of the 'One Net2 Multi Lf Algo' attribute.

See Also:

isOneNet2MultiLfAlgo()

isFixedStructure

boolean isFixedStructure()

Returns the value of the 'Fixed Structure' attribute. The default value is "false". flag to control if the multi-state ClonedAclfNet - AclfAlgo/DclfAlgo structure can be changed after the Multi-State object creation.

Returns:

the value of the 'Fixed Structure' attribute.

See Also:

setFixedStructure(boolean), MslfAlgorithmPackage.getBaseMultiStateLfAlgorithm_FixedStructure()

setFixedStructure

void setFixedStructure(boolean value)

Sets the value of the 'Fixed Structure' attribute.

Parameters:

value - the new value of the 'Fixed Structure' attribute.

See Also:

isFixedStructure()

getNOfLfAlgoritms

int[] getNOfLfAlgoritms()

Returns the value of the 'NOf Lf Algoritms' attribute. The default value is "". index arrary, stores the ith AclfNet object linked to nOfAlgoAry[i] DclfAlgo objects.

Returns:

the value of the 'NOf Lf Algoritms' attribute.

See Also:

setNOfLfAlgoritms(int[]), MslfAlgorithmPackage.getBaseMultiStateLfAlgorithm_NOfLfAlgoritms()

setNOfLfAlgoritms

void setNOfLfAlgoritms(int[] value)

Sets the value of the 'NOf Lf Algoritms' attribute.

Parameters:

value - the new value of the 'NOf Lf Algoritms' attribute.

See Also:

getNOfLfAlgoritms()

getMsAclfNetList

org.eclipse.emf.common.util.EList<AclfNetwork> getMsAclfNetList()

Returns the value of the 'Ms Aclf Net List' containment reference list. The list contents are of type AclfNetwork. Multi-state AclfNetwork object list. The cloned AclfNetwork object and the SenAnalysisAlgorithm object might have 1 - many relationship.

Returns:

the value of the 'Ms Aclf Net List' containment reference list.

See Also:

MslfAlgorithmPackage.getBaseMultiStateLfAlgorithm_MsAclfNetList()

getClonedAclfNet

AclfNetwork getClonedAclfNet(java.lang.String netId)
                      throws InterpssException

get a cloned AclfNet object by net id.

Parameters:

netId - clone AclfNet object id

Throws:

InterpssException

getClonedAclfNet

AclfNetwork getClonedAclfNet(int netNo)

get a cloned AclfNet object by net number (0 .. n-1 convention). It only applies to fixedStructure = true

Parameters:

netNo - cloned AclfNet object number

createNetAlgoTree

java.util.TreeMap<java.lang.String,NameTag> createNetAlgoTree()

create a BaseNet/ClonedNet/DclfAlgo|AclfAlgo tree map using the object.name as the key element. It only applies to fixedStructure = false

createClonedAclfNet

AclfNetwork createClonedAclfNet(java.lang.String netName)

create a new clonedAclfNet object, it only applies to fixedStructure = false

Parameters:

netName - clone AclfNet object name

createClonedSubAclfNet

AclfNetwork createClonedSubAclfNet(java.lang.String netName,
                                   java.util.Set<java.lang.String> busIdSet,
                                   boolean equivHvdc)
                            throws InterpssException

create a new cloned SubAclfNet object based on the busIdSet, it only applies to fixedStructure = false

Parameters:

netName - clone AclfNet object name

busIdSet - Bus id set for creating the SubAclfNet

equivHvdc - flag to control if Hvdc lines will be equivalent

Throws:

InterpssException

addMsAclfNet

void addMsAclfNet(java.lang.String netName,
                  AclfNetwork aclfNet)

add an aclfNet object to the msAclfNetList, it only applies to fixedStructure = false

Parameters:

netName - clone AclfNet object name