Custom request More...

Public Member Functions
	Request ()
	Create a new request More...

void	AddOneByteRangeHeader (Variation variation, byte start, byte stop)
	Add a one-byte start/stop header for use with a READ request More...

void	AddTwoByteRangeHeader (Variation variation, ushort start, ushort stop)
	Add a two-byte start/stop header for use with a READ request More...

void	AddAllObjectsHeader (Variation variation)
	Add an all objects variation request More...

void	AddOneByteLimitedCountHeader (Variation variation, byte count)
	Add a one-byte limited count variation header for use with a READ request More...

void	AddTwoByteLimitedCountHeader (Variation variation, ushort count)
	Add a two-byte limited count variation header for use with a READ request More...

void	AddTimeAndInterval (ulong time, uint intervalMs)
	Add a single g51v1 time-and-interval More...

void	AddSpecificAttribute (byte variation, byte set)
	Add a one-byte start/stop header for use with a READ request More...

void	AddStringAttribute (byte variation, byte set, string value)
	Add a one-byte start/stop header containing for use with a WRITE request More...

void	AddUintAttribute (byte variation, byte set, uint value)
	Add a one-byte start/stop header containing for use with a WRITE request More...

Static Public Member Functions
static Request	ClassRequest (bool class0, bool class1, bool class2, bool class3)
	Create a new request asking for classes More...

static Request	AllObjects (Variation variation)
	Create a new request asking for all objects of a particular variation. More...

static Request	OneByteRange (Variation variation, byte start, byte stop)
	Create a new request asking for range of objects (using 8-bit start/stop). More...

static Request	TwoByteRange (Variation variation, ushort start, ushort stop)
	Create a new request asking for range of objects (using 16-bit start/stop). More...

static Request	OneByteLimitedCount (Variation variation, byte count)
	Create a new request asking for a limited count of objects (using 8-bit start/stop). More...

static Request	TwoByteLimitedCount (Variation variation, ushort count)
	Create a new request asking for a limited count of objects (using 16-bit start/stop). More...

Detailed Description

Custom request

Whenever a method takes a request as a parameter, the request is internally copied. Therefore, it is possible to reuse the same requests over and over.

Constructor & Destructor Documentation

◆ Request()

dnp3.Request.Request ( )

inline

Create a new request

Member Function Documentation

◆ AddAllObjectsHeader()

void dnp3.Request.AddAllObjectsHeader ( Variation variation )

inline

Add an all objects variation request

Parameters

variation Variation to ask for

◆ AddOneByteLimitedCountHeader()

void dnp3.Request.AddOneByteLimitedCountHeader	(	Variation	variation,
		byte	count
	)

inline

Add a one-byte limited count variation header for use with a READ request

Parameters

variation	Variation to ask for
count	Maximum number of events

◆ AddOneByteRangeHeader()

void dnp3.Request.AddOneByteRangeHeader	(	Variation	variation,
		byte	start,
		byte	stop
	)

inline

Add a one-byte start/stop header for use with a READ request

Parameters

variation	Variation to ask for
start	Start index to ask
stop	Stop index to ask (inclusive)

◆ AddSpecificAttribute()

void dnp3.Request.AddSpecificAttribute	(	byte	variation,
		byte	set
	)

inline

Add a one-byte start/stop header for use with a READ request

Parameters

variation	Variation of the device attribute
set	The set (point) to which the attribute belongs

◆ AddStringAttribute()

void dnp3.Request.AddStringAttribute	(	byte	variation,
		byte	set,
		string	value
	)

inline

Add a one-byte start/stop header containing for use with a WRITE request

Parameters

variation	Variation of the attribute
set	The set (point) to which the attribute belongs
value	Value of the attribute

◆ AddTimeAndInterval()

void dnp3.Request.AddTimeAndInterval	(	ulong	time,
		uint	intervalMs
	)

inline

Add a single g51v1 time-and-interval

This is useful when constructing freeze-at-time requests

Parameters

time	DNP3 48-bit timestamp representing count of milliseconds since epoch UTC
intervalMs	Interval expressed in milliseconds

◆ AddTwoByteLimitedCountHeader()

void dnp3.Request.AddTwoByteLimitedCountHeader	(	Variation	variation,
		ushort	count
	)

inline

Add a two-byte limited count variation header for use with a READ request

Parameters

variation	Variation to ask for
count	Maximum number of events

◆ AddTwoByteRangeHeader()

void dnp3.Request.AddTwoByteRangeHeader	(	Variation	variation,
		ushort	start,
		ushort	stop
	)

inline

Add a two-byte start/stop header for use with a READ request

Parameters

variation	Variation to ask for
start	Start index to ask
stop	Stop index to ask (inclusive)

◆ AddUintAttribute()

void dnp3.Request.AddUintAttribute	(	byte	variation,
		byte	set,
		uint	value
	)

inline

Add a one-byte start/stop header containing for use with a WRITE request

Parameters

variation	Variation of the attribute
set	The set (point) to which the attribute belongs
value	Value of the attribute

◆ AllObjects()

static Request dnp3.Request.AllObjects ( Variation variation )

inlinestatic

Create a new request asking for all objects of a particular variation.

An identical request can be created manually with Request.Request() and Request.AddAllObjectsHeader.

Parameters

variation Variation to ask for

Returns: Handle to the created request

◆ ClassRequest()

static Request dnp3.Request.ClassRequest	(	bool	class0,
		bool	class1,
		bool	class2,
		bool	class3
	)

inlinestatic

Create a new request asking for classes

An identical request can be created manually with Request.AddAllObjectsHeader and variations Variation.Group60Var1, Variation.Group60Var2, Variation.Group60Var3 and Variation.Group60Var4.

Parameters

class0	Ask for class 0 (static data)
class1	Ask for class 1 events
class2	Ask for class 2 events
class3	Ask for class 3 events

Returns: Handle to the created request

◆ OneByteLimitedCount()

static Request dnp3.Request.OneByteLimitedCount	(	Variation	variation,
		byte	count
	)

inlinestatic

Create a new request asking for a limited count of objects (using 8-bit start/stop).

An identical request can be created manually with Request.Request() and Request.AddOneByteLimitedCountHeader.

Parameters

variation	Variation to ask for
count	Maximum number of events

Returns: Handle to the created request

◆ OneByteRange()

static Request dnp3.Request.OneByteRange	(	Variation	variation,
		byte	start,
		byte	stop
	)

inlinestatic

Create a new request asking for range of objects (using 8-bit start/stop).

An identical request can be created manually with Request.Request() and Request.AddOneByteRangeHeader.

Parameters

variation	Variation to ask for
start	Start index to ask
stop	Stop index to ask (inclusive)

Returns: Handle to the created request

◆ TwoByteLimitedCount()

static Request dnp3.Request.TwoByteLimitedCount	(	Variation	variation,
		ushort	count
	)

inlinestatic

Create a new request asking for a limited count of objects (using 16-bit start/stop).

An identical request can be created manually with Request.Request() and Request.AddTwoByteLimitedCountHeader.

Parameters

variation	Variation to ask for
count	Maximum number of events

Returns: Handle to the created request

◆ TwoByteRange()

static Request dnp3.Request.TwoByteRange	(	Variation	variation,
		ushort	start,
		ushort	stop
	)

inlinestatic

Create a new request asking for range of objects (using 16-bit start/stop).

An identical request can be created manually with Request.Request() and Request.AddTwoByteRangeHeader.

Parameters

variation	Variation to ask for
start	Start index to ask
stop	Stop index to ask (inclusive)

Returns: Handle to the created request

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

Request.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Request()

Member Function Documentation

◆ AddAllObjectsHeader()

◆ AddOneByteLimitedCountHeader()

◆ AddOneByteRangeHeader()

◆ AddSpecificAttribute()

◆ AddStringAttribute()

◆ AddTimeAndInterval()

◆ AddTwoByteLimitedCountHeader()

◆ AddTwoByteRangeHeader()

◆ AddUintAttribute()

◆ AllObjects()

◆ ClassRequest()

◆ OneByteLimitedCount()

◆ OneByteRange()

◆ TwoByteLimitedCount()

◆ TwoByteRange()