com.interpss.simu.multicase.rule

Interface RuleBase

All Superinterfaces:

org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

RuleBaseImpl

public interface RuleBase
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'Rule Base'. Class for defining Rule base. RuleBase --(*) RuleSet --(*) Rule. A RuleBase is intended for a type of violation type, decribed by the violation type field.

The following features are supported:

• Violate Type
• VUpper Limit PU
• VLower Limit PU
• Apply Rule Base
• Rule Sets

See Also:

MCaseRulePackage.getRuleBase()

Method Summary

Modifier and Type	Method and Description
void	add(RuleSet ruleSet) add rule set to the rule base.
java.util.List<java.lang.String>	apply(LoadflowAlgorithm algo, IPSSMsgHub msg) Apply this rule base to the AclfNet object contained by the algo object.
boolean	applyForPriority(Network net, int priority, IPSSMsgHub msg) Apply rule sets in the rule base with the specified priority.
org.eclipse.emf.common.util.EList<RuleSet>	getRuleSets() Returns the value of the 'Rule Sets' containment reference list.
int	getUpperPriorityValue() get upper (highest) rule set priority in the rule base.
SecAnalysisViolationType	getViolateType() Returns the value of the 'Violate Type' attribute.
double	getVLowerLimitPU() Returns the value of the 'VLower Limit PU' attribute.
double	getVUpperLimitPU() Returns the value of the 'VUpper Limit PU' attribute.
boolean	isApplyRuleBase() Returns the value of the 'Apply Rule Base' attribute.
void	setApplyRuleBase(boolean value) Sets the value of the 'Apply Rule Base' attribute.
void	setViolateType(SecAnalysisViolationType value) Sets the value of the 'Violate Type' attribute.
void	setVLowerLimitPU(double value) Sets the value of the 'VLower Limit PU' attribute.
void	setVoltageLimit(double upperLimit, double lowerLimit) set upper/lower limit for voltage limit related rules.
void	setVUpperLimitPU(double value) Sets the value of the 'VUpper Limit PU' attribute.

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

getViolateType

SecAnalysisViolationType getViolateType()

Returns the value of the 'Violate Type' attribute. The literals are from the enumeration SecAnalysisViolationType.

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

violation type of the rule base.

Returns:

the value of the 'Violate Type' attribute.

See Also:

SecAnalysisViolationType, setViolateType(SecAnalysisViolationType), MCaseRulePackage.getRuleBase_ViolateType()

setViolateType

void setViolateType(SecAnalysisViolationType value)

Sets the value of the 'Violate Type' attribute.

Parameters:

value - the new value of the 'Violate Type' attribute.

See Also:

SecAnalysisViolationType, getViolateType()

getVUpperLimitPU

double getVUpperLimitPU()

Returns the value of the 'VUpper Limit PU' attribute.

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

voltage upper limit for voltage violation rules

Returns:

the value of the 'VUpper Limit PU' attribute.

See Also:

setVUpperLimitPU(double), MCaseRulePackage.getRuleBase_VUpperLimitPU()

setVUpperLimitPU

void setVUpperLimitPU(double value)

Sets the value of the 'VUpper Limit PU' attribute.

Parameters:

value - the new value of the 'VUpper Limit PU' attribute.

See Also:

getVUpperLimitPU()

getVLowerLimitPU

double getVLowerLimitPU()

Returns the value of the 'VLower Limit PU' attribute.

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

voltage lower limit for voltage violation rules

Returns:

the value of the 'VLower Limit PU' attribute.

See Also:

setVLowerLimitPU(double), MCaseRulePackage.getRuleBase_VLowerLimitPU()

setVLowerLimitPU

void setVLowerLimitPU(double value)

Sets the value of the 'VLower Limit PU' attribute.

Parameters:

value - the new value of the 'VLower Limit PU' attribute.

See Also:

getVLowerLimitPU()

isApplyRuleBase

boolean isApplyRuleBase()

Returns the value of the 'Apply Rule Base' attribute.

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

option to turn on/off this rule base.

Returns:

the value of the 'Apply Rule Base' attribute.

See Also:

setApplyRuleBase(boolean), MCaseRulePackage.getRuleBase_ApplyRuleBase()

setApplyRuleBase

void setApplyRuleBase(boolean value)

Sets the value of the 'Apply Rule Base' attribute.

Parameters:

value - the new value of the 'Apply Rule Base' attribute.

See Also:

isApplyRuleBase()

getRuleSets

org.eclipse.emf.common.util.EList<RuleSet> getRuleSets()

Returns the value of the 'Rule Sets' containment reference list. The list contents are of type RuleSet.

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

Rule set list

Returns:

the value of the 'Rule Sets' containment reference list.

See Also:

MCaseRulePackage.getRuleBase_RuleSets()

apply

java.util.List<java.lang.String> apply(LoadflowAlgorithm algo,
                                       IPSSMsgHub msg)
                                throws InterpssException

Apply this rule base to the AclfNet object contained by the algo object. Then run Loadflow using the algo object. It returns a list of msg, describing rule applying details.

Throws:

InterpssException

applyForPriority

boolean applyForPriority(Network net,
                         int priority,
                         IPSSMsgHub msg)
                  throws InterpssException

Apply rule sets in the rule base with the specified priority. It returns true if there are rules fired.

Throws:

InterpssException

add

void add(RuleSet ruleSet)

add rule set to the rule base.

getUpperPriorityValue

int getUpperPriorityValue()

get upper (highest) rule set priority in the rule base.

setVoltageLimit

void setVoltageLimit(double upperLimit,
                     double lowerLimit)

set upper/lower limit for voltage limit related rules.