Package com.powsybl.simulation.securityindexes

Class SmallSignalSecurityIndex

java.lang.Object

com.powsybl.simulation.securityindexes.SmallSignalSecurityIndex

All Implemented Interfaces:

SecurityIndex

public class SmallSignalSecurityIndex
extends Object

Author:

Quinary

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SmallSignalSecurityIndex.Index
static class	SmallSignalSecurityIndex.Matrix
static class	SmallSignalSecurityIndex.MatrixAdapter

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
SmallSignalSecurityIndex(String contingencyId, double gmi)
SmallSignalSecurityIndex(String contingencyId, double gmi, double[] ami, double[][] smi)

Method Summary

Modifier and Type	Method	Description
static SmallSignalSecurityIndex	fromXml(String contingencyId, XMLStreamReader xmlsr)
double[]	getAmi()
double	getGmi()
SecurityIndexId	getId()	Get security index id.
double[][]	getSmi()
boolean	isOk()	Get the security index synthetic value.
Map<String,String>	toMap()
String	toString()
String	toXml()
static void	toXml(SmallSignalSecurityIndex index, XMLStreamWriter writer)
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

SmallSignalSecurityIndex

public SmallSignalSecurityIndex(String contingencyId,
                                double gmi,
                                double[] ami,
                                double[][] smi)

SmallSignalSecurityIndex

public SmallSignalSecurityIndex(String contingencyId,
                                double gmi)

Method Detail

fromXml

public static SmallSignalSecurityIndex fromXml(String contingencyId,
                                               XMLStreamReader xmlsr)

getGmi

public double getGmi()

getAmi

public double[] getAmi()

getSmi

public double[][] getSmi()

isOk

public boolean isOk()

Description copied from interface: SecurityIndex

Get the security index synthetic value.

Returns:

the security index synthetic value

toMap

public Map<String,String> toMap()

toXml

public static void toXml(SmallSignalSecurityIndex index,
                         XMLStreamWriter writer)
                  throws javax.xml.bind.JAXBException

Throws:

javax.xml.bind.JAXBException

toXml

public void toXml(XMLStreamWriter xmlWriter)
           throws XMLStreamException

Throws:

XMLStreamException

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