com.interpss.simu.multicase

Interface StudyCase

All Superinterfaces:

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

All Known Subinterfaces:

AclfStudyCase, ContingencyCase, DStabStudyCase

All Known Implementing Classes:

AclfStudyCaseImpl, ContingencyCaseImpl, DStabStudyCaseImpl, StudyCaseImpl

public interface StudyCase
extends NameTag

A representation of the model object 'Study Case'. Class for defining study case. Study case is intended for carrying a network model in serialized form, possibly being sent to a remote node or another thread for running analysis, such as Loadflow. The analysis result is then saved to the result object. Study case after the analysis with result might be sent to another node for further anlaysis, for example, Security Margin analysis. The modification could be applied before the analysis.

The following features are supported:

• Case Number
• Grid Node Id
• Net Model String
• Remote Return Status
• Remote Return Message
• Parent
• Modification
• Result

See Also:

MulticasePackage.getStudyCase()

Method Summary

Modifier and Type	Method and Description
int	getCaseNumber() Returns the value of the 'Case Number' attribute.
java.lang.String	getGridNodeId() Returns the value of the 'Grid Node Id' attribute.
Modification	getModification() Returns the value of the 'Modification' reference.
java.lang.String	getNetModelString() Returns the value of the 'Net Model String' attribute.
MultiStudyCase	getParent() Returns the value of the 'Parent' reference.
java.lang.String	getRemoteReturnMessage() Returns the value of the 'Remote Return Message' attribute.
StudyCaseResult	getResult() Returns the value of the 'Result' containment reference.
boolean	isRemoteReturnStatus() Returns the value of the 'Remote Return Status' attribute.
void	setCaseNumber(int value) Sets the value of the 'Case Number' attribute.
void	setGridNodeId(java.lang.String value) Sets the value of the 'Grid Node Id' attribute.
void	setModification(Modification value) Sets the value of the 'Modification' reference.
void	setNetModelString(java.lang.String value) Sets the value of the 'Net Model String' attribute.
void	setParent(MultiStudyCase value) Sets the value of the 'Parent' reference.
void	setRemoteReturnMessage(java.lang.String value) Sets the value of the 'Remote Return Message' attribute.
void	setRemoteReturnStatus(boolean value) Sets the value of the 'Remote Return Status' attribute.
void	setResult(StudyCaseResult value) Sets the value of the 'Result' containment reference.

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

getParent

MultiStudyCase getParent()

Returns the value of the 'Parent' reference.

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

parent containing MultiStudyCase object

Returns:

the value of the 'Parent' reference.

See Also:

setParent(MultiStudyCase), MulticasePackage.getStudyCase_Parent()

setParent

void setParent(MultiStudyCase value)

Sets the value of the 'Parent' reference.

Parameters:

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

See Also:

getParent()

getCaseNumber

int getCaseNumber()

Returns the value of the 'Case Number' attribute.

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

Study case number.

Returns:

the value of the 'Case Number' attribute.

See Also:

setCaseNumber(int), MulticasePackage.getStudyCase_CaseNumber()

setCaseNumber

void setCaseNumber(int value)

Sets the value of the 'Case Number' attribute.

Parameters:

value - the new value of the 'Case Number' attribute.

See Also:

getCaseNumber()

getGridNodeId

java.lang.String getGridNodeId()

Returns the value of the 'Grid Node Id' attribute.

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

Grid node id to run this study case.

Returns:

the value of the 'Grid Node Id' attribute.

See Also:

setGridNodeId(String), MulticasePackage.getStudyCase_GridNodeId()

setGridNodeId

void setGridNodeId(java.lang.String value)

Sets the value of the 'Grid Node Id' attribute.

Parameters:

value - the new value of the 'Grid Node Id' attribute.

See Also:

getGridNodeId()

getNetModelString

java.lang.String getNetModelString()

Returns the value of the 'Net Model String' attribute.

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

Serialized network mode for the study case.

Returns:

the value of the 'Net Model String' attribute.

See Also:

setNetModelString(String), MulticasePackage.getStudyCase_NetModelString()

setNetModelString

void setNetModelString(java.lang.String value)

Sets the value of the 'Net Model String' attribute.

Parameters:

value - the new value of the 'Net Model String' attribute.

See Also:

getNetModelString()

getModification

Modification getModification()

Returns the value of the 'Modification' reference.

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

refernce to a modification object for the study case.

Returns:

the value of the 'Modification' reference.

See Also:

setModification(Modification), MulticasePackage.getStudyCase_Modification()

setModification

void setModification(Modification value)

Sets the value of the 'Modification' reference.

Parameters:

value - the new value of the 'Modification' reference.

See Also:

getModification()

isRemoteReturnStatus

boolean isRemoteReturnStatus()

Returns the value of the 'Remote Return Status' attribute.

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

remote run of the study case return status.

Returns:

the value of the 'Remote Return Status' attribute.

See Also:

setRemoteReturnStatus(boolean), MulticasePackage.getStudyCase_RemoteReturnStatus()

setRemoteReturnStatus

void setRemoteReturnStatus(boolean value)

Sets the value of the 'Remote Return Status' attribute.

Parameters:

value - the new value of the 'Remote Return Status' attribute.

See Also:

isRemoteReturnStatus()

getRemoteReturnMessage

java.lang.String getRemoteReturnMessage()

Returns the value of the 'Remote Return Message' attribute.

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

remote return message of the study case.

Returns:

the value of the 'Remote Return Message' attribute.

See Also:

setRemoteReturnMessage(String), MulticasePackage.getStudyCase_RemoteReturnMessage()

setRemoteReturnMessage

void setRemoteReturnMessage(java.lang.String value)

Sets the value of the 'Remote Return Message' attribute.

Parameters:

value - the new value of the 'Remote Return Message' attribute.

See Also:

getRemoteReturnMessage()

getResult

StudyCaseResult getResult()

Returns the value of the 'Result' containment reference.

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

reference to a Study Case result object

Returns:

the value of the 'Result' containment reference.

See Also:

setResult(StudyCaseResult), MulticasePackage.getStudyCase_Result()

setResult

void setResult(StudyCaseResult value)

Sets the value of the 'Result' containment reference.

Parameters:

value - the new value of the 'Result' containment reference.

See Also:

getResult()