dnp3.IOutstationApplication Interface Reference

Dynamic information required by the outstation from the user application More...

Public Member Functions
ushort	GetProcessingDelayMs ()
	Returns the DELAY_MEASUREMENT delay More...
WriteTimeResult	WriteAbsoluteTime (ulong time)
	Handle a write of the absolute time during time synchronization procedures. More...
ApplicationIin	GetApplicationIin ()
	Returns the application-controlled IIN bits More...
RestartDelay	ColdRestart ()
	Request that the outstation perform a cold restart (IEEE-1815 2012, p. 58) More...
RestartDelay	WarmRestart ()
	Request that the outstation perform a warm restart (IEEE-1815 2012, p. 58) More...
FreezeResult	FreezeCountersAll (FreezeType freezeType, Database database)
	Freeze all the counters More...
FreezeResult	FreezeCountersRange (ushort start, ushort stop, FreezeType freezeType, Database database)
	Freeze a range of counters More...

Detailed Description

Dynamic information required by the outstation from the user application

Member Function Documentation

ColdRestart()

RestartDelay dnp3.IOutstationApplication.ColdRestart

(

)

Request that the outstation perform a cold restart (IEEE-1815 2012, p. 58)

The outstation will not automatically restart. It is the responsibility of the user application to handle this request and take the appropriate action.

Returns

The restart delay

FreezeCountersAll()

FreezeResult dnp3.IOutstationApplication.FreezeCountersAll	(	FreezeType	freezeType,
		Database	database
	)

Freeze all the counters

Parameters

freezeType	Type of freeze operation
database	Database

Returns

Result of the freeze operation

FreezeCountersRange()

FreezeResult dnp3.IOutstationApplication.FreezeCountersRange	(	ushort	start,
		ushort	stop,
		FreezeType	freezeType,
		Database	database
	)

Freeze a range of counters

Parameters

start	Start index to freeze (inclusive)
stop	Stop index to freeze (inclusive)
freezeType	Type of freeze operation
database	Database

Returns

Result of the freeze operation

GetApplicationIin()

ApplicationIin dnp3.IOutstationApplication.GetApplicationIin

(

)

Returns the application-controlled IIN bits

Returns

Application IIN bits

GetProcessingDelayMs()

ushort dnp3.IOutstationApplication.GetProcessingDelayMs

(

)

Returns the DELAY_MEASUREMENT delay

The value returned by this method is used in conjunction with the DELAY_MEASUREMENT function code and returned in a g52v2 time delay object as part of a non-LAN time synchronization procedure.

It represents the processing delay from receiving the request to sending the response. This parameter should almost always use the default value of zero as only an RTOS or bare metal system would have access to this level of timing. Modern hardware can almost always respond in less than 1 millisecond anyway.

For more information, see IEEE-1815 2012, p. 64.

Returns

Processing delay, in milliseconds

WarmRestart()

RestartDelay dnp3.IOutstationApplication.WarmRestart

(

)

Request that the outstation perform a warm restart (IEEE-1815 2012, p. 58)

The outstation will not automatically restart. It is the responsibility of the user application to handle this request and take the appropriate action.

Returns

The restart delay

WriteAbsoluteTime()

WriteTimeResult dnp3.IOutstationApplication.WriteAbsoluteTime

(

ulong

time

)

Handle a write of the absolute time during time synchronization procedures.

Parameters

time	Received time in milliseconds since EPOCH (only 48 bits are used)

Returns

Result of the write time operation

---

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

• IOutstationApplication.cs