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

Class CommunicationAdapter

java.lang.Object

org.lfenergy.compas.sct.commons.scl.SclElementAdapter<SclRootAdapter,TCommunication>

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

public class CommunicationAdapter
extends SclElementAdapter<SclRootAdapter,TCommunication>

A representation of the model object Communication.

The following features are supported:

• add Subnetwork under this object
• Add TPrivate under this object

See Also:

• SclRootAdapter
• TCommunication

Field Summary

Fields inherited from class org.lfenergy.compas.sct.commons.scl.SclElementAdapter

currentElem, parentAdapter

Constructor Summary

Constructors

Constructor	Description
CommunicationAdapter(SclRootAdapter parentAdapter)	Constructor
CommunicationAdapter(SclRootAdapter parentAdapter, TCommunication currentElem)	Constructor

Method Summary

Modifier and Type	Method	Description
SubNetworkAdapter	addSubnetwork(String snName, String snType, String iedName, String apName)	Add Subnetwork node in Communication one.
boolean	amChildElementRef()	Check if node is child of the reference node
protected String	elementXPath()	Returns XPath path to current element
List<SubNetworkAdapter>	getSubNetworkAdapters()	Gets all Subnetworks from Communication node in an adapter wrapper
Optional<SubNetworkAdapter>	getSubnetworkByName(String snName)	Gets Subnetwork by name from Communication in an adapter wrapper

Methods inherited from class org.lfenergy.compas.sct.commons.scl.SclElementAdapter

addPrivate, amRootElement, buildFatalReportItem, customInit, getXPath, setCurrentElem

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CommunicationAdapter

public CommunicationAdapter(SclRootAdapter parentAdapter)

Constructor

Parameters:

parentAdapter - Parent container reference

CommunicationAdapter

public CommunicationAdapter(SclRootAdapter parentAdapter,
 TCommunication currentElem)

Constructor

Parameters:

parentAdapter - Parent container reference

currentElem - Current reference

Method Details

amChildElementRef

public boolean amChildElementRef()

Check if node is child of the reference node

Specified by:

amChildElementRef in class SclElementAdapter<SclRootAdapter,TCommunication>

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,TCommunication>

Returns:

message as undefined

addSubnetwork

public SubNetworkAdapter addSubnetwork(String snName,
 String snType,
 String iedName,
 String apName)
                                throws ScdException

Add Subnetwork node in Communication one. For that :

• coherence is checked first one AccessPoint's name between given * data and IED/Services/AccessPoint
• If good, Subnetworks are created
• And then AccessPoint are created two in the Subnetwork

.

Parameters:

snName - Subnetwork name

snType - Subnetwork type

iedName - IED name

apName - AccessPoint name

Returns:

SubNetworkAdapter Current reference

Throws:

ScdException

getSubnetworkByName

public Optional<SubNetworkAdapter> getSubnetworkByName(String snName)

Gets Subnetwork by name from Communication in an adapter wrapper

Parameters:

snName - Subnetwork name

Returns:

Optional SubNetworkAdapter object

getSubNetworkAdapters

public List<SubNetworkAdapter> getSubNetworkAdapters()

Gets all Subnetworks from Communication node in an adapter wrapper

Returns:

the value of the SubNetworkAdapter containment reference list.