com.interpss.core

Class CoreObjectFactory

java.lang.Object

com.interpss.core.CoreObjectFactory

public class CoreObjectFactory
extends java.lang.Object

Factory methods for create interpss core simulation object

Constructor Summary

Constructors

Constructor and Description
CoreObjectFactory()

Method Summary

Modifier and Type	Method and Description
static Aclf3WBranch	createAclf3WBranch() Create an Aclf3WXformer object
static Aclf3WPSXformerAdapter	createAclf3WPSXfr(java.lang.String fromId, java.lang.String toId, java.lang.String tertId, AclfNetwork net) Create an Aclf3WXformer object of type 3WPSXfr
static Aclf3WXformerAdapter	createAclf3WXfr(java.lang.String fromId, java.lang.String toId, java.lang.String tertId, AclfNetwork net) Create an Aclf3WXformer object of type 3WXfr
static AclfBranch	createAclfBranch() Create an AclfBranch object
static AclfBranch	createAclfBranch(java.util.function.Consumer<AclfBranch> initializer) Create an AclfBranch object
static AclfBranch	createAclfBranch(int areaNo, int zoneNo, java.lang.String cirNo, BaseAclfNetwork<?,?> net) Create an AclfBranch object
static AclfBranch	createAclfBranch(java.lang.String cirNo, BaseAclfNetwork<?,?> net) Create an AclfBranch object
static AclfBus	createAclfBus() Create an AclfBus object
static AclfBus	createAclfBus(java.util.function.Consumer<AclfBus> initializer) Create an AclfBus object
static java.util.Optional<AclfBus>	createAclfBus(java.lang.String busId, BaseAclfNetwork<?,?> net) Create an AclfBus object and add it to the net
static java.util.Optional<AclfBus>	createAclfBus(java.lang.String busId, BaseAclfNetwork<?,?> net, java.util.function.Consumer<AclfBus> initializer) Create an AclfBus object and add it to the net
static java.util.Optional<AclfBus>	createAclfBus(java.lang.String busId, int areaNo, int zoneNo, java.lang.String ownerId, BaseAclfNetwork<?,?> net) Create an AclfBus object and add the object into the Network
static AclfDclfAlgorithm<ContingencyAnalysisAlgorithm>	createAclfDclfAlgorithm() Create a AclfDclfAlgorithm object
static AclfDclfAlgorithm<ContingencyAnalysisAlgorithm>	createAclfDclfAlgorithm(BaseAclfNetwork<?,?> net) Create a AclfDclfAlgorithm object
static AclfDclfAlgorithm<ContingencyAnalysisAlgorithm>	createAclfDclfAlgorithm(BaseAclfNetwork<?,?> net, AclfMethodType method) Create a AclfDclfAlgorithm object
static AclfDclfAlgorithm<ContingencyAnalysisAlgorithm>	createAclfDclfAlgorithm(BaseAclfNetwork<?,?> net, IDclfSolver.CacheType cacheType) Create a AclfDclfAlgorithm object
static AclfGen	createAclfGen() Create an AclfGen object
static AclfGen	createAclfGen(java.lang.String id) Create an AclfGen object
static AclfLoad	createAclfLoad() Create an AclfLoad object
static AclfLoad	createAclfLoad(java.lang.String id) Create an AclfLoad object
static AclfNetwork	createAclfNetwork() Create an AclfNetwork object
static AclfNetwork	createAclfNetwork(java.util.function.Consumer<AclfNetwork> initializer) Create an AclfNetwork object
static AclfNetwork	createAclfNetwork(java.lang.String netId) Create an AclfNetwork object
static Branch	createAcsc3WXformer() Create an Acsc 3-Winding transformer object
static AcscBranch	createAcscBranch() Create an AcscBranch object
static AcscBranch	createAcscBranch(Branch branch, Area area, Zone zone) Create an AcscBranch object for distribution system analysis
static AcscBranchFault	createAcscBranchFault(java.lang.String branchId, BaseAcscNetwork<?,?> net, boolean cacheBusScVolt) Create an AcscBranchFault object
static AcscBranchFault	createAcscBranchFault(java.lang.String branchId, SimpleFaultAlgorithm faultAlgo, boolean cacheBusScVolt) Create an AcscBranchFault object
static AcscBus	createAcscBus() Create an AcscBus object
static java.util.Optional<AcscBus>	createAcscBus(Bus bus, Area area, Zone zone, AcscNetwork net) Create an reference AcscBus object for distribution system analysis
static java.util.Optional<AcscBus>	createAcscBus(java.lang.String busId, BaseAcscNetwork<AcscBus,AcscBranch> net) Create an AcscBus object
static AcscBusFault	createAcscBusFault(java.lang.String busId, BaseAcscNetwork<?,?> net, boolean cacheBusScVolt) Create an AcscBusFault object
static AcscBusFault	createAcscBusFault(java.lang.String busId, SimpleFaultAlgorithm faultAlgo, boolean cacheBusScVolt) Create an AcscBusFault object
static AcscGen	createAcscGen() Create an AcscGen object
static AcscGen	createAcscGen(java.lang.String genId) Create an AcscGen object
static AcscGen	createAcscGen(java.lang.String genId, BaseAcscBus<AcscGen,AcscLoad> bus) Create an AcscGen object
static AcscLoad	createAcscLoad() Create an AcscLoad object
static AcscLoad	createAcscLoad(java.lang.String id) Create an AclfLoad object
static AcscNetwork	createAcscNetwork() Create an AcscNetwork object
static Area	createArea() Create an Area object
static Area	createArea(long number, Network<?,?> net) Create an Area object, if the area number exists, just return the area object
static Area	createArea(java.lang.String id, Network<?,?> net) Create an Area object, if the area name exists, just return the area object
static java.util.Optional<AreaInterchangeControl>	createAreaInterchangeController(int number, java.lang.String areaName, AclfNetwork net) Create an Area interchange control object
static Branch	createBranch() Create a Branch object
static Branch	createBranch(java.lang.String fromId, java.lang.String toId, Network<Bus,Branch> net) create a branch object
static Bus	createBus(java.lang.String busId, Network<Bus,Branch> net) Create a Bus object
static BusScGrounding	createBusScGrounding() Create an BusScGrounding object
static LoadflowAlgorithm	createChildNetLoadflowAlgorithm() Create a multi-network Loadflow algorithm object
static CustomLFMethod	createCustomLFMethod() Create a CustomLFMethod object
static DataCheckConfiguration	createDataCheckConfiguration() Create a DataCheckConfiguration object
static DataCheckConfiguration	createDefultDataCheckConfiguration() Create a default DataCheckConfiguration object
static LoadflowAlgorithm	createLoadflowAlgorithm() Create a Loadflow algorithm object
static LoadflowAlgorithm	createLoadflowAlgorithm(BaseAclfNetwork<?,?> net) Create a LoadflowAlgorithm algorithm object
static LoadflowAlgorithm	createLoadflowAlgorithm(BaseAclfNetwork<?,?> net, AclfMethodType method) Create a LoadflowAlgorithm algorithm object
static LossAllocationAlgorithm	createLossAllocationAlgorithm() Create a LossAllocationAlgorithm algorithm object
static NameTag	createNameTag(java.lang.String id, java.lang.String name) Create a NameTag object
static NetPathWalkAlgorithm<Bus,Branch>	createNetPathWalkAlgorithm() Create a ActivePowerWalkThrough algorithm object
static Network<Bus,Branch>	createNetwork() Create a Network object
static Owner	createOwner() Create a owner object
static Owner	createOwner(int ownerNo, Network<Bus,Branch> net) Create a owner object
static Owner	createOwner(java.lang.String ownerId, Network<?,?> net) Create a owner object, , if the owner exists, just return
static ShuntCompensator	createShuntCompensator(java.lang.String id, ShuntCompensatorType type) Create a QBank object
static ShuntCompensator	createShuntCompensator(SwitchedShunt shunt, ShuntCompensatorType type) Create a ShuntCompensator object and add to the SwitchedShunt container
static SimpleFaultAlgorithm	createSimpleFaultAlgorithm(BaseAcscNetwork<?,?> net) Create a SimpleFault algorithm object
static Substation	createSubstation() Create a Substation object
static Substation	createSubstation(java.lang.String name, Network<?,?> net) Create a Substation object, if the Substation name exists, just return
static TieLine	createTieLine() Create a TieLine object
static java.util.Optional<XfrZTableEntry>	createXfrZTableEntry(int num, BaseAclfNetwork<?,?> net) create a XfrZTableEntry and added into the AclfNet
static XfrZTableEntry	createXfrZTableEntry(java.lang.String enrtyId, java.util.List<XfrZTableEntry> table) Create a XfrZTableEntry object and add it to the table
static Zone	createZone() Create a Zone object
static Zone	createZone(long number, Network<?,?> net) Create a Zone object, if the zone number exists, just return
static Zone	createZone(java.lang.String id, Network<?,?> net) Create a Zone object, if the zone number exists, just return
static void	initAclfNetwork(AclfNetwork aclfNet) initialize an newly created AclfNetwork object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CoreObjectFactory

public CoreObjectFactory()

Method Detail

createNameTag

public static NameTag createNameTag(java.lang.String id,
                                    java.lang.String name)

Create a NameTag object

Parameters:

id -

name -

Returns:

the created object

createDataCheckConfiguration

public static DataCheckConfiguration createDataCheckConfiguration()

Create a DataCheckConfiguration object

Returns:

the created DataCheckConfiguration object

createDefultDataCheckConfiguration

public static DataCheckConfiguration createDefultDataCheckConfiguration()

Create a default DataCheckConfiguration object

Returns:

the created DataCheckConfiguration object

createNetwork

public static Network<Bus,Branch> createNetwork()

Create a Network object

Returns:

the created Network object

createBus

public static Bus createBus(java.lang.String busId,
                            Network<Bus,Branch> net)

Create a Bus object

Parameters:

busId - bus id

net -

Returns:

the created Bus object

createBranch

public static Branch createBranch()

Create a Branch object

Returns:

the created Branch object

createBranch

public static Branch createBranch(java.lang.String fromId,
                                  java.lang.String toId,
                                  Network<Bus,Branch> net)

create a branch object

Parameters:

fromId -

toId -

net -

Returns:

the created Branch object

createTieLine

public static TieLine createTieLine()

Create a TieLine object

Returns:

the created TieLine object

createArea

public static Area createArea()

Create an Area object

Returns:

the created Area object

createArea

public static Area createArea(long number,
                              Network<?,?> net)

Create an Area object, if the area number exists, just return the area object

Parameters:

number - area number

net -

Returns:

the created Area object

createArea

public static Area createArea(java.lang.String id,
                              Network<?,?> net)

Create an Area object, if the area name exists, just return the area object

Parameters:

name - area id

net -

Returns:

the created Area object

createAreaInterchangeController

public static java.util.Optional<AreaInterchangeControl> createAreaInterchangeController(int number,
                                                                                         java.lang.String areaName,
                                                                                         AclfNetwork net)

Create an Area interchange control object

Parameters:

number - area number

areaName -

net -

Returns:

the created AreaInterchangeControl object

createZone

public static Zone createZone()

Create a Zone object

Returns:

the created Zone object

createZone

public static Zone createZone(long number,
                              Network<?,?> net)

Create a Zone object, if the zone number exists, just return

Parameters:

number - zone number

net -

Returns:

the created Zone object

createZone

public static Zone createZone(java.lang.String id,
                              Network<?,?> net)

Create a Zone object, if the zone number exists, just return

Parameters:

name - zone id

net -

Returns:

the created Zone object

createSubstation

public static Substation createSubstation()

Create a Substation object

Returns:

the created Substation object

createSubstation

public static Substation createSubstation(java.lang.String name,
                                          Network<?,?> net)

Create a Substation object, if the Substation name exists, just return

Parameters:

name - Substation name

net -

Returns:

the created Substation object

createOwner

public static Owner createOwner()

Create a owner object

Returns:

the created owner object

createOwner

public static Owner createOwner(java.lang.String ownerId,
                                Network<?,?> net)

Create a owner object, , if the owner exists, just return

Parameters:

ownerId - owner id

net -

Returns:

the created owner object

createOwner

public static Owner createOwner(int ownerNo,
                                Network<Bus,Branch> net)

Create a owner object

Parameters:

ownerNo -

net -

Returns:

the created owner object

createAclfNetwork

public static AclfNetwork createAclfNetwork()

Create an AclfNetwork object

Returns:

the created AclfNetwork object

createAclfNetwork

public static AclfNetwork createAclfNetwork(java.lang.String netId)

Create an AclfNetwork object

Parameters:

netId -

Returns:

the created AclfNetwork object

initAclfNetwork

public static void initAclfNetwork(AclfNetwork aclfNet)

initialize an newly created AclfNetwork object

Parameters:

aclfNet -

createAclfNetwork

public static AclfNetwork createAclfNetwork(java.util.function.Consumer<AclfNetwork> initializer)

Create an AclfNetwork object

Parameters:

initializer -

Returns:

the created AclfNetwork object

createXfrZTableEntry

public static java.util.Optional<XfrZTableEntry> createXfrZTableEntry(int num,
                                                                      BaseAclfNetwork<?,?> net)

create a XfrZTableEntry and added into the AclfNet

Parameters:

num -

net -

Returns:

the created XfrZTableEntry object

createAclfGen

public static AclfGen createAclfGen()

Create an AclfGen object

Returns:

the created AclfGen object

createAclfGen

public static AclfGen createAclfGen(java.lang.String id)

Create an AclfGen object

Parameters:

id -

Returns:

the create AclfGen object

createAclfLoad

public static AclfLoad createAclfLoad()

Create an AclfLoad object

Returns:

the created AclfLoad object

createAclfLoad

public static AclfLoad createAclfLoad(java.lang.String id)

Create an AclfLoad object

Parameters:

id -

Returns:

the create AclfLoad object

createAclfBus

public static AclfBus createAclfBus()

Create an AclfBus object

Returns:

the AclfBus object

createAclfBus

public static AclfBus createAclfBus(java.util.function.Consumer<AclfBus> initializer)

Create an AclfBus object

Parameters:

initializer - AclfBus object initializer function

Returns:

the AclfBus object

createAclfBus

public static java.util.Optional<AclfBus> createAclfBus(java.lang.String busId,
                                                        BaseAclfNetwork<?,?> net)

Create an AclfBus object and add it to the net

Parameters:

busId - bus id

net -

Returns:

the created AclfBus object

createAclfBus

public static java.util.Optional<AclfBus> createAclfBus(java.lang.String busId,
                                                        BaseAclfNetwork<?,?> net,
                                                        java.util.function.Consumer<AclfBus> initializer)

Create an AclfBus object and add it to the net

Parameters:

busId - bus id

net -

initializer - AclfBus object initializer function

Returns:

the created AclfBus object

createAclfBus

public static java.util.Optional<AclfBus> createAclfBus(java.lang.String busId,
                                                        int areaNo,
                                                        int zoneNo,
                                                        java.lang.String ownerId,
                                                        BaseAclfNetwork<?,?> net)

Create an AclfBus object and add the object into the Network

Parameters:

busId - bus id

areaNo - bus area number

zoneNo - bus zone number

ownerId -

net -

Returns:

the created AclfBus object

createAclfBranch

public static AclfBranch createAclfBranch()

Create an AclfBranch object

Returns:

the created AclfBranch object

createAclfBranch

public static AclfBranch createAclfBranch(java.util.function.Consumer<AclfBranch> initializer)

Create an AclfBranch object

Parameters:

initializer - AclfBranch object initializer function

Returns:

the created AclfBranch object

createAclfBranch

public static AclfBranch createAclfBranch(java.lang.String cirNo,
                                          BaseAclfNetwork<?,?> net)

Create an AclfBranch object

Returns:

the create AclfBranch object

createAclfBranch

public static AclfBranch createAclfBranch(int areaNo,
                                          int zoneNo,
                                          java.lang.String cirNo,
                                          BaseAclfNetwork<?,?> net)

Create an AclfBranch object

Parameters:

areaNo -

zoneNo -

cirNo -

net -

Returns:

the created AclfBranch object

createAclf3WBranch

public static Aclf3WBranch createAclf3WBranch()

Create an Aclf3WXformer object

Returns:

the created Aclf3WXformer object

createAclf3WXfr

public static Aclf3WXformerAdapter createAclf3WXfr(java.lang.String fromId,
                                                   java.lang.String toId,
                                                   java.lang.String tertId,
                                                   AclfNetwork net)

Create an Aclf3WXformer object of type 3WXfr

Parameters:

fromI -

toId -

tertId -

net -

Returns:

the create Xfr3WAdapter object

createAclf3WPSXfr

public static Aclf3WPSXformerAdapter createAclf3WPSXfr(java.lang.String fromId,
                                                       java.lang.String toId,
                                                       java.lang.String tertId,
                                                       AclfNetwork net)

Create an Aclf3WXformer object of type 3WPSXfr

Parameters:

fromId -

toId -

tertId -

net -

Returns:

the created PSXfr3WAdapter object

createShuntCompensator

public static ShuntCompensator createShuntCompensator(java.lang.String id,
                                                      ShuntCompensatorType type)

Create a QBank object

Returns:

the created QBank object

createShuntCompensator

public static ShuntCompensator createShuntCompensator(SwitchedShunt shunt,
                                                      ShuntCompensatorType type)

Create a ShuntCompensator object and add to the SwitchedShunt container

Returns:

the created ShuntCompensator object

createXfrZTableEntry

public static XfrZTableEntry createXfrZTableEntry(java.lang.String enrtyId,
                                                  java.util.List<XfrZTableEntry> table)

Create a XfrZTableEntry object and add it to the table

Parameters:

enrtyId - entry id

table - the XfrZTableEntry table

Returns:

the created XfrZTableEntry object

createNetPathWalkAlgorithm

public static NetPathWalkAlgorithm<Bus,Branch> createNetPathWalkAlgorithm()

Create a ActivePowerWalkThrough algorithm object

Returns:

the created ActivePowerWalkThrough algorithm object

createLossAllocationAlgorithm

public static LossAllocationAlgorithm createLossAllocationAlgorithm()

Create a LossAllocationAlgorithm algorithm object

Returns:

the created LossAllocationAlgorithm algorithm object

createLoadflowAlgorithm

public static LoadflowAlgorithm createLoadflowAlgorithm()

Create a Loadflow algorithm object

Returns:

the created Loadflow algorithm object

createChildNetLoadflowAlgorithm

public static LoadflowAlgorithm createChildNetLoadflowAlgorithm()

Create a multi-network Loadflow algorithm object

Returns:

the created Loadflow algorithm object

createCustomLFMethod

public static CustomLFMethod createCustomLFMethod()

Create a CustomLFMethod object

Returns:

the created CustomLFMethod object

createLoadflowAlgorithm

public static LoadflowAlgorithm createLoadflowAlgorithm(BaseAclfNetwork<?,?> net)

Create a LoadflowAlgorithm algorithm object

Parameters:

net - a AclfNet object

Returns:

the created LoadflowAlgorithm algorithm object

createLoadflowAlgorithm

public static LoadflowAlgorithm createLoadflowAlgorithm(BaseAclfNetwork<?,?> net,
                                                        AclfMethodType method)

Create a LoadflowAlgorithm algorithm object

Parameters:

net - a AclfNet object

method -

Returns:

the created LoadflowAlgorithm algorithm object

createAclfDclfAlgorithm

public static AclfDclfAlgorithm<ContingencyAnalysisAlgorithm> createAclfDclfAlgorithm()

Create a AclfDclfAlgorithm object

Returns:

the created AclfDclfAlgorithm object

createAclfDclfAlgorithm

public static AclfDclfAlgorithm<ContingencyAnalysisAlgorithm> createAclfDclfAlgorithm(BaseAclfNetwork<?,?> net,
                                                                                      IDclfSolver.CacheType cacheType)

Create a AclfDclfAlgorithm object

Parameters:

net - a AclfNet object

Returns:

the created AclfDclfAlgorithm object

createAclfDclfAlgorithm

public static AclfDclfAlgorithm<ContingencyAnalysisAlgorithm> createAclfDclfAlgorithm(BaseAclfNetwork<?,?> net)

Create a AclfDclfAlgorithm object

Parameters:

net - a AclfNet object

Returns:

the created AclfDclfAlgorithm object

createAclfDclfAlgorithm

public static AclfDclfAlgorithm<ContingencyAnalysisAlgorithm> createAclfDclfAlgorithm(BaseAclfNetwork<?,?> net,
                                                                                      AclfMethodType method)

Create a AclfDclfAlgorithm object

Parameters:

net - a AclfNet object

method -

Returns:

the created AclfDclfAlgorithm object

createAcscGen

public static AcscGen createAcscGen()

Create an AcscGen object

Returns:

the created AcscGen object

createAcscGen

public static AcscGen createAcscGen(java.lang.String genId)

Create an AcscGen object

Parameters:

genId -

Returns:

the created AcscGen object

createAcscGen

public static AcscGen createAcscGen(java.lang.String genId,
                                    BaseAcscBus<AcscGen,AcscLoad> bus)

Create an AcscGen object

Parameters:

genId -

bus -

Returns:

the created AcscGen object

createAcscLoad

public static AcscLoad createAcscLoad()

Create an AcscLoad object

Returns:

the created AcscLoad object

createAcscLoad

public static AcscLoad createAcscLoad(java.lang.String id)

Create an AclfLoad object

Parameters:

id -

Returns:

the created AclfLoad object

createAcscBus

public static AcscBus createAcscBus()

Create an AcscBus object

Returns:

the created AcscBus object

createAcscBus

public static java.util.Optional<AcscBus> createAcscBus(java.lang.String busId,
                                                        BaseAcscNetwork<AcscBus,AcscBranch> net)

Create an AcscBus object

Parameters:

busId - bus id

net - an AcscNetwork object

Returns:

the created AcscBus object

createAcscBus

public static java.util.Optional<AcscBus> createAcscBus(Bus bus,
                                                        Area area,
                                                        Zone zone,
                                                        AcscNetwork net)

Create an reference AcscBus object for distribution system analysis

Parameters:

bus -

area -

zone -

net -

Returns:

the created AcscBus object

createBusScGrounding

public static BusScGrounding createBusScGrounding()

Create an BusScGrounding object

Returns:

the created BusScGrounding object

createAcscBranch

public static AcscBranch createAcscBranch()

Create an AcscBranch object

Returns:

the created AcscBranch object

createAcscBranch

public static AcscBranch createAcscBranch(Branch branch,
                                          Area area,
                                          Zone zone)

Create an AcscBranch object for distribution system analysis

Parameters:

branch -

area -

zone -

Returns:

the created AcscBranch object

createAcsc3WXformer

public static Branch createAcsc3WXformer()

Create an Acsc 3-Winding transformer object

Returns:

the created AcscBranchFault object

createAcscBusFault

public static AcscBusFault createAcscBusFault(java.lang.String busId,
                                              BaseAcscNetwork<?,?> net,
                                              boolean cacheBusScVolt)

Create an AcscBusFault object

Parameters:

busId - bus id

net - an AcscNetwork object

Returns:

the created AcscBusFault object

createAcscBusFault

public static AcscBusFault createAcscBusFault(java.lang.String busId,
                                              SimpleFaultAlgorithm faultAlgo,
                                              boolean cacheBusScVolt)

Create an AcscBusFault object

Parameters:

busId - bus id

faultAlgo - a SimpleFaultAlgorithm object

cacheBusScVolt -

Returns:

the created AcscBusFault object

createAcscBranchFault

public static AcscBranchFault createAcscBranchFault(java.lang.String branchId,
                                                    BaseAcscNetwork<?,?> net,
                                                    boolean cacheBusScVolt)

Create an AcscBranchFault object

Parameters:

branchId - branch id

net - an AcscNetwork object

cacheBusScVolt -

Returns:

the created AcscBranchFault object

createAcscBranchFault

public static AcscBranchFault createAcscBranchFault(java.lang.String branchId,
                                                    SimpleFaultAlgorithm faultAlgo,
                                                    boolean cacheBusScVolt)

Create an AcscBranchFault object

Parameters:

branchId - branch id

net - an SimpleFaultAlgorithm object

cacheBusScVolt -

Returns:

the created AcscBranchFault object

createAcscNetwork

public static AcscNetwork createAcscNetwork()

Create an AcscNetwork object

Returns:

the created AcscNetwork object

createSimpleFaultAlgorithm

public static SimpleFaultAlgorithm createSimpleFaultAlgorithm(BaseAcscNetwork<?,?> net)

Create a SimpleFault algorithm object

Parameters:

net - an AcscNetwork object

Returns:

the created SimpleFaultAlgorithm object