com.interpss.core.aclf.flow

Interface FlowInterface

All Superinterfaces:

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

All Known Implementing Classes:

FlowInterfaceImpl

public interface FlowInterface
extends NameTag

A representation of the model object 'Interface'. flow interface defined for limit violation checking

The following features are supported:

• Network
• On Peak Limit
• Off Peak Limit
• Interface Branches

See Also:

FlowInterfacePackage.getFlowInterface()

Method Summary

Modifier and Type	Method and Description
org.apache.commons.math3.complex.Complex	flowExport() calculate total interface flow in the export direction, from->to
org.apache.commons.math3.complex.Complex	flowImport() calculate total interface flow in the import direction to->from
org.eclipse.emf.common.util.EList<FlowInterfaceBranch>	getInterfaceBranches() Returns the value of the 'Interface Branches' containment reference list.
AclfNetwork	getNetwork() Returns the value of the 'Network' reference.
FlowInterfaceLimit	getOffPeakLimit() Returns the value of the 'Off Peak Limit' containment reference.
FlowInterfaceLimit	getOnPeakLimit() Returns the value of the 'On Peak Limit' containment reference.
boolean	offPeakViolation() Check offPeak flow violation
boolean	onPeakViolation() Check onPeak flow violation
void	setNetwork(AclfNetwork value) Sets the value of the 'Network' reference.
void	setOffPeakLimit(FlowInterfaceLimit value) Sets the value of the 'Off Peak Limit' containment reference.
void	setOnPeakLimit(FlowInterfaceLimit value) Sets the value of the 'On Peak Limit' containment reference.

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

getNetwork

AclfNetwork getNetwork()

Returns the value of the 'Network' reference.

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

Containing parent AclfNetwork

Returns:

the value of the 'Network' reference.

See Also:

setNetwork(AclfNetwork), FlowInterfacePackage.getFlowInterface_Network()

setNetwork

void setNetwork(AclfNetwork value)

Sets the value of the 'Network' reference.

Parameters:

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

See Also:

getNetwork()

getOnPeakLimit

FlowInterfaceLimit getOnPeakLimit()

Returns the value of the 'On Peak Limit' containment reference.

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

OnPeak flow limit

Returns:

the value of the 'On Peak Limit' containment reference.

See Also:

setOnPeakLimit(FlowInterfaceLimit), FlowInterfacePackage.getFlowInterface_OnPeakLimit()

setOnPeakLimit

void setOnPeakLimit(FlowInterfaceLimit value)

Sets the value of the 'On Peak Limit' containment reference.

Parameters:

value - the new value of the 'On Peak Limit' containment reference.

See Also:

getOnPeakLimit()

getOffPeakLimit

FlowInterfaceLimit getOffPeakLimit()

Returns the value of the 'Off Peak Limit' containment reference.

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

OffPeak flow limit

Returns:

the value of the 'Off Peak Limit' containment reference.

See Also:

setOffPeakLimit(FlowInterfaceLimit), FlowInterfacePackage.getFlowInterface_OffPeakLimit()

setOffPeakLimit

void setOffPeakLimit(FlowInterfaceLimit value)

Sets the value of the 'Off Peak Limit' containment reference.

Parameters:

value - the new value of the 'Off Peak Limit' containment reference.

See Also:

getOffPeakLimit()

getInterfaceBranches

org.eclipse.emf.common.util.EList<FlowInterfaceBranch> getInterfaceBranches()

Returns the value of the 'Interface Branches' containment reference list. The list contents are of type FlowInterfaceBranch. It is bidirectional and its opposite is 'Interface'.

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

AclfBranch list of the flow interface

Returns:

the value of the 'Interface Branches' containment reference list.

See Also:

FlowInterfacePackage.getFlowInterface_InterfaceBranches(), FlowInterfaceBranch.getInterface()

flowImport

org.apache.commons.math3.complex.Complex flowImport()

calculate total interface flow in the import direction to->from

flowExport

org.apache.commons.math3.complex.Complex flowExport()

calculate total interface flow in the export direction, from->to

onPeakViolation

boolean onPeakViolation()

Check onPeak flow violation

offPeakViolation

boolean offPeakViolation()

Check offPeak flow violation