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

Class SubNetworkAdapter

java.lang.Object
org.lfenergy.compas.sct.commons.scl.SclElementAdapter<CommunicationAdapter,TSubNetwork>
org.lfenergy.compas.sct.commons.scl.com.SubNetworkAdapter
public class SubNetworkAdapter extends SclElementAdapter<CommunicationAdapter,TSubNetwork>
A representation of the model object SubNetwork.

The following features are supported:

See Also:

  • Constructor Details

    • SubNetworkAdapter

      public SubNetworkAdapter(CommunicationAdapter parentAdapter, @NonNull @NonNull TSubNetwork currentElem)
      Constructor
      Parameters:
      parentAdapter - Parent container reference
      currentElem - Current reference

  • Method Details

    • amChildElementRef

      protected boolean amChildElementRef()
      Check if node is child of the reference node
      Specified by:
      amChildElementRef in class SclElementAdapter<CommunicationAdapter,TSubNetwork>
      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<CommunicationAdapter,TSubNetwork>
      Returns:
      message as undefined

    • addConnectedAP

      public ConnectedAPAdapter addConnectedAP(@NonNull @NonNull String iedName, @NonNull @NonNull String apName)
      Create a Connected Access Point for this subnetwork.

      Note : this method doesn't check the validity on neither the IED name nor the access point name.

      Parameters:
      iedName - input
      apName - input
      Returns:
      the ConnectedAPAdapter object

    • getName

      public String getName()
      Returns the value of the name attribute.
      Returns:
      the value of the name attribute.

    • getType

      public String getType()
      Returns the value of the type attribute.
      Returns:
      the value of the type attribute.

    • getConnectedAPAdapters

      public List<ConnectedAPAdapter> getConnectedAPAdapters()
      Returns the value of the ConnectedAPAdapter containment reference list.
      Returns:
      the value of the ConnectedAPAdapter containment reference list.

    • getConnectedAPAdapter

      public ConnectedAPAdapter getConnectedAPAdapter(String iedName, String apName) throws ScdException
      Gets ConnectedAP from Subnetwork
      Parameters:
      iedName - IED name
      apName - AccessPoint name
      Returns:
      the ConnectedAPAdapter object
      Throws:
      ScdException - when ConnectedAP not found

    • findConnectedAPAdapter

      public Optional<ConnectedAPAdapter> findConnectedAPAdapter(String iedName, String apName) throws ScdException
      Find ConnectedAP from Subnetwork
      Parameters:
      iedName - IED name
      apName - AccessPoint name
      Returns:
      the ConnectedAPAdapter object
      Throws:
      ScdException