com.interpss.simu.multicase.rule

Interface BusActionRule

All Superinterfaces:

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

All Known Implementing Classes:

BusActionRuleImpl

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

A representation of the model object 'Bus Action Rule'. Class for defining Bus action rule. Bus rule is evaluated against voltage limit. It has a set of conditions and a set of bus actions, which are BusModification objects. All rule conditions use the same condition operator (AND or OR).

The following features are supported:

• Parent
• Opt Type
• Bus Condition
• Bus Action

See Also:

MCaseRulePackage.getBusActionRule()

Method Summary

Modifier and Type	Method and Description
void	add(BusCondition busCond) add bus condition
void	add(BusModification busMod) add bus modification action
void	apply(Network net, IPSSMsgHub msg) apply bus actions
boolean	evaluate(double vUpperLimitPU, double vLowerLimitPU, IPSSMsgHub msg) evaluate rule conditions
org.eclipse.emf.common.util.EList<BusModification>	getBusAction() Returns the value of the 'Bus Action' containment reference list.
org.eclipse.emf.common.util.EList<BusCondition>	getBusCondition() Returns the value of the 'Bus Condition' containment reference list.
ConditionOptType	getOptType() Returns the value of the 'Opt Type' attribute.
RuleSet	getParent() Returns the value of the 'Parent' reference.
void	setOptType(ConditionOptType value) Sets the value of the 'Opt Type' attribute.
void	setParent(RuleSet value) Sets the value of the 'Parent' reference.

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

getParent

RuleSet getParent()

Returns the value of the 'Parent' reference.

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

reference to the parent rule set object

Returns:

the value of the 'Parent' reference.

See Also:

setParent(RuleSet), MCaseRulePackage.getBusActionRule_Parent()

setParent

void setParent(RuleSet value)

Sets the value of the 'Parent' reference.

Parameters:

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

See Also:

getParent()

getOptType

ConditionOptType getOptType()

Returns the value of the 'Opt Type' attribute. The literals are from the enumeration ConditionOptType.

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

rule condition operator (AND or OR)

Returns:

the value of the 'Opt Type' attribute.

See Also:

ConditionOptType, setOptType(ConditionOptType), MCaseRulePackage.getBusActionRule_OptType()

setOptType

void setOptType(ConditionOptType value)

Sets the value of the 'Opt Type' attribute.

Parameters:

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

See Also:

ConditionOptType, getOptType()

getBusCondition

org.eclipse.emf.common.util.EList<BusCondition> getBusCondition()

Returns the value of the 'Bus Condition' containment reference list. The list contents are of type BusCondition. It is bidirectional and its opposite is 'Parent'.

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

bus condition object list

Returns:

the value of the 'Bus Condition' containment reference list.

See Also:

MCaseRulePackage.getBusActionRule_BusCondition(), BusCondition.getParent()

getBusAction

org.eclipse.emf.common.util.EList<BusModification> getBusAction()

Returns the value of the 'Bus Action' containment reference list. The list contents are of type BusModification.

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

bus modification action object list

Returns:

the value of the 'Bus Action' containment reference list.

See Also:

MCaseRulePackage.getBusActionRule_BusAction()

apply

void apply(Network net,
           IPSSMsgHub msg)
    throws InterpssException

apply bus actions

Throws:

InterpssException

evaluate

boolean evaluate(double vUpperLimitPU,
                 double vLowerLimitPU,
                 IPSSMsgHub msg)

evaluate rule conditions

add

void add(BusCondition busCond)

add bus condition

add

void add(BusModification busMod)

add bus modification action