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

Class LN0Adapter

java.lang.Object

org.lfenergy.compas.sct.commons.scl.SclElementAdapter<LDeviceAdapter,T>

org.lfenergy.compas.sct.commons.scl.ied.AbstractLNAdapter<LN0>

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

public class LN0Adapter
extends AbstractLNAdapter<LN0>

A representation of the model object LN0Adapter.

The following features are supported:

1. Adapter
• Returns the value of the DataTypeTemplateAdapter reference object
2. Principal functions
• Returns the value of the inst attribute
• Returns the value of the lnClass attribute
• Returns the value of the lnTYpe attribute
• Returns the logical node name LNName = prefix + lnClass + lnInst
• Returns the value of the TExtRef containment reference list
• Returns the value of the TExtRef containment reference list By ExtRefSignalInfo
• throws exception when specified signal not found in LN target
• Returns the value of the DataAttributeRef containment reference By filter
• Returns DAI (sGroup, value) containment reference list By DataAttributeRef filter
• Returns the value of the TDataSet object reference By the value of the name attribute
• Returns the value of the ControlBlock containment reference list that match datSet value of given TDataSet
• Add TPrivate under this object
• Remove all ControlBlock
3. Checklist functions
• Check whether the section DataName of given ObjectReference match current LN0Adapter DataName
• Check whether the section DataName of given ObjectReference match current LNAdapter DataName Excluding DataName from DataTypeTemplat

      ObjectReference: LDName/LNName.DataName[.DataName[…]].DataAttributeName[.DAComponentName[ ….]]
      LDName = "name" attribute of IEDName element + "inst" attribute of LDevice element
      LNName = "prefix" + "lnClass" + "lnInst"
  

See Also:

• TLN0
• AbstractLNAdapter

Field Summary

Fields

Modifier and Type	Field	Description
static final DaTypeName	BEHAVIOUR_DA_TYPE_NAME
static final DoTypeName	BEHAVIOUR_DO_TYPE_NAME

Fields inherited from class org.lfenergy.compas.sct.commons.scl.ied.AbstractLNAdapter

MOD_DO_TYPE_NAME, STVAL_DA_TYPE_NAME

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

currentElem, parentAdapter

Constructor Summary

Constructors

Constructor	Description
LN0Adapter(LDeviceAdapter parentAdapter, LN0 ln0)	Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	amChildElementRef()	Check if node is child of the reference node
protected String	elementXPath()	Returns XPath path to current element
protected Class<LN0>	getElementClassType()	Gets current LN0 class type
InputsAdapter	getInputsAdapter()	Gets Inputs node as an adapter
String	getLNClass()	Gets LNClass enum value of current LNO
String	getLNInst()	Gets LNInst value of current LN0
String	getPrefix()	Gets Prefix value of current LN0
protected boolean	matchesDataAttributes(String dataAttribute)	Checks if given attibrute corresponds to DataSet or ReportControl or SMVControl or GSEControl in current LN0
void	removeAllControlBlocksAndDatasets()	Remove all SMVControl and GSEControl of current LN0
List<SclReportItem>	updateDoInRef()	Update DAIs of DO InRef in all LN0 of the SCD using matching ExtRef information.
Optional<SclReportItem>	updateLDeviceStatus(List<org.apache.commons.lang3.tuple.Pair<String,String>> iedNameLDeviceInstList)	Verify and update LDevice status in parent Node

Methods inherited from class org.lfenergy.compas.sct.commons.scl.ied.AbstractLNAdapter

addControlBlock, addDOI, builder, checkExtRefInfoCoherence, createControlBlockIfNotExists, createDataSetIfNotExists, createDoiSdiDaiChainIfNotExists, extractExtRefFromExtRefInfo, findControlBlock, findDataSetByName, findDoiAdapterByName, findMatch, generateControlBlockId, getControlBlocks, getControlBlocksForMatchingFCDA, getCurrentScd, getDAI, getDaiModStVal, getDaiModStValValue, getDAIValues, getDataSetByName, getDataSetMatchingExtRefInfo, getDataTypeTemplateAdapter, getDOIAdapterByName, getDOIAdapters, getEnumValues, getExtRefs, getExtRefs, getFCDAs, getLNodeName, getLnType, getParentIed, getParentLDevice, getTControlsByType, hasControlBlock, hasInputs, isExtRefExist, matches, overrideAttributesFromDAI, removeAllExtRefSourceBindings, streamControlBlocks, updateDAI, updateExtRefBinders, updateExtRefBindingInfo, updateExtRefSource

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

Field Details

BEHAVIOUR_DO_TYPE_NAME

public static final DoTypeName BEHAVIOUR_DO_TYPE_NAME

BEHAVIOUR_DA_TYPE_NAME

public static final DaTypeName BEHAVIOUR_DA_TYPE_NAME

Constructor Details

LN0Adapter

public LN0Adapter(LDeviceAdapter parentAdapter,
 LN0 ln0)

Constructor

Parameters:

parentAdapter - Parent container reference

ln0 - Current reference

Method Details

amChildElementRef

protected boolean amChildElementRef()

Check if node is child of the reference node

Specified by:

amChildElementRef in class SclElementAdapter<LDeviceAdapter,LN0>

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<LDeviceAdapter,LN0>

Returns:

message as undefined

getElementClassType

protected Class<LN0> getElementClassType()

Gets current LN0 class type

Specified by:

getElementClassType in class AbstractLNAdapter<LN0>

Returns:

LN0.class

getLNClass

public String getLNClass()

Gets LNClass enum value of current LNO

Specified by:

getLNClass in class AbstractLNAdapter<LN0>

Returns:

LNClass value

getLNInst

public String getLNInst()

Gets LNInst value of current LN0

Specified by:

getLNInst in class AbstractLNAdapter<LN0>

Returns:

""

getPrefix

public String getPrefix()

Gets Prefix value of current LN0

Specified by:

getPrefix in class AbstractLNAdapter<LN0>

Returns:

""

getInputsAdapter

public InputsAdapter getInputsAdapter()

Gets Inputs node as an adapter

Returns:

an InputsAdapter

matchesDataAttributes

protected boolean matchesDataAttributes(String dataAttribute)

Checks if given attibrute corresponds to DataSet or ReportControl or SMVControl or GSEControl in current LN0

Overrides:

matchesDataAttributes in class AbstractLNAdapter<LN0>

Parameters:

dataAttribute - attribute to check

Returns:

Boolean value of check result

removeAllControlBlocksAndDatasets

public void removeAllControlBlocksAndDatasets()

Remove all SMVControl and GSEControl of current LN0

Overrides:

removeAllControlBlocksAndDatasets in class AbstractLNAdapter<LN0>

updateLDeviceStatus

public Optional<SclReportItem> updateLDeviceStatus(List<org.apache.commons.lang3.tuple.Pair<String,String>> iedNameLDeviceInstList)

Verify and update LDevice status in parent Node

Parameters:

iedNameLDeviceInstList - pair of Ied name and LDevice inst attributes

Returns:

Set of Errors

updateDoInRef

public List<SclReportItem> updateDoInRef()

Update DAIs of DO InRef in all LN0 of the SCD using matching ExtRef information.

Returns:

A list of SclReport Objects that contain errors