All Classes

Class	Description
AssetInput	Describes a grid asset under the assumption that every asset could be operable
AssetInput.AssetInputCopyBuilder<T extends AssetInput.AssetInputCopyBuilder<T>>	Abstract class for all builder that build child entities of abstract class AssetInput
AssetInputEntityData	Data used for the construction of AssetInput entities.
AssetInputEntityFactory<T extends AssetInput,D extends AssetInputEntityData>	Abstract factory class that can be extended in order for creating AssetInput entities with AssetInputEntityData data objects.
AssetTypeInput	Describes the type of an AssetInput
BdewLoadProfile	German standard electricity load profiles, defined by the bdew (Bundesverband der Energie- und Wasserwirtschaft; engl.Federal Association of the Energy and Water Industry).
BmInput	Describes a biomass plant
BmInput.BmInputCopyBuilder	A builder pattern based approach to create copies of BmInput entities with altered field values.
BmInputFactory
BmResult	Represents calculation results of a BmInput
BmTypeInput	Describes the type of a BmInput
BufferedCsvWriter	This class extends the BufferedWriter and adds information about the file shape of the csv file
CharacteristicInput<A extends javax.measure.Quantity<A>,O extends javax.measure.Quantity<O>>	Describes characteristics of assets
CharacteristicPoint<A extends javax.measure.Quantity<A>,O extends javax.measure.Quantity<O>>	Class to describe one point of a given CharacteristicInput
ChargingPointType	The actual implementation EvcsInput types.
ChargingPointTypeException	Is thrown in case, there is some problem when building VoltageLevelInformation
ChargingPointTypeUtils	Utility class to create either custom instances of ChargingPointTypes or to retrieve common standard ChargingPointTypes based on their id
ChpInput	Describes a combined heat and power plant
ChpInput.ChpInputCopyBuilder	A builder pattern based approach to create copies of ChpInput entities with altered field values.
ChpInputEntityData
ChpInputFactory
ChpResult	Represents calculation results of a ChpInput
ChpTypeInput	Describes the type of a ChpInput
ColumnScheme	Yet supported column schemes in individual time series
CommonVoltageLevel	Class with extended information to describe common voltage levels in energy systems.
ConnectorException	Exception that should be used whenever something invalid happens in a implementation of a DataConnector
ConnectorInput	Describes an asset that connects two NodeInputs
ConnectorInputEntityData	Data used by ConnectorInputEntityFactory to create an instance of ConnectorInput, thus needing additional information about the NodeInput, which cannot be provided through the attribute map.
ConnectorPort	Denotes possible external ports of a connector.
ConnectorResult	Abstract class to hold most 'ElectricCurrent and Angle'-mappings common to all connectors
ConnectorResultFactory
ConnectorValidationUtils
ContainerNodeUpdateUtil
ContainerUtils	Offers functionality useful for grouping different models together
CosmoIdCoordinateFactory	Factory, that is able to build coordinate id to coordinate mapping from German Federal Weather Service's COSMO model
CosPhiFixed	Characteristic denoting a power factor, that is dependent on the current power consumption or infeed
CosPhiP	Characteristic denoting a power factor, that is dependent on the current power consumption or infeed
CouchbaseConnector	Implements a DataConnector for Couchbase.
CouchbaseWeatherSource	Couchbase Source for weather data
CsvDataSource	Parent class of all .csv file related sources containing methods and fields consumed by allmost all implementations of .csv file related sources.
CsvFileConnector	Provides the connector (here: buffered writer) for specific files to be used by a CsvFileSink
CsvFileConnector.CsvIndividualTimeSeriesMetaInformation	Enhancing the IndividualTimeSeriesMetaInformation with the full path to csv file
CsvFileDefinition
CsvFileSink	Sink that provides all capabilities to write UniqueEntitys to .csv-files.
CsvGraphicSource	Implementation of the GraphicSource interface to read NodeGraphicInput and LineGraphicInput entities from .csv files
CsvIdCoordinateSource	Implementation of IdCoordinateSource to read the mapping between coordinate id and actual coordinate from csv file and build a mapping from it.
CsvRawGridSource	Source that provides the capability to build entities that are hold by a RawGridElements as well as the RawGridElements container from .csv files.
CsvResultEntitySource	Source that provides the capability to build entities of type ResultEntity container from .csv files.
CsvSystemParticipantSource	Source that provides the capability to build entities of type SystemParticipantInput as well as SystemParticipants container from .csv files.
CsvThermalSource	Source that provides the capability to build thermal AssetInput entities from .csv files
CsvTimeSeriesMappingSource
CsvTimeSeriesSource<V extends Value>	Source that is capable of providing information around time series from csv files.
CsvTypeSource	Source that provides the capability to build entities of type SystemParticipantTypeInput and OperatorInput from .csv files
CsvWeatherSource	Implements a WeatherSource for CSV files by using the CsvTimeSeriesSource as a base
CylindricalStorageInput	Thermal storage with cylindrical shape
CylindricalStorageInput.CylindricalStorageInputCopyBuilder	A builder pattern based approach to create copies of CylindricalStorageInput entities with altered field values.
CylindricalStorageInputFactory
CylindricalStorageResult	Respresents the results of CylindricalStorageInput
DataConnector	Describes a class that is used to establish a connection to a data location.
DataSink	Describes a class that manages data persistence.
DataSource	General interface that is implemented by all specific data sources for different types of data structures that are persisted in different locations.
DefaultDirectoryHierarchy	Default directory hierarchy for input models
DistanceWeightedEdge	A default implementation for edges in a DistanceWeightedGraph.
DistanceWeightedGraph	A distance weighted graph that uses DistanceWeightedEdges as edge type.
ElectricalEnergyStorageResult	Represents everything, that is capable of storing electric energy
ElectricCurrentType	Generic electric current type implementation.
EnergyPriceValue	Describes a price for energy
EntityData	Internal API Contains data that is needed by an EntityFactory to generate an entity
EntityFactory<T extends UniqueEntity,D extends EntityData>	Universal factory class for creating entities with EntityData data objects.
EntityPersistenceNamingStrategy	Provides an easy to use standard way to name files, tables or any other persistent representation of models.
EntityProcessor<T extends UniqueEntity>	Internal API Interface for EntityProcessors.
EntityProcessorException	Is thrown, when an something went wrong during entity field mapping creation in a EntityProcessor
EvcsInput
EvcsInput.EvcsInputCopyBuilder	A builder pattern based approach to create copies of EvcsInput entities with altered field values.
EvcsInputFactory	Factory to create instances of EvcsInputs based on NodeAssetInputEntityData and additional fields.
EvcsLocationType	Describes type of location of an EvcsInput.
EvcsLocationTypeUtils	Utility class providing tools to retrieve EvcsLocationTypes from string representation
EvcsResult	Represents calculation results of a EvcsInput
EvInput	Describes an electric vehicle
EvInput.EvInputCopyBuilder	A builder pattern based approach to create copies of EvInput entities with altered field values.
EvInputFactory
EvResult	Represents calculation results of a EvInput
EvTypeInput	Describes the type of a EvInput
Extractor	A simple utility class that can be used by sinks to extract nested elements (e.g.
ExtractorException	Exception that should be used whenever something invalid happens in a implementation of a DataConnector
Factory<C,D extends FactoryData,R>	Abstract factory class, that is able to transfer specific "flat" information in to actual model class instances.
FactoryData
FactoryException	Is thrown, when an something went wrong during entity creation process in a EntityFactory
FieldSourceToMethod	Represent a tuple of FieldSourceToMethod.FieldSource to Method to highlight, where information of a time series can be obtained from
FieldSourceToMethod.FieldSource	Enum to denote, where information can be received from
FileException
FileHierarchy	Abstract definition of a file hierarchy (a piece of software, that knows where to find / place a file reflecting a certain class) inside of a nested sub directory structure
FileNameMetaInformation	Meta information, that can be derived from a certain file name
FileNamingStrategy	A naming strategy, that combines an EntityPersistenceNamingStrategy for naming entities and a FileHierarchy for a folder structure.
FixedFeedInInput	Dummy class to represent a constant feed in regardless of its type
FixedFeedInInput.FixedFeedInInputCopyBuilder	A builder pattern based approach to create copies of FixedFeedInInput entities with altered field values.
FixedFeedInInputFactory
FixedFeedInResult	Represents calculation results of a FixedFeedInInput
FlatDirectoryHierarchy	Default directory hierarchy for input models
GermanVoltageLevelUtils
GraphicElements	Represents the accumulation of graphic data elements (node graphics, line graphics)
GraphicInput	Describes the graphic data belonging to grid assets
GraphicInput.GraphicInputCopyBuilder<T extends GraphicInput.GraphicInputCopyBuilder<T>>	Abstract class for all builder that build child entities of abstract class GraphicInput
GraphicInputFactory<T extends GraphicInput,D extends EntityData>	Abstract factory implementation for all GraphicInput elements
GraphicSource	Interface that provides the capability to build entities of type GraphicInput from different data sources e.g.
GraphicValidationUtils
GridAndGeoUtils	This class offers some useful methods for handling geographical problems related to grids
GridContainer
GridContainerValidationUtils
HasLine	Interface that should be implemented by all elements holding a LineInput elements and should be processable by the Extractor.
HasNodes	Interface that should be implemented by all elements holding one or more NodeInput elements and should be processable by the Extractor.
HasThermalBus	Interface that should be implemented by all elements holding a ThermalBusInput elements and should be processable by the Extractor.
HasThermalStorage	Interface that should be implemented by all elements holding a ThermalStorageInput elements and should be processable by the Extractor.
HasType	Interface that should be implemented by all elements holding a AssetTypeInput and should be processable by the Extractor.
HeatAndPValue	Describes a tuple based on active electrical power, as well as heat power
HeatAndSValue	Describes a triple based on active and reactive electrical power, as well as heat power
HeatDemandValue	Describes as heat demand value
HpInput	Describes a heat pump
HpInput.HpInputCopyBuilder	A builder pattern based approach to create copies of HpInput entities with altered field values.
HpInputEntityData
HpInputFactory
HpResult	Represents calculation results of a HpInput
HpTypeInput	Describes the type of a HpInput
IconIdCoordinateFactory	Factory, that is able to build coordinate id to coordinate mapping from German Federal Weather Service's ICON model
IconTimeBasedWeatherValueFactory	Factory implementation of TimeBasedWeatherValueFactory, that is able to handle field to value mapping in the column scheme, ie3 uses to store it's data from German Federal Weather Service's ICON-EU model
IdCoordinateFactory	Abstract class definition for a factory, that is able to build single mapping entries from coordinate identifier to actual coordinate
IdCoordinateSource	This class serves mapping purposes between the ID of a coordinate and the actual coordinate with latitude and longitude values, which is especially needed for data source that don't offer combined primary or foreign keys.
IndividualTimeSeries<V extends Value>	Describes a TimeSeries with individual values per time step
IndividualTimeSeriesMetaInformation	Specific meta information, that can be derived from a individual time series file
InfluxDbConnector	Implements a DataConnector for InfluxDB.
InfluxDbSink	InfluxDB Sink for result and time series data
InfluxDbWeatherSource	InfluxDB Source for weather data
InputContainer<T extends InputEntity>	Represents an aggregation of different entities
InputDataSink
InputEntity	Functionless class to describe that all subclasses are input classes
InputEntityProcessor	Processes all InputEntitys and it's child classes
InvalidEntityException	Is thrown, when a checked entity is illegal and thus not usable
InvalidGridException
InvalidWeatherColumnNameException	Exception that is thrown whenever weather data columns are not as expected.
IoUtil
JointGridContainer	Model class to hold input models for more than one galvanically separated subnet
LineGraphicInput	Describes the graphic data belonging to a LineInput
LineGraphicInput.LineGraphicInputCopyBuilder	A builder pattern based approach to create copies of LineGraphicInput entities with altered field values.
LineGraphicInputEntityData	Data used by LineGraphicInputFactory used to create instances of LineGraphicInputs holding one LineInput entity.
LineGraphicInputFactory	Factory to create LineGraphicInput entities
LineInput	Describes an electrical grid line that connects two NodeInputs
LineInput.LineInputCopyBuilder	A builder pattern based approach to create copies of LineInput entities with altered field values.
LineInputFactory
LineResult	Represents calculation results of a LineInput
LineTypeInput	Describes the type of a LineInput
LineTypeInputFactory
LoadInput	Describes a load
LoadInput.LoadInputCopyBuilder	A builder pattern based approach to create copies of LoadInput entities with altered field values.
LoadInputFactory
LoadProfileEntry	Unique entry to a LoadProfileInput
LoadProfileInput
LoadProfileTimeSeriesMetaInformation	Specific meta information, that can be derived from a load profile time series file
LoadResult	Represents calculation results of a LoadInput
MeasurementUnitInput	Model of a measuring unit attached to a certain NodeInput.
MeasurementUnitInput.MeasurementUnitInputCopyBuilder	A builder pattern based approach to create copies of MeasurementUnitInput entities with altered field values.
MeasurementUnitInputFactory
MeasurementUnitValidationUtils
NestedEntity	This interface should be implemented only by other interfaces that should be used by the Extractor It provides the entry point for the extraction method in the Extractor.
NodeAssetInputEntityData	Data used by all factories used to create instances of InputEntitys holding one NodeInput entity, thus needing additional information about the NodeInput, which cannot be provided through the attribute map.
NodeGraphicInput	Describes the graphic data belonging to a NodeInput
NodeGraphicInput.NodeGraphicInputCopyBuilder	A builder pattern based approach to create copies of NodeGraphicInput entities with altered field values.
NodeGraphicInputEntityData	Data used by NodeGraphicInputFactory used to create instances of NodeGraphicInputs holding one NodeInput entity.
NodeGraphicInputFactory	Factory to create NodeGraphicInput entities
NodeInput	Describes an electrical grid node, that other assets can connect to
NodeInput.NodeInputCopyBuilder	A builder pattern based approach to create copies of NodeInput entities with altered field values.
NodeInputFactory
NodeResult	Represents calculation results of a NodeInput
NodeResultFactory
NodeValidationUtils
NotImplementedException
OlmCharacteristicInput	Characteristic for overhead line monitoring
Operable	Describes an operable Entity, with operation period interval
OperationTime	Time for which something is operated, can be limited to a time frame with one or two bounds or not limited which is by definition equal to always on
OperationTime.OperationTimeBuilder	Builder class for OperationTime
OperatorInput	Describes an operator, that operates assets
OperatorInput.OperatorInputCopyBuilder	A builder pattern based approach to create copies of OperatorInput entities with altered field values.
OperatorInputFactory
OutputDataSink
ParsingException
Processor<T>	Basic sketch and skeleton for a processors including all functions that apply for all needed subtypes of processors
ProcessorProvider	Wrapper providing the class specific processor to convert an instance of a UniqueEntity into a mapping from attribute to value which can be used to write data e.g.
ProcessorProviderException	Exception that should be used whenever an error occurs in a instance of ProcessorProvider
PsdmTimeBasedWeatherValueFactory	Factory implementation of TimeBasedWeatherValueFactory, that is able to handle field to value mapping in the typical PowerSystemDataModel (PSDM) column scheme
PValue	Describes a active power value as active power
PvInput	Describes a photovoltaic plant
PvInput.PvInputCopyBuilder	A builder pattern based approach to create copies of PvInput entities with altered field values.
PvInputFactory
PvResult	Represents calculation results of a PvInput
QV	Characteristic giving the reactive power behaviour based on the current voltage magnitude at the connecting node
RandomLoadParameters	Data model to describe the parameters of a probability density function to draw random power consumptions.
RawGridElements	Represents the aggregation of raw grid elements (nodes, lines, transformers, switches)
RawGridSource	Interface that provides the capability to build entities that are hold by a RawGridElements as well as the RawGridElements container as well from different data sources e.g.
ReactivePowerCharacteristic	Abstract class (only for grouping all reactive power characteristics together
RepetitiveTimeSeries<E extends TimeSeriesEntry<V>,V extends Value>	Describes a TimeSeries with repetitive values that can be calculated from a pattern
ResultEntity	Abstract class to hold all mappings common to all result models
ResultEntityProcessor	'De-serializer' for ResultEntitys into a fieldName to value representation to allow for an easy processing into a database or file sink e.g.
ResultEntitySource	Interface that provides the capability to build entities of type ResultEntity container from .csv files.
SimpleEntityData	Data used by SimpleEntityFactory to create an instance of an entity than can be created based only on a mapping of fieldName to value.
SimpleEntityFactory<T extends UniqueEntity>	Internal API Interface for Entities that can be build without any dependencies on other complex pojos
SimpleFactoryData	Simple class, that holds a mapping from key to value.
SimpleTimeBasedValueData<V extends Value>	Data, that is used to build a TimeBasedValue within a Factory
SinkException	Exception that should be used whenever an error occurs in a instance of a DataSink
SolarIrradianceValue	Describes an irradiance value as a pair of diffuse and direct irradiance
SourceException	Exception that should be used whenever an error occurs in a instance of a DataSource
SqlConnector	Implements a DataConnector for a native SQL connection to a relational database.
SqlWeatherSource	SQL source for weather data
StandardLoadProfile	Giving reference to a known standard load profile to apply to a LoadInput.
StandardLoadProfile.DefaultLoadProfiles
StandardUnits	A collection of Units that fit to the different input and output models by convention
StorageInput	Describes a battery storage
StorageInput.StorageInputCopyBuilder	A builder pattern based approach to create copies of StorageInput entities with altered field values.
StorageInputFactory
StorageResult	Represents calculation results of a StorageInput
StorageTypeInput	Describes the type of a StorageInput
SubGridContainer	Represents the accumulation of all data needed to create one galvanically complete single grid
SubGridGate	Defines gates between SubGridContainers and serves as edge definition for SubGridTopologyGraph
SubGridTopologyGraph	A wrapper class to define a graph for representing the structure of galvanically seperated sub grid models.
SValue	Describes a apparent power value as a pair of active and reactive power
SwitchInput	Describes an electrical grid switch between two NodeInputs
SwitchInput.SwitchInputCopyBuilder	A builder pattern based approach to create copies of LineInput entities with altered field values.
SwitchInputFactory
SwitchResult	Represents calculation results of a SwitchInput
SwitchResultFactory
SystemParticipantInput	Describes a system asset that is connected to a node
SystemParticipantInput.SystemParticipantInputCopyBuilder<T extends SystemParticipantInput.SystemParticipantInputCopyBuilder<T>>	Abstract class for all builder that build child entities of abstract class SystemParticipantInput
SystemParticipantResult	Abstract class that holds values common to all other result entities
SystemParticipantResultFactory	Factory class for creating SystemParticipantResult entities from provided SimpleEntityData data objects.
SystemParticipants	Represents the accumulation of system participant elements (BM plants, CHP plants, EVCS, fixed feed ins, heat pumps, loads, PV plants, storages, WECs)
SystemParticipantSource	Interface that provides the capability to build entities of type SystemParticipantInput as well as SystemParticipants container from .csv files.
SystemParticipantTypedEntityData<T extends SystemParticipantTypeInput>	Data used for those classes of SystemParticipantInput that need an instance of some type T of SystemParticipantTypeInput as well.
SystemParticipantTypeInput	Describes the type of a SystemParticipantInput
SystemParticipantTypeInputFactory
SystemParticipantValidationUtils
SystemParticipantWithHeatResult	Abstract class that holds values common to result entities having heat result
TemperatureValue	Describes a temperature value
ThermalBusInput	A thermal bus, to which different ThermalUnitInput units may be connected
ThermalBusInput.ThermalBusInputCopyBuilder	A builder pattern based approach to create copies of ThermalBusInput entities with altered field values.
ThermalBusInputFactory
ThermalHouseInput	Quite simple thermal model of a house to serve as a heat sink
ThermalHouseInput.ThermalHouseInputCopyBuilder	A builder pattern based approach to create copies of ThermalHouseInput entities with altered field values.
ThermalHouseInputFactory
ThermalHouseResult	Represents the results of ThermalHouseInput
ThermalResultFactory
ThermalSinkInput	Common properties to all thermal sinks
ThermalSinkResult	Represents calculation results of a ThermalSinkInput
ThermalSource	Interface that provides the capability to build thermal AssetInput entities from persistent data e.g.
ThermalStorageInput	Common properties to all thermal storage devices
ThermalStorageResult	Represents calculation results of ThermalStorageInput
ThermalUnitInput	Abstract class for grouping all common properties to thermal models.
ThermalUnitInput.ThermalUnitInputCopyBuilder<T extends ThermalUnitInput.ThermalUnitInputCopyBuilder<T>>	Abstract class for all builders that build child entities of abstract class ThermalUnitInput
ThermalUnitInputEntityData
ThermalUnitResult	Representation of a result with regard to a thermal unit
ThermalUnitValidationUtils
TimeBasedSimpleValueFactory<V extends Value>
TimeBasedValue<T extends Value>	Describes an entity of a time series by mapping a value to a timestamp
TimeBasedValueData<V extends Value>	Abstract definition of data, that is used to build a TimeBasedValue within a Factory
TimeBasedValueFactory<D extends TimeBasedValueData<V>,V extends Value>	Abstract class that is able to build TimeBasedValues from "flat" information
TimeBasedWeatherValueData
TimeBasedWeatherValueFactory	Abstract factory to handle the conversion from "flat" field to value mapping onto actual TimeBasedValueFactory with WeatherValue
TimeSeries<E extends TimeSeriesEntry<V>,V extends Value>	Describes a Series of values
TimeSeriesEntry<V extends Value>	This is an abstract class describing a unique entry to a time series
TimeSeriesMappingFactory
TimeSeriesMappingSource	This interface describes basic function to handle mapping between models and their respective time series
TimeSeriesMappingSource.MappingEntry	Class to represent one entry within the participant to time series mapping
TimeSeriesProcessor<T extends TimeSeries<E,V>,E extends TimeSeriesEntry<V>,V extends Value>
TimeSeriesProcessorKey	Class to bundle a triple of time series class, entry class and value class for later recognition of supported time series in the TimeSeriesProcessor
TimeSeriesSource<V extends Value>	The interface definition of a source, that is able to provide one specific time series for one model
TimeSeriesUtil
TopologyException
Transformer2WInput	Describes a two winding transformer, that is connected to two NodeInputs
Transformer2WInput.Transformer2WInputCopyBuilder	A builder pattern based approach to create copies of Transformer2WInput entities with altered field values.
Transformer2WInputFactory
Transformer2WResult	Represents calculation results of a Transformer2WInput
Transformer2WTypeInput	Describes the type of a Transformer2WInput
Transformer2WTypeInputFactory
Transformer3WInput	Describes a three winding transformer, that is connected to three NodeInputs
Transformer3WInput.Transformer3WInputCopyBuilder	A builder pattern based approach to create copies of Transformer3WInput entities with altered field values.
Transformer3WInputEntityData
Transformer3WInputFactory
Transformer3WResult
Transformer3WTypeInput	Describes the type of a Transformer3WInput
Transformer3WTypeInputFactory
TransformerInput	Describes an electrical grid transformer, is "located" in the inferior subnet
TransformerResult	Abstract class that adds a tap changer position attribute to the ConnectorResult which actually creates a transformer representation.
TypedConnectorInputEntityData<T extends AssetTypeInput>	Data used for those classes of ConnectorInput that need an instance of some type T of Transformer2WTypeInput as well.
TypeSource	Interface that provides the capability to build entities of type SystemParticipantTypeInput and OperatorInput from different data sources e.g.
UniqueEntity	Supplies every subclass with a generated UUID, making it unique
UniqueEntity.UniqueEntityBuilder
UniqueEntity.UniqueEntityCopyBuilder<T extends UniqueEntity.UniqueEntityBuilder>	Abstract class for all builder that build child entities of abstract class UniqueEntity
UnsafeEntityException	Is thrown, when a checked entity may be unsafe to use, but is not necessarily unsafe
ValidationException
ValidationUtils	Basic Sanity validation tools for entities
Value	Describes any class that represents a value
VoltageLevel	Definition of a concrete voltage level.
VoltageLevelException	Is thrown in case, there is some problem when building VoltageLevelInformation
WeatherSource	Describes a data source for weather data
WeatherValue	Describes weather as a combination of solar irradiance, temperature and wind values
WecCharacteristicInput	Characteristic mapping the wind velocity to its corresponding Betz coefficient
WecInput	Describes a Wind Energy Converter
WecInput.WecInputCopyBuilder	A builder pattern based approach to create copies of WecInput entities with altered field values.
WecInputFactory
WecResult	Represents calculation results of a WecInput
WecTypeInput	Describes the type of a WecInput
WholesalePriceSource	Describes a data source for wholesale prices
WindValue	Describes wind as a pair of direction and velocity