Package org.lfenergy.compas.sct.commons.scl.ied

Class IEDAdapter

java.lang.Object
org.lfenergy.compas.sct.commons.scl.SclElementAdapter<SclRootAdapter,TIED>
org.lfenergy.compas.sct.commons.scl.ied.IEDAdapter
public class IEDAdapter extends SclElementAdapter<SclRootAdapter,TIED>
A representation of the model object IED.

The following features are supported:

  1. Adapter
  2. Principal functions
  3. Checklist functions
See Also:

  • Constructor Details

    • IEDAdapter

      public IEDAdapter(SclRootAdapter parentAdapter)
      Constructor
      Parameters:
      parentAdapter - Parent container reference

    • IEDAdapter

      public IEDAdapter(SclRootAdapter parentAdapter, TIED currentElem)
      Constructor
      Parameters:
      parentAdapter - Parent container reference
      currentElem - Current reference

    • IEDAdapter

      public IEDAdapter(SclRootAdapter parentAdapter, String iedName) throws ScdException
      Constructor
      Parameters:
      parentAdapter - Parent container reference
      iedName - IED name reference
      Throws:
      ScdException

  • Method Details

    • amChildElementRef

      protected boolean amChildElementRef()
      Check if node is child of the reference node
      Specified by:
      amChildElementRef in class SclElementAdapter<SclRootAdapter,TIED>
      Returns:
      link parent child existence

    • elementXPath

      protected String elementXPath()
      Description copied from class: SclElementAdapter
      Returns XPath path to current element
      Specified by:
      elementXPath in class SclElementAdapter<SclRootAdapter,TIED>
      Returns:
      message as undefined

    • setIEDName

      public void setIEDName(String iedName)
      Sets IED name in current IED
      Parameters:
      iedName - new name to set

    • streamLDeviceAdapters

      public Stream<LDeviceAdapter> streamLDeviceAdapters()
      Gets All LDevice from current IED as LDeviceAdapter
      Returns:
      Stream of LDeviceAdapter object

    • getLDeviceAdapterByLdInst

      public LDeviceAdapter getLDeviceAdapterByLdInst(String ldInst) throws ScdException
      Gets LDevice from current IED by ldInst parameter
      Parameters:
      ldInst - ldInst value of LDevice to get
      Returns:
      LDeviceAdapter object
      Throws:
      ScdException - when LDevice is not found

    • findLDeviceAdapterByLdInst

      public Optional<LDeviceAdapter> findLDeviceAdapterByLdInst(String ldInst)
      Gets LDevice from current IED by ldInst parameter
      Parameters:
      ldInst - ldInst value of LDevice to get
      Returns:
      optional of LDeviceAdapter object

    • updateLDeviceNodesType

      public void updateLDeviceNodesType(Map<String,String> pairOldNewId) throws ScdException
      Updates all LNode type value specified in pairOldNewId as key (oldID), by corresponding value (newID) in all LDevice of the current IED. Update LDevice name by combining IED name and LDevice ldInst value
      Parameters:
      pairOldNewId - map of old ID and new ID. Old ID to find in LNode Type and replace it with New ID
      Throws:
      ScdException - throws when renaming LDevice and new name has more than 33 caracteres

    • getServices

      public TServices getServices()
      Gets Services of current IED
      Returns:
      TServices object

    • getName

      public String getName()
      Gets name of current IED
      Returns:
      string name

    • matches

      public boolean matches(ObjectReference objRef)
      Checks if given ObjectReference matches with one of current IED LNode (ie having common reference with DataSet, ReportControl or DataTypeTemplate)
      Parameters:
      objRef - reference to compare with LNodes data's
      Returns:
      Boolean value of check result

    • findAccessPointByName

      public boolean findAccessPointByName(String apName)
      Checks existence of Access Point in curent IED by name
      Parameters:
      apName - AccessPoint name to check
      Returns:
      Boolean value of check result

    • getExtRefBinders

      public List<ExtRefBindingInfo> getExtRefBinders(@NonNull @NonNull ExtRefSignalInfo signalInfo) throws ScdException
      Checks all possible ExtRef in current IED which could be bound to given ExtRef as parameter
      Parameters:
      signalInfo - ExtRef to bind data
      Returns:
      list of ExtRefBindingInfo object (containing binding data for each LDevice in current IED)
      Throws:
      ScdException - throws when ExtRef contains inconsistency data

    • isSettingConfig

      public boolean isSettingConfig(String ldInst)
      Checks for a given LDevice in current IED if Setting Group is well setted
      Parameters:
      ldInst - ldInst for LDevice for which Setting Group is checked
      Returns:
      Boolean value of check result

    • getPrivateHeader

      public Optional<TPrivate> getPrivateHeader(String privateType)
      Gets IED Private corresponding to specified type in parameter
      Parameters:
      privateType - Private type to get
      Returns:
      optional of TPrivate object

    • getPrivateCompasBay

      public Optional<TCompasBay> getPrivateCompasBay()
      Extract private compas:Bay
      Returns:
      value of private compas:Bay if present, empty Optional otherwise

    • checkDataGroupCoherence

      public List<SclReportItem> checkDataGroupCoherence()
      Checks if Controls, DataSets and FCDAs of IED respect config limitation
      Returns:
      empty list if all IED respect limits, otherwise list of errors

    • checkBindingDataGroupCoherence

      public List<SclReportItem> checkBindingDataGroupCoherence()
      Checks if Controls and FCDAs of source IEDs respect config limitation
      Returns:
      empty list if all IED respect limits, otherwise list of errors

    • getCompasICDHeader

      public Optional<TCompasICDHeader> getCompasICDHeader()
      Get value of private type COMPAS-ICDHeader
      Returns:
      COMPAS-ICDHeader private value if present, else empty Optional

    • getCompasSystemVersion

      public Optional<TCompasSystemVersion> getCompasSystemVersion()
      Get value of private type COMPAS-SystemVersion
      Returns:
      COMPAS-SystemVersion private value if present, else empty Optional

    • manageMonitoringLns

      public List<SclReportItem> manageMonitoringLns()
      Update and/or create Monitoring LNs (LSVS and LGOS) into LDSUIED for each bound ExtRef of each LDevice
      Returns:
      a list of SclReport Objects that contains errors