Report control block (RCB) representation. More...

Inheritance diagram for IEC61850.Client.ReportControlBlock:

Public Member Functions
void	Dispose ()
	Releases all resource used by the IEC61850.Client.ReportControlBlock object.

string	GetObjectReference ()

void	InstallReportHandler (ReportHandler reportHandler, object parameter)
	Installs the report handler.

void	GetRCBValues ()
	Read all RCB values from the server.

UInt32	GetRCBValuesAsync (GetRCBValuesHandler handler, object parameter)
	Read all RCB values from the server - asynchronous version.

void	SetRCBValues ()
	Write changed RCB values to the server.

UInt32	SetRCBValuesAsync (SetRCBValuesHandler handler, object parameter)

UInt32	SetRCBValuesAsync (bool singleRequest, SetRCBValuesHandler handler, object parameter)

void	SetRCBValues (bool singleRequest)
	Write changed RCB values to the server.

bool	IsBuffered ()
	Determines whether this instance is a buffered or unbuffered RCB.

UInt64	GetEntryTime ()
	Gets the entry time of the RCB as ms time.

DateTimeOffset	GetEntryTimeAsDateTimeOffset ()
	Gets the entry time of the RCB as DateTimeOffset.

byte[]	GetEntryID ()
	Gets the entryID of RCB.

void	SetEntryID (byte[] entryId)

string	GetDataSetReference ()
	Gets the data set reference of the associated data set.

void	SetDataSetReference (string dataSetReference)
	Sets the data set reference. Use this method to select the associated data set for the RCB.

string	GetRptId ()
	Gets the report identifier.

void	SetRptId (string rptId)
	Sets the RptId (report ID) of the RCB.

bool	GetRptEna ()
	Check if reporting is currently enabled.

void	SetRptEna (bool rptEna)
	Sets report enable flag. Use this to enable reporting.

bool	GetPurgeBuf ()
	Get the purgeBuf flag of the report control block.

void	SetPurgeBuf (bool purgeBuf)
	Set the purgeBuf flag of the report control block.

UInt32	GetBufTm ()
	Gets the buffer time.

void	SetBufTm (UInt32 bufTm)
	Sets the buffer time.

bool	GetGI ()
	Gets the GI flag.

void	SetGI (bool GI)
	Sets the GI flag. Use this to trigger a GI (general interrogation) command.

bool	GetResv ()
	Check if RCB is reserved by a client.

UInt32	GetConfRev ()
	Gets the configuration revision of the RCB.

void	SetResv (bool resv)
	Sets RESV flag. Use this to reserve (allocate) this RCB.

TriggerOptions	GetTrgOps ()
	Gets the trigger options of the RCB.

void	SetTrgOps (TriggerOptions trgOps)
	Sets the trigger options of the RCB.

UInt32	GetIntgPd ()
	Gets the integrity period.

void	SetIntgPd (UInt32 intgPd)
	Sets the integrity period.

ReportOptions	GetOptFlds ()
	Gets the option fields.

void	SetOptFlds (ReportOptions optFlds)
	Sets the option field. Used to enable or disable optional report elements.

bool	HasResvTms ()
	Check if the report control block has the "ResvTms" attribute.

Int16	GetResvTms ()
	Gets the ResvTms (reservation time) value.

void	SetResvTms (Int16 resvTms)
	Sets the ResvTms (reservation time) value.

byte[]	GetOwner ()
	Gets the current owner of the RCB.

Detailed Description

Report control block (RCB) representation.

This class is used as a client side representation (copy) of a report control block (RCB). Values from the server will only be read when the GetRCBValues method is called. Values at the server are only affected when the SetRCBValues method is called.

Member Function Documentation

◆ Dispose()

void IEC61850.Client.ReportControlBlock.Dispose ( )

Releases all resource used by the IEC61850.Client.ReportControlBlock object.

Call Dispose when you are finished using the IEC61850.Client.ReportControlBlock. The Dispose method leaves the IEC61850.Client.ReportControlBlock in an unusable state. After calling Dispose, you must release all references to the IEC61850.Client.ReportControlBlock so the garbage collector can reclaim the memory that the IEC61850.Client.ReportControlBlock was occupying.

◆ GetBufTm()

UInt32 IEC61850.Client.ReportControlBlock.GetBufTm ( )

Gets the buffer time.

Returns: The buffer time in ms.

◆ GetConfRev()

UInt32 IEC61850.Client.ReportControlBlock.GetConfRev ( )

Gets the configuration revision of the RCB.

Returns: The conf rev.

◆ GetDataSetReference()

string IEC61850.Client.ReportControlBlock.GetDataSetReference ( )

Gets the data set reference of the associated data set.

Returns: The data set reference.

◆ GetEntryID()

byte[] IEC61850.Client.ReportControlBlock.GetEntryID ( )

Gets the entryID of RCB.

Returns the EntryID of the last received GetRCBValues service response. The EntryID is only present in buffered RCBs (BRCBs).

Returns: The entry ID

◆ GetEntryTime()

UInt64 IEC61850.Client.ReportControlBlock.GetEntryTime ( )

Gets the entry time of the RCB as ms time.

The entry time is the timestamp of the last report sent.

Returns: The entry time as ms timestamp

◆ GetEntryTimeAsDateTimeOffset()

DateTimeOffset IEC61850.Client.ReportControlBlock.GetEntryTimeAsDateTimeOffset ( )

Gets the entry time of the RCB as DateTimeOffset.

The entry time is the timestamp of the last report sent.

Returns: The entry time as DataTimeOffset

◆ GetGI()

bool IEC61850.Client.ReportControlBlock.GetGI ( )

Gets the GI flag.

Returns: true, if GI flag is set

◆ GetIntgPd()

UInt32 IEC61850.Client.ReportControlBlock.GetIntgPd ( )

Gets the integrity period.

Returns: integrity period in ms

◆ GetObjectReference()

string IEC61850.Client.ReportControlBlock.GetObjectReference ( )

◆ GetOptFlds()

ReportOptions IEC61850.Client.ReportControlBlock.GetOptFlds ( )

Gets the option fields.

Returns: The option fields

◆ GetOwner()

byte[] IEC61850.Client.ReportControlBlock.GetOwner ( )

Gets the current owner of the RCB.

Returns: The owner information, or null when no owner information is available.

◆ GetPurgeBuf()

bool IEC61850.Client.ReportControlBlock.GetPurgeBuf ( )

Get the purgeBuf flag of the report control block.

Returns: the prugeBuf value

◆ GetRCBValues()

void IEC61850.Client.ReportControlBlock.GetRCBValues ( )

Read all RCB values from the server.

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

◆ GetRCBValuesAsync()

UInt32 IEC61850.Client.ReportControlBlock.GetRCBValuesAsync	(	GetRCBValuesHandler	handler,
		object	parameter )

Read all RCB values from the server - asynchronous version.

Returns: the invoke ID of the request

Parameters

handler	user provided callback function
parameter	user provided callback parameter

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

◆ GetResv()

bool IEC61850.Client.ReportControlBlock.GetResv ( )

Check if RCB is reserved by a client.

Returns: true, the RCB is reserver by a client

◆ GetResvTms()

Int16 IEC61850.Client.ReportControlBlock.GetResvTms ( )

Gets the ResvTms (reservation time) value.

Only for BRCB. Value of -1 indicate the BRCB is exclusively reserved for a set of client based upon configuration. Value of 0 means that the BRCB is not reserved. Positive value indicates that the BRCB is reserved dynamically and the value is the number of seconds for reservation after association loss.

Returns: The reservation time

◆ GetRptEna()

bool IEC61850.Client.ReportControlBlock.GetRptEna ( )

Check if reporting is currently enabled.

Returns: true, if reporting is enabled, false otherwise

◆ GetRptId()

string IEC61850.Client.ReportControlBlock.GetRptId ( )

Gets the report identifier.

Returns: The report identifier.

◆ GetTrgOps()

TriggerOptions IEC61850.Client.ReportControlBlock.GetTrgOps ( )

Gets the trigger options of the RCB.

Returns: trigger options

◆ HasResvTms()

bool IEC61850.Client.ReportControlBlock.HasResvTms ( )

Check if the report control block has the "ResvTms" attribute.

Returns: true, if ResvTms is available, false otherwise.

◆ InstallReportHandler()

void IEC61850.Client.ReportControlBlock.InstallReportHandler	(	ReportHandler	reportHandler,
		object	parameter )

Installs the report handler.

This will install a callback handler (delegate) that is invoked whenever a report related to this RCB is received. Any call of this method will replace an previously registered handler!

Parameters

reportHandler	report handler
parameter	parameter is passed to the handler when the handler is invoked.

◆ IsBuffered()

bool IEC61850.Client.ReportControlBlock.IsBuffered ( )

Determines whether this instance is a buffered or unbuffered RCB.

Returns: true if this instance is a buffered RCB; otherwise, false.

◆ SetBufTm()

void IEC61850.Client.ReportControlBlock.SetBufTm ( UInt32 bufTm )

Sets the buffer time.

Parameters

bufTm Buffer time is ms.

◆ SetDataSetReference()

void IEC61850.Client.ReportControlBlock.SetDataSetReference ( string dataSetReference )

Sets the data set reference. Use this method to select the associated data set for the RCB.

Returns: The data set reference.

◆ SetEntryID()

void IEC61850.Client.ReportControlBlock.SetEntryID ( byte[] entryId )

◆ SetGI()

void IEC61850.Client.ReportControlBlock.SetGI ( bool GI )

Sets the GI flag. Use this to trigger a GI (general interrogation) command.

Parameters

GI	request general interrogation of true

◆ SetIntgPd()

void IEC61850.Client.ReportControlBlock.SetIntgPd ( UInt32 intgPd )

Sets the integrity period.

Parameters

intgPd integrity period in ms

◆ SetOptFlds()

void IEC61850.Client.ReportControlBlock.SetOptFlds ( ReportOptions optFlds )

Sets the option field. Used to enable or disable optional report elements.

Parameters

optFlds Option field.

◆ SetPurgeBuf()

void IEC61850.Client.ReportControlBlock.SetPurgeBuf ( bool purgeBuf )

Set the purgeBuf flag of the report control block.

This is only for buffered RCBs. If set to true the report buffer of a buffered RCB will be cleaned.

Parameters

purgeBuf set to true to flush report buffer

◆ SetRCBValues() [1/2]

void IEC61850.Client.ReportControlBlock.SetRCBValues ( )

Write changed RCB values to the server.

This function will only write the RCB values that were set by one of the setter methods. The RCB values are sent by a single MMS write request.

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

◆ SetRCBValues() [2/2]

void IEC61850.Client.ReportControlBlock.SetRCBValues ( bool singleRequest )

Write changed RCB values to the server.

This function will only write the RCB values that were set by one of the setter methods.

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

Parameters

singleRequest If true the values are sent by single MMS write request. Otherwise the values are all sent by their own MMS write requests.

◆ SetRCBValuesAsync() [1/2]

UInt32 IEC61850.Client.ReportControlBlock.SetRCBValuesAsync	(	bool	singleRequest,
		SetRCBValuesHandler	handler,
		object	parameter )

◆ SetRCBValuesAsync() [2/2]

UInt32 IEC61850.Client.ReportControlBlock.SetRCBValuesAsync	(	SetRCBValuesHandler	handler,
		object	parameter )

◆ SetResv()

void IEC61850.Client.ReportControlBlock.SetResv ( bool resv )

Sets RESV flag. Use this to reserve (allocate) this RCB.

Parameters

resv	true: reserver this RCB for exclusive use

◆ SetResvTms()

void IEC61850.Client.ReportControlBlock.SetResvTms ( Int16 resvTms )

Sets the ResvTms (reservation time) value.

Parameters

resvTms the reservation time value

◆ SetRptEna()

void IEC61850.Client.ReportControlBlock.SetRptEna ( bool rptEna )

Sets report enable flag. Use this to enable reporting.

Parameters

rptEna true to enable reporting, false to disable

◆ SetRptId()

void IEC61850.Client.ReportControlBlock.SetRptId ( string rptId )

Sets the RptId (report ID) of the RCB.

Parameters

rptId The new RptId

◆ SetTrgOps()

void IEC61850.Client.ReportControlBlock.SetTrgOps ( TriggerOptions trgOps )

Sets the trigger options of the RCB.

Parameters

trgOps trigger options

The documentation for this class was generated from the following file:

C:/Users/MaxsonRamonDosAnjosM/workspace/libraries/libiec61850/dotnet/IEC61850forCSharp/ReportControlBlock.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ Dispose()

◆ GetBufTm()

◆ GetConfRev()

◆ GetDataSetReference()

◆ GetEntryID()

◆ GetEntryTime()

◆ GetEntryTimeAsDateTimeOffset()

◆ GetGI()

◆ GetIntgPd()

◆ GetObjectReference()

◆ GetOptFlds()

◆ GetOwner()

◆ GetPurgeBuf()

◆ GetRCBValues()

◆ GetRCBValuesAsync()

◆ GetResv()

◆ GetResvTms()

◆ GetRptEna()

◆ GetRptId()

◆ GetTrgOps()

◆ HasResvTms()

◆ InstallReportHandler()

◆ IsBuffered()

◆ SetBufTm()

◆ SetDataSetReference()

◆ SetEntryID()

◆ SetGI()

◆ SetIntgPd()

◆ SetOptFlds()

◆ SetPurgeBuf()

◆ SetRCBValues() [1/2]

◆ SetRCBValues() [2/2]

◆ SetRCBValuesAsync() [1/2]

◆ SetRCBValuesAsync() [2/2]

◆ SetResv()

◆ SetResvTms()

◆ SetRptEna()

◆ SetRptId()

◆ SetTrgOps()