com.powerdata.openpa

Interface BusRefIndex

public interface BusRefIndex

Provide bus indexes from equipment lists. For use with applications that make use of indexes rather than objects Note that indexes are always based in the list derived from the model, either getBuses() or getSingleBus(), depending on how it is configured

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BusRefIndex.BusFunction Function that takes a list and index, and return a Bus object
static class	BusRefIndex.TwoTerm Return object for both bus indexes of a list of two-terminal devices

Method Summary

Modifier and Type	Method and Description
static BusRefIndex	CreateFromAlternateTopology(PAModel m, GroupIndex grpndx)
static BusRefIndex	CreateFromConnectivityBuses(PALists m)
static BusRefIndex	CreateFromSingleBuses(PAModel m)
int[]	get1TBus(OneTermDevListIfc<? extends OneTermDev> t1list) Get the list of bus indexes for the one-terminal device list
BusRefIndex.TwoTerm	get2TBus(TwoTermDevListIfc<? extends TwoTermDev> t2list) Get lists of bus indexes for two-terminal device list
BusList	getBuses() return the bus list used for this object, either PAModel.getBuses(), or getSingleBus(), depending on startup configuration
default Bus	getByBus(Bus b) Convert a connectivity-based bus to this topology
int[]	mapBusFcn(BaseList<? extends BaseObject> list, BusRefIndex.BusFunction bfc) Get list of bus indexes for any list that return a bus

Method Detail

getBuses

BusList getBuses()

return the bus list used for this object, either PAModel.getBuses(), or getSingleBus(), depending on startup configuration

get1TBus

int[] get1TBus(OneTermDevListIfc<? extends OneTermDev> t1list)
        throws PAModelException

Get the list of bus indexes for the one-terminal device list

Parameters:

t1list - list of one-terminal devices

Returns:

array of bus indexes for each device

Throws:

PAModelException

get2TBus

BusRefIndex.TwoTerm get2TBus(TwoTermDevListIfc<? extends TwoTermDev> t2list)
                      throws PAModelException

Get lists of bus indexes for two-terminal device list

Parameters:

t2list - list of two-terminal devices

Returns:

object containing from- and to- bus indexes for each device

Throws:

PAModelException

getByBus

default Bus getByBus(Bus b)
              throws PAModelException

Convert a connectivity-based bus to this topology

Parameters:

b - the Connectivity-based bus

Returns:

toplology-based bus

Throws:

PAModelException

mapBusFcn

int[] mapBusFcn(BaseList<? extends BaseObject> list,
                BusRefIndex.BusFunction bfc)
         throws PAModelException

Get list of bus indexes for any list that return a bus

Parameters:

list - List of objects with a function returning buses

bfc -

Returns:

Throws:

PAModelException

CreateFromConnectivityBuses

static BusRefIndex CreateFromConnectivityBuses(PALists m)
                                        throws PAModelException

Throws:

PAModelException

CreateFromSingleBuses

static BusRefIndex CreateFromSingleBuses(PAModel m)
                                  throws PAModelException

Throws:

PAModelException

CreateFromAlternateTopology

static BusRefIndex CreateFromAlternateTopology(PAModel m,
                                               GroupIndex grpndx)
                                        throws PAModelException

Throws:

PAModelException