com.powsybl.iidm.network

Interface StateManager

All Known Subinterfaces:

VariantManager

Deprecated.

use VariantManager instead.

@Deprecated
public interface StateManager

This class provides methods to manage variants of the network (create and remove a variant, set the working variant, etc).

WARNING: Variant management is not thread safe and should never be done will an other thread read from or write to an already existing variant. The classical pattern for multi-variant processing is to pre-allocate variants and call allowVariantMultiThreadAccess(boolean) to allow multi-thread access on main thread, work on variants from other threads (be carefull to only write concurrently attributes flagged as dependent to variant in the Javadoc) and then remove variants from main thread once work is over.

Method Summary

Modifier and Type	Method and Description
default void	allowStateMultiThreadAccess(boolean allow) Deprecated. use allowVariantMultiThreadAccess(boolean) instead.
default void	allowVariantMultiThreadAccess(boolean allow) Deprecated. Allows variants to be accessed simulaneously by different threads.
default void	cloneState(java.lang.String sourceStateId, java.util.List<java.lang.String> targetStateIds) Deprecated. use cloneVariant(String, List) instead.
default void	cloneState(java.lang.String sourceStateId, java.lang.String targetStateId) Deprecated. use cloneVariant(String, String) instead.
default void	cloneVariant(java.lang.String sourceVariantId, java.util.List<java.lang.String> targetVariantIds) Deprecated. Create a new variant by cloning an existing one.
default void	cloneVariant(java.lang.String sourceVariantId, java.lang.String targetVariantId) Deprecated. Create a new variant by cloning an existing one.
default java.util.Collection<java.lang.String>	getStateIds() Deprecated. use getVariantIds() instead.
default java.util.Collection<java.lang.String>	getVariantIds() Deprecated. Get the variant id list.
default java.lang.String	getWorkingStateId() Deprecated. use getWorkingVariantId() instead.
default java.lang.String	getWorkingVariantId() Deprecated. Get the working variant.
default boolean	isStateMultiThreadAccessAllowed() Deprecated. use isVariantMultiThreadAccessAllowed() instead.
default boolean	isVariantMultiThreadAccessAllowed() Deprecated.
default void	removeState(java.lang.String stateId) Deprecated. use removeVariant(String) instead.
default void	removeVariant(java.lang.String variantId) Deprecated. Remove a variant.
default void	setWorkingState(java.lang.String variantId) Deprecated. use setWorkingVariant(String) instead.
default void	setWorkingVariant(java.lang.String variantId) Deprecated. Set the working variant.

Method Detail

getVariantIds

default java.util.Collection<java.lang.String> getVariantIds()

Deprecated.

Get the variant id list.

Returns:

the variant id list

getStateIds

@Deprecated
default java.util.Collection<java.lang.String> getStateIds()

Deprecated. use getVariantIds() instead.

getWorkingVariantId

default java.lang.String getWorkingVariantId()

Deprecated.

Get the working variant.

Returns:

the id of the working variant

getWorkingStateId

@Deprecated
default java.lang.String getWorkingStateId()

Deprecated. use getWorkingVariantId() instead.

setWorkingVariant

default void setWorkingVariant(java.lang.String variantId)

Deprecated.

Set the working variant.

Parameters:

variantId - the id of the working variant

Throws:

PowsyblException - if the variant is not found

setWorkingState

@Deprecated
default void setWorkingState(java.lang.String variantId)

Deprecated. use setWorkingVariant(String) instead.

cloneVariant

default void cloneVariant(java.lang.String sourceVariantId,
                          java.util.List<java.lang.String> targetVariantIds)

Deprecated.

Create a new variant by cloning an existing one.

Parameters:

sourceVariantId - the source variant id

targetVariantIds - the target variant id list (the ones that will be created)

Throws:

PowsyblException - if the source variant is not found or if a variant with an id of targetStateIds already exists

cloneState

@Deprecated
default void cloneState(java.lang.String sourceStateId,
                                    java.util.List<java.lang.String> targetStateIds)

Deprecated. use cloneVariant(String, List) instead.

cloneVariant

default void cloneVariant(java.lang.String sourceVariantId,
                          java.lang.String targetVariantId)

Deprecated.

Create a new variant by cloning an existing one.

Parameters:

sourceVariantId - the source variant id

targetVariantId - the target variant id (the one that will be created)

Throws:

PowsyblException - if the source variant is not found or if a variant with the id targetVariantId already exists

cloneState

@Deprecated
default void cloneState(java.lang.String sourceStateId,
                                    java.lang.String targetStateId)

Deprecated. use cloneVariant(String, String) instead.

removeVariant

default void removeVariant(java.lang.String variantId)

Deprecated.

Remove a variant.

Parameters:

variantId - the id of the variant to remove

removeState

@Deprecated
default void removeState(java.lang.String stateId)

Deprecated. use removeVariant(String) instead.

allowVariantMultiThreadAccess

default void allowVariantMultiThreadAccess(boolean allow)

Deprecated.

Allows variants to be accessed simulaneously by different threads. When this options is activated, the working variant can have a different value for each thread.

Parameters:

allow -

allowStateMultiThreadAccess

@Deprecated
default void allowStateMultiThreadAccess(boolean allow)

Deprecated. use allowVariantMultiThreadAccess(boolean) instead.

isVariantMultiThreadAccessAllowed

default boolean isVariantMultiThreadAccessAllowed()

Deprecated.

isStateMultiThreadAccessAllowed

@Deprecated
default boolean isStateMultiThreadAccessAllowed()

Deprecated. use isVariantMultiThreadAccessAllowed() instead.