Package com.powsybl.simulation.securityindexes

Class OverloadSecurityIndex

java.lang.Object

com.powsybl.simulation.securityindexes.OverloadSecurityIndex

All Implemented Interfaces:

SecurityIndex

public class OverloadSecurityIndex
extends Object

Author:

Quinary

Field Summary

Fields

Modifier and Type	Field	Description
protected SecurityIndexId	id
protected static com.google.common.base.Supplier<XMLOutputFactory>	XML_OUTPUT_FACTORY_SUPPLIER

Constructor Summary

Constructors

Constructor	Description
OverloadSecurityIndex(String contingencyId, double indexValue)

Method Summary

Modifier and Type	Method	Description
static OverloadSecurityIndex	fromXml(String contingencyId, XMLStreamReader xmlsr)
SecurityIndexId	getId()	Get security index id.
double	getIndexValue()
boolean	isOk()	Get the security index synthetic value.
Map<String,String>	toMap()
String	toString()
String	toXml()
void	toXml(XMLStreamWriter xmlWriter)

Methods inherited from class java.lang.Object

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

Field Detail

XML_OUTPUT_FACTORY_SUPPLIER

protected static final com.google.common.base.Supplier<XMLOutputFactory> XML_OUTPUT_FACTORY_SUPPLIER

id

protected final SecurityIndexId id

Constructor Detail

OverloadSecurityIndex

public OverloadSecurityIndex(String contingencyId,
                             double indexValue)

Method Detail

fromXml

public static OverloadSecurityIndex fromXml(String contingencyId,
                                            XMLStreamReader xmlsr)
                                     throws XMLStreamException

Throws:

XMLStreamException

getIndexValue

public double getIndexValue()

isOk

public boolean isOk()

Description copied from interface: SecurityIndex

Get the security index synthetic value.

Returns:

the security index synthetic value

toXml

public void toXml(XMLStreamWriter xmlWriter)
           throws XMLStreamException

Throws:

XMLStreamException

toMap

public Map<String,String> toMap()

getId

public SecurityIndexId getId()

Description copied from interface: SecurityIndex

Get security index id.

Specified by:

getId in interface SecurityIndex

Returns:

security index type

toString

public String toString()

Overrides:

toString in class Object

toXml

public String toXml()

Specified by:

toXml in interface SecurityIndex