Package org.lfenergy.compas.sct.commons.util

Interface ILDEPFSettings

All Known Implementing Classes:

SettingLDEPFCsvHelper

public interface ILDEPFSettings

This interface showcases the LDEPF parameters for the LDEPF LDevice.

Method Summary

Modifier and Type	Method	Description
List<TIED>	getIedSources(SclRootAdapter sclRootAdapter, TCompasBay compasBay, LDEPFSettingData setting)	Provides valid IED sources with LDEPF configuration. Example of LDEPF configuration include: 1.
Optional<LDEPFSettingData>	getLDEPFSettingDataMatchExtRef(TExtRef extRef)	Provides the matching setting for an ExtRef.

Method Details

getLDEPFSettingDataMatchExtRef

Optional<LDEPFSettingData> getLDEPFSettingDataMatchExtRef(TExtRef extRef)

Provides the matching setting for an ExtRef.

Parameters:

extRef - The ExtRef object

Returns:

the matching LDEPFSettingDTO for an ExtRef

getIedSources

List<TIED> getIedSources(SclRootAdapter sclRootAdapter,
 TCompasBay compasBay,
 LDEPFSettingData setting)

Provides valid IED sources with LDEPF configuration.
Example of LDEPF configuration include:
1. COMPAS-Bay verification that should be closed to the provided Flow Kind
2. COMPAS-ICDHeader verification that should match the provided parameters, see Utils.isIcdHeaderMatch(org.lfenergy.compas.sct.commons.scl.ied.IEDAdapter, org.lfenergy.compas.sct.commons.dto.LDEPFSettingData)
3. Active LDevice source object that should match the provided parameters, see Utils.getActiveSourceLDevice(org.lfenergy.compas.sct.commons.scl.ied.IEDAdapter, org.lfenergy.compas.sct.commons.dto.LDEPFSettingData)
4. Active LNode source object that should match the provided parameters, see Utils.getActiveLNodeSource(org.lfenergy.compas.sct.commons.scl.ied.LDeviceAdapter, org.lfenergy.compas.sct.commons.dto.LDEPFSettingData)
5. Valid DataTypeTemplate Object hierarchy that should match the DO/DA/BDA parameters, see Utils.isValidDataTypeTemplate(org.lfenergy.compas.sct.commons.scl.ied.AbstractLNAdapter<?>, org.lfenergy.compas.sct.commons.dto.LDEPFSettingData)

Parameters:

sclRootAdapter - SCL

compasBay - TCompasBay

setting - LDEPFSetting

Returns:

the IED sources matching the LDEPFSetting