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

Class ControlBlockAdapter

java.lang.Object

org.lfenergy.compas.sct.commons.scl.SclElementAdapter<AbstractLNAdapter<? extends TAnyLN>,TControl>

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

public class ControlBlockAdapter
extends SclElementAdapter<AbstractLNAdapter<? extends TAnyLN>,TControl>

A representation of the model object ControlBlockAdapter.

The following features are supported:

1. Principal functions
• <em>Add a ClientLN to ReportControl or IEDName to GSEControl/SampleValueControl, if it does not already exist. in this DataSet</em></li> </ul> </ol> <br/> <pre> <b>ObjectReference</b>: ControlBlock (GSEControl, SampleValueControl or ReportControl) </pre>

See Also:

• TGSEControl
• TSampledValueControl
• TReportControl
• AbstractLNAdapter

Field Summary

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

currentElem, parentAdapter

Constructor Summary

Constructors

Constructor	Description
ControlBlockAdapter(AbstractLNAdapter<? extends TAnyLN> parentAdapter, TControl tControl)

Method Summary

Modifier and Type	Method	Description
void	addTargetIfNotExists(AbstractLNAdapter<?> targetLn)	Add a ClientLN to ReportControl or IEDName to GSEControl/SampleValueControl, if it does not already exist.
protected boolean	amChildElementRef()	Check if node is child of the reference node
Optional<SclReportItem>	configureNetwork(long appId, String macAddress, Integer vlanId, Byte vlanPriority, TDurationInMilliSec minTime, TDurationInMilliSec maxTime)	Configure the Communication section for this ControlBlock - Communication/SubNetwork/ConnectedAP/GSE for GSEControl block - Communication/SubNetwork/ConnectedAP/SMV for SampledValueControl block
protected String	elementXPath()	Returns local XPath
ControlBlockEnum	getControlBlockEnum()
String	getName()	Get the name of this ControlBlock
IEDAdapter	getParentIedAdapter()	Get parent IED

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

ControlBlockAdapter

public ControlBlockAdapter(AbstractLNAdapter<? extends TAnyLN> parentAdapter,
 TControl tControl)

Method Details

getControlBlockEnum

public ControlBlockEnum getControlBlockEnum()

amChildElementRef

protected boolean amChildElementRef()

Check if node is child of the reference node

Specified by:

amChildElementRef in class SclElementAdapter<AbstractLNAdapter<? extends TAnyLN>,TControl>

Returns:

link parent child existence

elementXPath

protected String elementXPath()

Returns local XPath

Specified by:

elementXPath in class SclElementAdapter<AbstractLNAdapter<? extends TAnyLN>,TControl>

Returns:

XPath for current element (not including parent XPath)

getName

public String getName()

Get the name of this ControlBlock

Returns:

name of ControlBlock

addTargetIfNotExists

public void addTargetIfNotExists(AbstractLNAdapter<?> targetLn)

Add a ClientLN to ReportControl or IEDName to GSEControl/SampleValueControl, if it does not already exist.

Parameters:

targetLn - target LN (where the target ExtRef is)

configureNetwork

public Optional<SclReportItem> configureNetwork(long appId,
 String macAddress,
 Integer vlanId,
 Byte vlanPriority,
 TDurationInMilliSec minTime,
 TDurationInMilliSec maxTime)

Configure the Communication section for this ControlBlock - Communication/SubNetwork/ConnectedAP/GSE for GSEControl block - Communication/SubNetwork/ConnectedAP/SMV for SampledValueControl block

Parameters:

appId - value for P type APPID

macAddress - value for P type MAC-Address

vlanId - value for P type VLAN-ID

vlanPriority - value for P type VLAN-PRIORITY

minTime - MinTime Element

maxTime - MaxTime Element

Returns:

An empty Optional if network have been configured, else a SclReportItem.

getParentIedAdapter

public IEDAdapter getParentIedAdapter()

Get parent IED

Returns:

ControlBlock's parent IEDAdapter