com.interpss.core.net

Interface NetworkedElement

All Superinterfaces:

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

All Known Subinterfaces:

Aclf3WBranch, AclfBranch, AclfBus, Acsc3WBranch, AcscBranch, AcscBus, BaseAclfBus<TGen,TLoad>, BaseAcscBus<TGen,TLoad>, BaseDStabBus<TGen,TLoad>, BaseHvdcLine2TVSC<TBus>, BaseOpfBranch, BaseOpfBus, BaseOpfGenBus, Branch, Branch3W, Bus, DclfOpfBranch, DclfOpfBus, DclfOpfGenBus, DistBranch, DistBus, DStab3WBranch, DStabBranch, DStabBus, Dynamic3PBranch, Dynamic3PBus, ExtensionElement, HvdcLine2T, HvdcLine2TCCC, HvdcLine2TVSC, HvdcLine2TVSCDyn, HvdcLine2TVSCDynPlus, OpfBranch, OpfBus, OpfGenBus, Steady3PBranch, Steady3PBus

All Known Implementing Classes:

Aclf3WBranchImpl, AclfBranchImpl, AclfBusImpl, Acsc3WBranchImpl, AcscBranchImpl, AcscBusImpl, BaseAclfBusImpl, BaseAcscBusImpl, BaseDStabBusImpl, BaseHvdcLine2TVSCImpl, BaseOpfBranchImpl, BaseOpfBusImpl, Branch3WImpl, BranchImpl, BusImpl, DclfOpfBranchImpl, DclfOpfBusImpl, DclfOpfGenBusImpl, DistBranchImpl, DistBusImpl, DStab3WBranchImpl, DStabBranchImpl, DStabBusImpl, Dynamic3PBranchImpl, Dynamic3PBusImpl, ExtensionElementImpl, HvdcLine2TCCCImpl, HvdcLine2TImpl, HvdcLine2TVSCDynImpl, HvdcLine2TVSCImpl, NetworkedElementImpl, OpfBranchImpl, OpfBusImpl, OpfGenBusImpl, Steady3PBranchImpl, Steady3PBusImpl

public interface NetworkedElement
extends NameTag

A representation of the model object 'Name Tagged Element'. Object with area, zone and owner arributes. It optionally holds a list of ref to CIM record. It has a sortNumber for storing sorting number. The intFlag is for storing some int for certain purpose, usually transient. visited attribute is for network walk through implementation

The following features are supported:

• Boolean Flag
• Weight
• Int Flag
• Sort Number
• Area
• Zone
• Owner

See Also:

NetPackage.getNetworkedElement()

Method Summary

Modifier and Type	Method and Description
Area	getArea() Returns the value of the 'Area' reference.
int	getIntFlag() Returns the value of the 'Int Flag' attribute.
Owner	getOwner() Returns the value of the 'Owner' reference.
int	getSortNumber() Returns the value of the 'Sort Number' attribute.
org.apache.commons.math3.complex.Complex	getWeight() Returns the value of the 'Weight' attribute.
Zone	getZone() Returns the value of the 'Zone' reference.
boolean	isBooleanFlag() Returns the value of the 'Boolean Flag' attribute.
void	setArea(Area value) Sets the value of the 'Area' reference.
void	setBooleanFlag(boolean value) Sets the value of the 'Boolean Flag' attribute.
void	setIntFlag(int value) Sets the value of the 'Int Flag' attribute.
void	setOwner(Owner value) Sets the value of the 'Owner' reference.
void	setSortNumber(int value) Sets the value of the 'Sort Number' attribute.
void	setWeight(org.apache.commons.math3.complex.Complex value) Sets the value of the 'Weight' attribute.
void	setZone(Zone value) Sets the value of the 'Zone' 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

isBooleanFlag

boolean isBooleanFlag()

Returns the value of the 'Boolean Flag' attribute. boolean flag, used for example for tracking status of element in network walk through.

Returns:

the value of the 'Boolean Flag' attribute.

See Also:

setBooleanFlag(boolean), NetPackage.getNetworkedElement_BooleanFlag()

setBooleanFlag

void setBooleanFlag(boolean value)

Sets the value of the 'Boolean Flag' attribute.

Parameters:

value - the new value of the 'Boolean Flag' attribute.

See Also:

isBooleanFlag()

getWeight

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

Returns the value of the 'Weight' attribute. The default value is "0.0". generic weight, used for example, for Loss Allocation

Returns:

the value of the 'Weight' attribute.

See Also:

setWeight(Complex), NetPackage.getNetworkedElement_Weight()

setWeight

void setWeight(org.apache.commons.math3.complex.Complex value)

Sets the value of the 'Weight' attribute.

Parameters:

value - the new value of the 'Weight' attribute.

See Also:

getWeight()

getIntFlag

int getIntFlag()

Returns the value of the 'Int Flag' attribute. this int flag is for internal calculation usage only. Its state is transient. Initialize the filed before using it.

Returns:

the value of the 'Int Flag' attribute.

See Also:

setIntFlag(int), NetPackage.getNetworkedElement_IntFlag()

setIntFlag

void setIntFlag(int value)

Sets the value of the 'Int Flag' attribute.

Parameters:

value - the new value of the 'Int Flag' attribute.

See Also:

getIntFlag()

getSortNumber

int getSortNumber()

Returns the value of the 'Sort Number' attribute. The default value is "0".

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

for generic sorting purpose. Currently it is used for bus number arrangement

Returns:

the value of the 'Sort Number' attribute.

See Also:

setSortNumber(int), NetPackage.getNetworkedElement_SortNumber()

setSortNumber

void setSortNumber(int value)

Sets the value of the 'Sort Number' attribute.

Parameters:

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

See Also:

getSortNumber()

getZone

Zone getZone()

Returns the value of the 'Zone' reference.

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

Loss zone attribute

Returns:

the value of the 'Zone' reference.

See Also:

setZone(Zone), NetPackage.getNetworkedElement_Zone()

setZone

void setZone(Zone value)

Sets the value of the 'Zone' reference.

Parameters:

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

See Also:

getZone()

getOwner

Owner getOwner()

Returns the value of the 'Owner' reference.

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

Owner attribute

Returns:

the value of the 'Owner' reference.

See Also:

setOwner(Owner), NetPackage.getNetworkedElement_Owner()

setOwner

void setOwner(Owner value)

Sets the value of the 'Owner' reference.

Parameters:

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

See Also:

getOwner()

getArea

Area getArea()

Returns the value of the 'Area' reference.

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

area attribute

Returns:

the value of the 'Area' reference.

See Also:

setArea(Area), NetPackage.getNetworkedElement_Area()

setArea

void setArea(Area value)

Sets the value of the 'Area' reference.

Parameters:

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

See Also:

getArea()