Package org.lfenergy.compas.sct.commons.dto

Class ReportControlBlock

java.lang.Object

org.lfenergy.compas.sct.commons.dto.LNodeMetaDataEmbedder

org.lfenergy.compas.sct.commons.dto.ControlBlock

org.lfenergy.compas.sct.commons.dto.ReportControlBlock

public class ReportControlBlock
extends ControlBlock

A representation of the model object ReportControlBlock.

The following features are supported:

• rptID
• Name
• dataSetRef
• Desc
• Refers To confRev
• Refers To IedNames
• Refers To trgOps
• Refers To intgPd
• Refers To rptEnabled.max
• Refers To rptEnabled.desc
• Refers To buffered
• Refers To bufTime
• Refers To indexed

See Also:

• TReportControl

Field Summary

Fields

Modifier and Type	Field	Description
protected long	intgPd
protected TTrgOps	trgOps

Fields inherited from class org.lfenergy.compas.sct.commons.dto.ControlBlock

confRev, dataSetRef, desc, id, name, targets

Fields inherited from class org.lfenergy.compas.sct.commons.dto.LNodeMetaDataEmbedder

metaData

Constructor Summary

Constructors

Constructor	Description
ReportControlBlock(String name, String id, String dataSetRef)	Create ReportControlBlock with default values
ReportControlBlock(TReportControl reportControl)	Constructor

Method Summary

Modifier and Type	Method	Description
TReportControl	addToLN(TAnyLN tAnyLN)	Add the ControlBlock to an LN or LN0 element
ControlBlockEnum	getControlBlockEnum()	Get ControlBlockEnum
TReportControl	toTControl()	Creates Report Control Block
void	validateCB()	Validates Report Control Block
protected void	validateSecurityEnabledValue(TServices tServices)	Implementation is required by superclass but ReportControl blocks has no SecurityEnabled attributes.

Methods inherited from class org.lfenergy.compas.sct.commons.dto.ControlBlock

copyProtocol, getConfRev, getControlBlockServiceSetting, getServiceType, validateSecurityEnabledValue

Methods inherited from class org.lfenergy.compas.sct.commons.dto.LNodeMetaDataEmbedder

getHolderIEDName, getHolderLDInst, getHolderLnClass, getHolderLnInst, getHolderLnPrefix, setHolderIEDName, setHolderLDInst, setHolderLnClass, setHolderLnInst, setHolderLnPrefix, setMetaData

Methods inherited from class java.lang.Object

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

Field Details

trgOps

protected TTrgOps trgOps

intgPd

protected long intgPd

Constructor Details

ReportControlBlock

public ReportControlBlock(String name,
 String id,
 String dataSetRef)

Create ReportControlBlock with default values

Parameters:

name - name of the ReportControlBlock

id - rptId of the ReportControlBlock

dataSetRef - datSet of the ReportControlBlock

ReportControlBlock

public ReportControlBlock(TReportControl reportControl)

Constructor

Parameters:

reportControl - input

Method Details

getControlBlockEnum

public ControlBlockEnum getControlBlockEnum()

Description copied from class: ControlBlock

Get ControlBlockEnum

Specified by:

getControlBlockEnum in class ControlBlock

Returns:

ControlBlockEnum of the instance

validateSecurityEnabledValue

protected void validateSecurityEnabledValue(TServices tServices)
                                     throws ScdException

Implementation is required by superclass but ReportControl blocks has no SecurityEnabled attributes. This implementation does nothing.

Specified by:

validateSecurityEnabledValue in class ControlBlock

Parameters:

tServices - Service object

Throws:

ScdException - never (this is just to comply with superclass)

toTControl

public TReportControl toTControl()

Creates Report Control Block

Specified by:

toTControl in class ControlBlock

Returns:

TReportControl object

validateCB

public void validateCB()
                throws ScdException

Validates Report Control Block

Overrides:

validateCB in class ControlBlock

Throws:

ScdException - when required fields are missing

addToLN

public TReportControl addToLN(TAnyLN tAnyLN)

Description copied from class: ControlBlock

Add the ControlBlock to an LN or LN0 element

Specified by:

addToLN in class ControlBlock

Parameters:

tAnyLN - tLN or tLNO element

Returns:

the added TControl