com.interpss.simu.multicase.aclf

Interface AclfMultiStudyCase

All Superinterfaces:

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

All Known Subinterfaces:

ContingencyAnalysis, DStabMultiStudyCase

All Known Implementing Classes:

AclfMultiStudyCaseImpl, ContingencyAnalysisImpl, DStabMultiStudyCaseImpl

public interface AclfMultiStudyCase
extends MultiStudyCase

A representation of the model object 'Aclf Multi Study Case'. multi study case for AclfNet related analysis, such as contingey analysis.

The following features are supported:

• Remote Job Creation
• Lf Tolerance
• Bus Voltage Upper Limit PU
• Bus Voltage Lower Limit PU
• Aclf Grid Option
• Bus Result Summary
• Branch Result Summary

See Also:

MCaseAclfPackage.getAclfMultiStudyCase()

Method Summary

Modifier and Type	Method and Description
AclfGridOption	getAclfGridOption() Returns the value of the 'Aclf Grid Option' containment reference.
java.util.Hashtable<java.lang.String,AclfBranchResultRec>	getBranchResultSummary() Returns the value of the 'Branch Result Summary' attribute.
java.util.Hashtable<java.lang.String,AclfBusResultRec>	getBusResultSummary() Returns the value of the 'Bus Result Summary' attribute.
double	getBusVoltageLowerLimitPU() Returns the value of the 'Bus Voltage Lower Limit PU' attribute.
double	getBusVoltageUpperLimitPU() Returns the value of the 'Bus Voltage Upper Limit PU' attribute.
double	getLfTolerance() Returns the value of the 'Lf Tolerance' attribute.
boolean	isRemoteJobCreation() Returns the value of the 'Remote Job Creation' attribute.
void	setAclfGridOption(AclfGridOption value) Sets the value of the 'Aclf Grid Option' containment reference.
void	setBranchResultSummary(java.util.Hashtable<java.lang.String,AclfBranchResultRec> value) Sets the value of the 'Branch Result Summary' attribute.
void	setBusResultSummary(java.util.Hashtable<java.lang.String,AclfBusResultRec> value) Sets the value of the 'Bus Result Summary' attribute.
void	setBusVoltageLowerLimitPU(double value) Sets the value of the 'Bus Voltage Lower Limit PU' attribute.
void	setBusVoltageUpperLimitPU(double value) Sets the value of the 'Bus Voltage Upper Limit PU' attribute.
void	setLfTolerance(double value) Sets the value of the 'Lf Tolerance' attribute.
void	setRemoteJobCreation(boolean value) Sets the value of the 'Remote Job Creation' attribute.
boolean	updateResult(java.lang.String studyCaseName, StudyCaseResult aclfCaseResult) process the study case, add info to the busResultSummary and branchResultSummary tables.

Methods inherited from interface com.interpss.simu.multicase.MultiStudyCase

addStudyCase, getBaseNetModelString, getNetType, getRuleBase, getStudyCase, getStudyCase, getStudyCaseList, setBaseNetModelString, setNetType, setRuleBase, setStudyCaseList

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

checkData, checkData, copy, copyRef, getDesc, getId, getName, getNumber, isActive, isStatus, setDesc, setId, setName, setNumber, setStatus

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

isRemoteJobCreation

boolean isRemoteJobCreation()

Returns the value of the 'Remote Job Creation' attribute.

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

option for remote job creation at remote grid node

Returns:

the value of the 'Remote Job Creation' attribute.

See Also:

setRemoteJobCreation(boolean), MCaseAclfPackage.getAclfMultiStudyCase_RemoteJobCreation()

setRemoteJobCreation

void setRemoteJobCreation(boolean value)

Sets the value of the 'Remote Job Creation' attribute.

Parameters:

value - the new value of the 'Remote Job Creation' attribute.

See Also:

isRemoteJobCreation()

getAclfGridOption

AclfGridOption getAclfGridOption()

Returns the value of the 'Aclf Grid Option' containment reference.

If the meaning of the 'Aclf Grid Option' containment reference isn't clear, there really should be more of a description here...

reference to a grid computing option object

Returns:

the value of the 'Aclf Grid Option' containment reference.

See Also:

setAclfGridOption(AclfGridOption), MCaseAclfPackage.getAclfMultiStudyCase_AclfGridOption()

setAclfGridOption

void setAclfGridOption(AclfGridOption value)

Sets the value of the 'Aclf Grid Option' containment reference.

Parameters:

value - the new value of the 'Aclf Grid Option' containment reference.

See Also:

getAclfGridOption()

getLfTolerance

double getLfTolerance()

Returns the value of the 'Lf Tolerance' attribute. The default value is "1.1".

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

Loadflow convergence tolerance in PU

Returns:

the value of the 'Lf Tolerance' attribute.

See Also:

setLfTolerance(double), MCaseAclfPackage.getAclfMultiStudyCase_LfTolerance()

setLfTolerance

void setLfTolerance(double value)

Sets the value of the 'Lf Tolerance' attribute.

Parameters:

value - the new value of the 'Lf Tolerance' attribute.

See Also:

getLfTolerance()

getBusVoltageUpperLimitPU

double getBusVoltageUpperLimitPU()

Returns the value of the 'Bus Voltage Upper Limit PU' attribute. The default value is "1.1".

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

bus voltage upper limit in PU

Returns:

the value of the 'Bus Voltage Upper Limit PU' attribute.

See Also:

setBusVoltageUpperLimitPU(double), MCaseAclfPackage.getAclfMultiStudyCase_BusVoltageUpperLimitPU()

setBusVoltageUpperLimitPU

void setBusVoltageUpperLimitPU(double value)

Sets the value of the 'Bus Voltage Upper Limit PU' attribute.

Parameters:

value - the new value of the 'Bus Voltage Upper Limit PU' attribute.

See Also:

getBusVoltageUpperLimitPU()

getBusVoltageLowerLimitPU

double getBusVoltageLowerLimitPU()

Returns the value of the 'Bus Voltage Lower Limit PU' attribute. The default value is "0.85".

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

bus voltage lower limit in PU

Returns:

the value of the 'Bus Voltage Lower Limit PU' attribute.

See Also:

setBusVoltageLowerLimitPU(double), MCaseAclfPackage.getAclfMultiStudyCase_BusVoltageLowerLimitPU()

setBusVoltageLowerLimitPU

void setBusVoltageLowerLimitPU(double value)

Sets the value of the 'Bus Voltage Lower Limit PU' attribute.

Parameters:

value - the new value of the 'Bus Voltage Lower Limit PU' attribute.

See Also:

getBusVoltageLowerLimitPU()

getBusResultSummary

java.util.Hashtable<java.lang.String,AclfBusResultRec> getBusResultSummary()

Returns the value of the 'Bus Result Summary' attribute. consolidated bus result for all analysis study cases

Returns:

the value of the 'Bus Result Summary' attribute.

See Also:

setBusResultSummary(Hashtable), MCaseAclfPackage.getAclfMultiStudyCase_BusResultSummary()

setBusResultSummary

void setBusResultSummary(java.util.Hashtable<java.lang.String,AclfBusResultRec> value)

Sets the value of the 'Bus Result Summary' attribute.

Parameters:

value - the new value of the 'Bus Result Summary' attribute.

See Also:

getBusResultSummary()

getBranchResultSummary

java.util.Hashtable<java.lang.String,AclfBranchResultRec> getBranchResultSummary()

Returns the value of the 'Branch Result Summary' attribute. consolidated branch result for all analysis study cases

Returns:

the value of the 'Branch Result Summary' attribute.

See Also:

setBranchResultSummary(Hashtable), MCaseAclfPackage.getAclfMultiStudyCase_BranchResultSummary()

setBranchResultSummary

void setBranchResultSummary(java.util.Hashtable<java.lang.String,AclfBranchResultRec> value)

Sets the value of the 'Branch Result Summary' attribute.

Parameters:

value - the new value of the 'Branch Result Summary' attribute.

See Also:

getBranchResultSummary()

updateResult

boolean updateResult(java.lang.String studyCaseName,
                     StudyCaseResult aclfCaseResult)

process the study case, add info to the busResultSummary and branchResultSummary tables.