Class SubnetworkImpl
- All Implemented Interfaces:
Extendable<Network>
,Container<Network>
,Identifiable<Network>
,MultiVariantObject
,NetworkExt
,Network
,Validable
- Author:
- Miora Vedelago <miora.ralambotiana at rte-france.com>
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.powsybl.iidm.network.Network
Network.BusBreakerView, Network.BusView, Network.PrettyNetworkFactory
-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
protected String
protected String
protected final Properties
protected String
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Add an alias to the object.void
void
Add an alias to the object.void
void
addListener
(NetworkListener listener) Add a listener on the network.void
allocateVariantArrayElement
(int[] indexes, int sourceIndex) Called to allocate a variant array element.void
allowReporterContextMultiThreadAccess
(boolean allow) AllowsReporterContext
to be accessed simultaneously by different threads.createSubnetwork
(String subnetworkId, String name, String sourceFormat) Create an empty subnetwork in the current network.void
deleteVariantArrayElement
(int index) Called to delete a variant array element.detach()
Detach the current network (including its subnetworks) from its parent network.void
extendVariantArraySize
(int initVariantArraySize, int number, int sourceIndex) Called to extend the variant array.Get the aliases of the object.getAliasFromType
(String aliasType) Get the alias of the object with a given alias type if it exists.getAliasType
(String alias) Get the alias type of an alias if it exists, an empty optional otherwise.Get all batteries.getBattery
(String id) Get a battery.int
Get the battery count.Get all batteries.Set<Identifiable<?>>
Return all the boundary elements of the current network, i.e. the elements which link or might link this network to an external voltage level.Branch<?>
Get a branchint
Get the branch count.Get all branchesGet all branchesGet a busbar section from its id or an alias.int
Get the busbar section count.Get all busbar sections.Get all busbar sections.Get a bus/breaker view of the network.Get a bus view of the network.Get the date that the network represents.Connectable<?>
getConnectable
(String id) Get a connectable by its ID or aliasint
Count the connectables of the network<C extends Connectable>
intgetConnectableCount
(Class<C> clazz) Count the connectables of the network for a given typeGet all connectables of the network<C extends Connectable>
Iterable<C>getConnectables
(Class<C> clazz) Get all connectables of the network for a given typeGet a stream of all connectables of the network<C extends Connectable>
Stream<C>getConnectableStream
(Class<C> clazz) Get a stream of all connectables of the network for a given typeGet all countries.int
Get the country count.Get a dangling line.int
Get the dangling line count.Get all dangling lines.getDanglingLines
(DanglingLineFilter danglingLineFilter) Get all dangling lines corresponding to given filter.Get all the dangling lines.getDanglingLineStream
(DanglingLineFilter danglingLineFilter) Get the dangling lines corresponding to given filter.int
Get the forecast distance in minutes.getGenerator
(String id) Get a generator.int
Get the generator count.Get all generators.Get all generators.Get an HVDC converter station.int
Get HVDC converter stations count.Get all HVDC converter stations.Get all HVDC converter stations.getHvdcLine
(HvdcConverterStation converterStation) Get an HVDC line from a converter stationgetHvdcLine
(String id) Get an HVDC line.int
Get HVDC lines count.Get all HVDC lines.Get all HVDC lines.getId()
Get the unique identifier of the object.Identifiable<?>
Get an equipment by its ID or aliasGet all identifiables of the network.Stream<Identifiable<?>>
getIdentifiableStream
(IdentifiableType identifiableType) Get an LCC converter station.int
Get LCC converter stations count.Get all LCC converter stations.Get all LCC converter stations.Get a AC line.int
Get the AC line count.getLines()
Get all AC lines.Get all AC lines.Get a load.int
Get the load count.getLoads()
Get all loads.Get all loads.Get the name of the object if it exists.com.powsybl.iidm.network.impl.NetworkImpl
Get the network associated to the object.Return an optional containing the name of the object if it exists.getProperty
(String key) Get property associated to specified key.getProperty
(String key, String defaultValue) Get property associated to specified key, with default value.Get properties key values.Get theReporterContext
of the network.RefChain<com.powsybl.iidm.network.impl.NetworkImpl>
Return the reference to the root network which is also used within the network elements.Get a compensator shunt.int
Get the shunt count.Get all compensator shunts.Get all compensator shunts.Get the source format.Get a static var compensator.int
Get the static var compensator count.Get all static var compensators.Get all static var compensators.final Network
getSubnetwork
(String id) final Collection<Network>
getSubstation
(String id) Get a substation.int
Get the substation count.Get all substations.getSubstations
(Country country, String tsoId, String... geographicalTags) Get substation located in a specific county, TSO and marked with a list of geographical tag.getSubstations
(String country, String tsoId, String... geographicalTags) Get substation located in a specific county, TSO and marked with a list of geographical tag.Get all substations.Get a switch from its id or an alias.int
Get the switch count.Get all switches.Get all switches.Get a 3 windings transformer.int
Get the 3 windings transformer count.Get all 3 windings transformers.Get all 3 windings transformers.getTieLine
(String id) Get a tie line.int
Get the tie line count.Get all tie lines.Get all tie lines.Get a two windings transformer.int
Get the two windings transformer count.Get all two windings transformers.Get all two windings transformers.protected String
Return the network validation status.Get the variant manager of the network.Get voltage angle limit with idGet all voltageAngleLimits.Get all voltageAngleLimits.Get a substation voltage level.int
Get the voltage level count.Get all substation voltage levels.Get all substation voltage levels.Get an VSC converter station.int
Get VSC converter stations count.Get all VSC converter stations.Get all VSC converter stations.boolean
Return true if identifiable has aliases.boolean
Check that this object has some properties.boolean
hasProperty
(String key) Check that this object has property with specified name.boolean
isBoundaryElement
(Identifiable<?> identifiable) Check if an identifiable is a boundary element for the current network.boolean
Check if the current network can be detached from its parent network (withNetwork.detach()
).boolean
Get the fictitious statusGet a builder to create a new HVDC line.newLine()
Get a builder to create a new AC line.Get a builder to create a new substation.Get a builder to create a new AC tie line.Get a builder to create a new VoltageAngleLimit.Get a builder to create a new voltage level (without substation).void
reduceVariantArraySize
(int number) Called to reduce the variant array.void
removeAlias
(String alias) Remove an alias of the object.void
removeListener
(NetworkListener listener) Remove a listener from the network.boolean
removeProperty
(String key) Remove property with specified key.If network is valid, do nothing.
If network not valid, check if each network component is valid.runValidationChecks
(boolean throwsException) If network is valid, do nothing.
If network not valid andthrowsException
istrue
, check if each network component is valid.runValidationChecks
(boolean throwsException, Reporter reporter) If network is valid, do nothing.
If network not valid andthrowsException
istrue
, check if each network component is valid.setCaseDate
(ZonedDateTime caseDate) Set the date that the network represents.void
setFictitious
(boolean fictitious) Set the fictitious statussetForecastDistance
(int forecastDistance) setMinimumAcceptableValidationLevel
(ValidationLevel validationLevel) Update object name.setProperty
(String key, String value) Set property value associated to specified key.toString()
protected static void
transferExtensions
(Network from, Network to) Transfer the extensions of a network to another one.Methods inherited from class com.powsybl.commons.extensions.AbstractExtendable
addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, removeExtension
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.powsybl.commons.extensions.Extendable
addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, newExtension, removeExtension
Methods inherited from interface com.powsybl.iidm.network.Identifiable
addAlias, addAlias, addAlias, addAlias, getAliases, getAliasFromType, getAliasType, getId, getNameOrId, getOptionalName, getParentNetwork, getProperty, getProperty, getPropertyNames, hasAliases, hasProperty, hasProperty, isFictitious, removeAlias, removeProperty, setFictitious, setName, setProperty
-
Field Details
-
sourceFormat
-
id
-
name
-
fictitious
protected boolean fictitious -
properties
-
-
Method Details
-
getRootNetworkRef
Description copied from interface:NetworkExt
Return the reference to the root network which is also used within the network elements. This is used to easily update the root network of network elements when merging networks or detaching subnetworks. -
getSubnetworks
-
getSubnetwork
-
getNetwork
public com.powsybl.iidm.network.impl.NetworkImpl getNetwork()Description copied from interface:Identifiable
Get the network associated to the object.- Specified by:
getNetwork
in interfaceIdentifiable<Network>
-
getVariantManager
Description copied from interface:Network
Get the variant manager of the network. -
allowReporterContextMultiThreadAccess
public void allowReporterContextMultiThreadAccess(boolean allow) Description copied from interface:Network
Allows
ReporterContext
to be accessed simultaneously by different threads.When this option is activated, the reporter context can have a different content for each thread.
Note that to avoid memory leaks when in multi-thread configuration:
- each reporter pushed in the ReporterContext should be popped in a "finally" section:
network.getReporterContext().pushReporter(reporter); try { // code that can throw an exception } finally { network.getReporterContext().popReporter(); }
- the context should be set in mono-thread access when multi-threading policy is no more useful.
- Parameters:
allow
- allow multi-thread access to the ReporterContext
- each reporter pushed in the ReporterContext should be popped in a "finally" section:
-
getReporterContext
Description copied from interface:Network
Get theReporterContext
of the network. -
getCountries
Description copied from interface:Network
Get all countries. -
getCountryCount
public int getCountryCount()Description copied from interface:Network
Get the country count. -
newSubstation
Description copied from interface:Network
Get a builder to create a new substation.- Returns:
- a builder to create a new substation
-
getSubstations
Description copied from interface:Network
Get all substations. -
getSubstationStream
Description copied from interface:Network
Get all substations. -
getSubstationCount
public int getSubstationCount()Description copied from interface:Network
Get the substation count. -
getSubstations
public Iterable<Substation> getSubstations(Country country, String tsoId, String... geographicalTags) Description copied from interface:Network
Get substation located in a specific county, TSO and marked with a list of geographical tag.- Parameters:
country
- the country, ifnull
there is no filtering on countriestsoId
- the id of the TSO, ifnull
there is no filtering on TSOsgeographicalTags
- a list a geographical tags
-
getSubstations
public Iterable<Substation> getSubstations(String country, String tsoId, String... geographicalTags) Description copied from interface:Network
Get substation located in a specific county, TSO and marked with a list of geographical tag.- Parameters:
country
- the country name, if empty string, the filtering will be on substations without country, ifnull
there is no filtering on countriestsoId
- the id of the TSO, ifnull
there is no filtering on TSOsgeographicalTags
- a list a geographical tags
-
getSubstation
Description copied from interface:Network
Get a substation.- Parameters:
id
- the id or an alias of the substation
-
newVoltageLevel
Description copied from interface:Network
Get a builder to create a new voltage level (without substation). Note: if this method is not implemented, it will create an intermediary fictitiousSubstation
.- Returns:
- a builder to create a new voltage level
-
getVoltageLevels
Description copied from interface:Network
Get all substation voltage levels. -
getVoltageLevelStream
Description copied from interface:Network
Get all substation voltage levels. -
getVoltageLevelCount
public int getVoltageLevelCount()Description copied from interface:Network
Get the voltage level count. -
getVoltageLevel
Description copied from interface:Network
Get a substation voltage level.- Parameters:
id
- the id or an alias of the substation voltage level
-
newLine
Description copied from interface:Network
Get a builder to create a new AC line.- Returns:
- a builder to create a new line
-
getLines
Description copied from interface:Network
Get all AC lines. -
getBranch
Description copied from interface:Network
Get a branch- Parameters:
branchId
- the id of the branch
-
getBranches
Description copied from interface:Network
Get all branches -
getBranchStream
Description copied from interface:Network
Get all branches -
getBranchCount
public int getBranchCount()Description copied from interface:Network
Get the branch count. -
getLineStream
Description copied from interface:Network
Get all AC lines. -
getLineCount
public int getLineCount()Description copied from interface:Network
Get the AC line count. -
getLine
Description copied from interface:Network
Get a AC line.- Parameters:
id
- the id or an alias of the AC line
-
newVoltageAngleLimit
Description copied from interface:Network
Get a builder to create a new VoltageAngleLimit. -
getVoltageAngleLimits
Description copied from interface:Network
Get all voltageAngleLimits. -
getVoltageAngleLimitsStream
Description copied from interface:Network
Get all voltageAngleLimits. -
getVoltageAngleLimit
Description copied from interface:Network
Get voltage angle limit with id -
newTieLine
Description copied from interface:Network
Get a builder to create a new AC tie line.- Returns:
- a builder to create a new AC tie line
-
getTieLines
Description copied from interface:Network
Get all tie lines. -
getTieLineStream
Description copied from interface:Network
Get all tie lines. -
getTieLineCount
public int getTieLineCount()Description copied from interface:Network
Get the tie line count. -
getTieLine
Description copied from interface:Network
Get a tie line.- Parameters:
id
- the id or an alias of the AC line
-
getTwoWindingsTransformers
Description copied from interface:Network
Get all two windings transformers. -
getTwoWindingsTransformerStream
Description copied from interface:Network
Get all two windings transformers. -
getTwoWindingsTransformerCount
public int getTwoWindingsTransformerCount()Description copied from interface:Network
Get the two windings transformer count. -
getTwoWindingsTransformer
Description copied from interface:Network
Get a two windings transformer.- Parameters:
id
- the id or an alias of the two windings transformer
-
getThreeWindingsTransformers
Description copied from interface:Network
Get all 3 windings transformers. -
getThreeWindingsTransformerStream
Description copied from interface:Network
Get all 3 windings transformers. -
getThreeWindingsTransformerCount
public int getThreeWindingsTransformerCount()Description copied from interface:Network
Get the 3 windings transformer count. -
getThreeWindingsTransformer
Description copied from interface:Network
Get a 3 windings transformer.- Parameters:
id
- the id or an alias of the 3 windings transformer
-
getGenerators
Description copied from interface:Network
Get all generators. -
getGeneratorStream
Description copied from interface:Network
Get all generators. -
getGeneratorCount
public int getGeneratorCount()Description copied from interface:Network
Get the generator count. -
getGenerator
Description copied from interface:Network
Get a generator.- Parameters:
id
- the id or an alias of the generator
-
getBatteries
Description copied from interface:Network
Get all batteries. -
getBatteryStream
Description copied from interface:Network
Get all batteries. -
getBatteryCount
public int getBatteryCount()Description copied from interface:Network
Get the battery count. -
getBattery
Description copied from interface:Network
Get a battery.- Parameters:
id
- the id or an alias of the battery
-
getLoads
Description copied from interface:Network
Get all loads. -
getLoadStream
Description copied from interface:Network
Get all loads. -
getLoadCount
public int getLoadCount()Description copied from interface:Network
Get the load count. -
getLoad
Description copied from interface:Network
Get a load.- Parameters:
id
- the id or an alias of the load
-
getShuntCompensators
Description copied from interface:Network
Get all compensator shunts. -
getShuntCompensatorStream
Description copied from interface:Network
Get all compensator shunts. -
getShuntCompensatorCount
public int getShuntCompensatorCount()Description copied from interface:Network
Get the shunt count. -
getShuntCompensator
Description copied from interface:Network
Get a compensator shunt.- Parameters:
id
- the id or an alias of the compensator shunt
-
getDanglingLines
Description copied from interface:Network
Get all dangling lines corresponding to given filter. -
getDanglingLineStream
Description copied from interface:Network
Get the dangling lines corresponding to given filter. -
getDanglingLines
Description copied from interface:Network
Get all dangling lines. -
getDanglingLineStream
Description copied from interface:Network
Get all the dangling lines. -
getDanglingLineCount
public int getDanglingLineCount()Description copied from interface:Network
Get the dangling line count. -
getDanglingLine
Description copied from interface:Network
Get a dangling line.- Parameters:
id
- the id or an alias of the dangling line
-
getStaticVarCompensators
Description copied from interface:Network
Get all static var compensators. -
getStaticVarCompensatorStream
Description copied from interface:Network
Get all static var compensators. -
getStaticVarCompensatorCount
public int getStaticVarCompensatorCount()Description copied from interface:Network
Get the static var compensator count. -
getStaticVarCompensator
Description copied from interface:Network
Get a static var compensator.- Parameters:
id
- the id or an alias of the static var compensator
-
getSwitch
Description copied from interface:Network
Get a switch from its id or an alias.- Parameters:
id
- id or an alias of the switch- Returns:
- the switch
-
getSwitches
Description copied from interface:Network
Get all switches.- Returns:
- all switches
-
getSwitchStream
Description copied from interface:Network
Get all switches.- Returns:
- all switches
-
getSwitchCount
public int getSwitchCount()Description copied from interface:Network
Get the switch count.- Returns:
- the switch count
-
getBusbarSection
Description copied from interface:Network
Get a busbar section from its id or an alias.- Parameters:
id
- the id or an alias of the busbar section- Returns:
- the busbar section
-
getBusbarSections
Description copied from interface:Network
Get all busbar sections.- Returns:
- all busbar sections
-
getBusbarSectionStream
Description copied from interface:Network
Get all busbar sections.- Returns:
- all busbar sections
-
getBusbarSectionCount
public int getBusbarSectionCount()Description copied from interface:Network
Get the busbar section count.- Returns:
- the busbar section count.
-
getHvdcConverterStations
Description copied from interface:Network
Get all HVDC converter stations.- Returns:
- all HVDC converter stations
-
getHvdcConverterStationStream
Description copied from interface:Network
Get all HVDC converter stations.- Returns:
- all HVDC converter stations
-
getHvdcConverterStationCount
public int getHvdcConverterStationCount()Description copied from interface:Network
Get HVDC converter stations count.- Returns:
- HVDC converter station count
-
getHvdcConverterStation
Description copied from interface:Network
Get an HVDC converter station.- Parameters:
id
- the id or an alias of the HVDC converter station- Returns:
- the HVDC converter station or null if not found
-
getLccConverterStations
Description copied from interface:Network
Get all LCC converter stations.- Returns:
- all LCC converter stations
-
getLccConverterStationStream
Description copied from interface:Network
Get all LCC converter stations.- Returns:
- all LCC converter stations
-
getLccConverterStationCount
public int getLccConverterStationCount()Description copied from interface:Network
Get LCC converter stations count.- Returns:
- LCC converter station count
-
getLccConverterStation
Description copied from interface:Network
Get an LCC converter station.- Parameters:
id
- the id or an alias of the LCC converter station- Returns:
- the LCC converter station or null if not found
-
getVscConverterStations
Description copied from interface:Network
Get all VSC converter stations.- Returns:
- all VSC converter stations
-
getVscConverterStationStream
Description copied from interface:Network
Get all VSC converter stations.- Returns:
- all VSC converter stations
-
getVscConverterStationCount
public int getVscConverterStationCount()Description copied from interface:Network
Get VSC converter stations count.- Returns:
- VSC converter station count
-
getVscConverterStation
Description copied from interface:Network
Get an VSC converter station.- Parameters:
id
- the id or an alias of the VSC converter station- Returns:
- the VSC converter station or null if not found
-
getHvdcLines
Description copied from interface:Network
Get all HVDC lines.- Returns:
- all HVDC lines
-
getHvdcLineStream
Description copied from interface:Network
Get all HVDC lines.- Returns:
- all HVDC lines
-
getHvdcLineCount
public int getHvdcLineCount()Description copied from interface:Network
Get HVDC lines count.- Returns:
- HVDC lines count
-
getHvdcLine
Description copied from interface:Network
Get an HVDC line.- Parameters:
id
- the id or an alias of the HVDC line- Returns:
- the HVDC line or null if not found
-
getHvdcLine
Description copied from interface:Network
Get an HVDC line from a converter station- Parameters:
converterStation
- a HVDC converter station- Returns:
- the HVDC line or null if not found
-
newHvdcLine
Description copied from interface:Network
Get a builder to create a new HVDC line.- Returns:
- a builder to create a new HVDC line
-
getIdentifiable
Description copied from interface:Network
Get an equipment by its ID or alias- Parameters:
id
- the id or an alias of the equipment
-
getIdentifiables
Description copied from interface:Network
Get all identifiables of the network.- Returns:
- all identifiables of the network
-
getConnectables
Description copied from interface:Network
Get all connectables of the network for a given type- Parameters:
clazz
- connectable type class- Returns:
- all the connectables of the given type
-
getConnectableStream
Description copied from interface:Network
Get a stream of all connectables of the network for a given type- Parameters:
clazz
- connectable type class- Returns:
- a stream of all the connectables of the given type
-
getConnectableCount
Description copied from interface:Network
Count the connectables of the network for a given type- Parameters:
clazz
- connectable type class- Returns:
- the count of all the connectables of the given type
-
getConnectables
Description copied from interface:Network
Get all connectables of the network- Returns:
- all the connectables
-
getConnectableStream
Description copied from interface:Network
Get a stream of all connectables of the network- Returns:
- a stream of all the connectables
-
getConnectable
Description copied from interface:Network
Get a connectable by its ID or alias- Parameters:
id
- the id or an alias of the equipment
-
getConnectableCount
public int getConnectableCount()Description copied from interface:Network
Count the connectables of the network- Returns:
- the count of all the connectables
-
getBusBreakerView
Description copied from interface:Network
Get a bus/breaker view of the network. -
getBusView
Description copied from interface:Network
Get a bus view of the network. -
createSubnetwork
Create an empty subnetwork in the current network.This operation is not allowed on a subnetwork.
This method throws an
UnsupportedOperationException
- Parameters:
subnetworkId
- id of the subnetworkname
- subnetwork's namesourceFormat
- source format- Returns:
- the created subnetwork
-
detach
Description copied from interface:Network
Detach the current network (including its subnetworks) from its parent network.
Note that this operation is destructive: after it the current network's content couldn't be accessed from the parent network anymore.
The boundary elements, i.e. linking this network to an external voltage level are split if possible. A
PowsyblException
is thrown if some un-splittable boundary elements are detected. This detection is processed before any network modification. So if an un-splittable boundary element is detected, no destructive operation will be done.- Returns:
- a fully-independent network corresponding to the current network and its subnetworks.
-
isDetachable
public boolean isDetachable()Check if the current network can be detached from its parent network (with
Network.detach()
).For now, only tie-lines can be split (HVDC lines may be supported later).
- Returns:
- True if the network can be detached from its parent network.
-
getBoundaryElements
Description copied from interface:Network
Return all the boundary elements of the current network, i.e. the elements which link or might link this network to an external voltage level.- Returns:
- a set containing the boundary elements of the network.
-
isBoundaryElement
Description copied from interface:Network
Check if an identifiable is a boundary element for the current network.- Parameters:
identifiable
- the identifiable to check- Returns:
- True if the identifiable is a boundary element for the current network
-
addListener
Add a listener on the network.
This method throws an
PowsyblException
.Motivation: The listeners apply to the whole network (root + subnetworks). Thus, in a network with several subnetworks, if calling
addListener
on a subnetwork registers the given listener on the root network, changes on another subnetwork will also be reported to the listener. This is counterintuitive and could lead to confusion. To avoid that, we don't allow to add or remove listeners from a subnetwork.- Parameters:
listener
- the listener to add
-
removeListener
Remove a listener from the network.
This method throws an
PowsyblException
.Motivation: The listeners apply to the whole network (root + subnetworks). Thus, in a network with several subnetworks, if calling
addListener
on a subnetwork registers the given listener on the root network, changes on another subnetwork will also be reported to the listener. This is counterintuitive and could lead to confusion. To avoid that, we don't allow to add or remove listeners from a subnetwork.- Parameters:
listener
- the listener to remove
-
runValidationChecks
Description copied from interface:Network
If network is valid, do nothing.
If network not valid, check if each network component is valid. AValidationException
is thrown with an explicit message if one network component is not valid.
If all network components are valid, network validation status is updated to true. Return the network validation status. -
runValidationChecks
Description copied from interface:Network
If network is valid, do nothing.
If network not valid andthrowsException
istrue
, check if each network component is valid. AValidationException
is thrown with an explicit message if one network component is not valid.
If all network components are valid, network validation status is updated to true. Return the network validation status. -
runValidationChecks
Description copied from interface:Network
If network is valid, do nothing.
If network not valid andthrowsException
istrue
, check if each network component is valid. AValidationException
is thrown with an explicit message if one network component is not valid.
If all network components are valid, network validation status is updated to true. Return the network validation status. -
getValidationLevel
Description copied from interface:Network
Return the network validation status. Do not run any validation check. -
setMinimumAcceptableValidationLevel
-
getIdentifiableStream
-
getContainerType
- Specified by:
getContainerType
in interfaceContainer<Network>
-
getCaseDate
Description copied from interface:Network
Get the date that the network represents.- Specified by:
getCaseDate
in interfaceNetwork
-
setCaseDate
Description copied from interface:Network
Set the date that the network represents.- Specified by:
setCaseDate
in interfaceNetwork
-
getForecastDistance
public int getForecastDistance()Description copied from interface:Network
Get the forecast distance in minutes.Example: 0 for a snapshot, 6*60 to 30*60 for a DACF.
- Specified by:
getForecastDistance
in interfaceNetwork
-
setForecastDistance
- Specified by:
setForecastDistance
in interfaceNetwork
-
getSourceFormat
Description copied from interface:Network
Get the source format.- Specified by:
getSourceFormat
in interfaceNetwork
- Returns:
- the source format
-
getTypeDescription
-
transferExtensions
Transfer the extensions of a network to another one.- Parameters:
from
- the network whose extensions must be transferredto
- the destination network
-
getId
Description copied from interface:Identifiable
Get the unique identifier of the object.- Specified by:
getId
in interfaceIdentifiable<I extends Identifiable<I>>
-
getOptionalName
Description copied from interface:Identifiable
Return an optional containing the name of the object if it exists. If not, return an empty optional.- Specified by:
getOptionalName
in interfaceIdentifiable<I extends Identifiable<I>>
-
getNameOrId
Description copied from interface:Identifiable
Get the name of the object if it exists. If not, get the unique identifier of the object.- Specified by:
getNameOrId
in interfaceIdentifiable<I extends Identifiable<I>>
-
setName
Description copied from interface:Identifiable
Update object name.- Specified by:
setName
in interfaceIdentifiable<I extends Identifiable<I>>
- Parameters:
name
- new name of the object (could be null to erase the name)- Returns:
- the object itself
-
getAliases
Description copied from interface:Identifiable
Get the aliases of the object.- Specified by:
getAliases
in interfaceIdentifiable<I extends Identifiable<I>>
-
getAliasType
Description copied from interface:Identifiable
Get the alias type of an alias if it exists, an empty optional otherwise. If the alias does not exist, return an empty optional.- Specified by:
getAliasType
in interfaceIdentifiable<I extends Identifiable<I>>
-
getAliasFromType
Description copied from interface:Identifiable
Get the alias of the object with a given alias type if it exists. Else return an empty optional.- Specified by:
getAliasFromType
in interfaceIdentifiable<I extends Identifiable<I>>
-
addAlias
Description copied from interface:Identifiable
Add an alias to the object. Aliases must be unique in associated Network, and different from any identifiable ID. No alias type is associated to this alias. If the alias already exists (i.e. is not unique) or equals an identifiable ID, throw aPowsyblException
- Specified by:
addAlias
in interfaceIdentifiable<I extends Identifiable<I>>
-
addAlias
- Specified by:
addAlias
in interfaceIdentifiable<I extends Identifiable<I>>
-
addAlias
Description copied from interface:Identifiable
Add an alias to the object. Aliases must be unique in associated Network, and different from any identifiable ID. This alias is associated to a given alias type. If the given alias type is null or empty, no alias type is considered associated to the alias. Only one alias can be associated to a non null given alias type for one object. If the alias already exists (i.e. is not unique) or equals an identifiable ID, throw aPowsyblException
If a given non null type already has an associated alias for this object, throw aPowsyblException
- Specified by:
addAlias
in interfaceIdentifiable<I extends Identifiable<I>>
-
addAlias
- Specified by:
addAlias
in interfaceIdentifiable<I extends Identifiable<I>>
-
removeAlias
Description copied from interface:Identifiable
Remove an alias of the object. If the alias does not exist for this object, throw aPowsyblException
- Specified by:
removeAlias
in interfaceIdentifiable<I extends Identifiable<I>>
-
hasAliases
public boolean hasAliases()Description copied from interface:Identifiable
Return true if identifiable has aliases.- Specified by:
hasAliases
in interfaceIdentifiable<I extends Identifiable<I>>
-
isFictitious
public boolean isFictitious()Description copied from interface:Identifiable
Get the fictitious status- Specified by:
isFictitious
in interfaceIdentifiable<I extends Identifiable<I>>
-
setFictitious
public void setFictitious(boolean fictitious) Description copied from interface:Identifiable
Set the fictitious status- Specified by:
setFictitious
in interfaceIdentifiable<I extends Identifiable<I>>
-
getMessageHeader
- Specified by:
getMessageHeader
in interfaceValidable
-
getProperties
-
hasProperty
public boolean hasProperty()Description copied from interface:Identifiable
Check that this object has some properties.- Specified by:
hasProperty
in interfaceIdentifiable<I extends Identifiable<I>>
-
hasProperty
Description copied from interface:Identifiable
Check that this object has property with specified name.- Specified by:
hasProperty
in interfaceIdentifiable<I extends Identifiable<I>>
-
getProperty
Description copied from interface:Identifiable
Get property associated to specified key.- Specified by:
getProperty
in interfaceIdentifiable<I extends Identifiable<I>>
-
getProperty
Description copied from interface:Identifiable
Get property associated to specified key, with default value.- Specified by:
getProperty
in interfaceIdentifiable<I extends Identifiable<I>>
-
setProperty
Description copied from interface:Identifiable
Set property value associated to specified key.- Specified by:
setProperty
in interfaceIdentifiable<I extends Identifiable<I>>
-
removeProperty
Description copied from interface:Identifiable
Remove property with specified key.- Specified by:
removeProperty
in interfaceIdentifiable<I extends Identifiable<I>>
- Parameters:
key
- the property key- Returns:
true
if property exists and has been removed,false
otherwise
-
getPropertyNames
Description copied from interface:Identifiable
Get properties key values.- Specified by:
getPropertyNames
in interfaceIdentifiable<I extends Identifiable<I>>
-
toString
-
extendVariantArraySize
public void extendVariantArraySize(int initVariantArraySize, int number, int sourceIndex) Description copied from interface:MultiVariantObject
Called to extend the variant array.- Specified by:
extendVariantArraySize
in interfaceMultiVariantObject
- Parameters:
initVariantArraySize
- initial variant array sizenumber
- number of element to addsourceIndex
- the variant index to use to initialize new variants
-
reduceVariantArraySize
public void reduceVariantArraySize(int number) Description copied from interface:MultiVariantObject
Called to reduce the variant array.- Specified by:
reduceVariantArraySize
in interfaceMultiVariantObject
- Parameters:
number
- number of element to remove
-
deleteVariantArrayElement
public void deleteVariantArrayElement(int index) Description copied from interface:MultiVariantObject
Called to delete a variant array element.- Specified by:
deleteVariantArrayElement
in interfaceMultiVariantObject
- Parameters:
index
- the index of the variant array to delete
-
allocateVariantArrayElement
public void allocateVariantArrayElement(int[] indexes, int sourceIndex) Description copied from interface:MultiVariantObject
Called to allocate a variant array element. All new variants will be initialize using values of the variant sourceIndex.- Specified by:
allocateVariantArrayElement
in interfaceMultiVariantObject
- Parameters:
indexes
- the indexes of the variant array to allocatesourceIndex
- the variant index to use to initialize new variants
-