dnp3 (.NET API) 1.5.2
Loading...
Searching...
No Matches
dnp3.WriteDeadBandRequest Class Reference

Define a custom request to WRITE analog input dead-bands More...

Public Member Functions

 WriteDeadBandRequest ()
 A builder class to create one or more headers of analog input dead-bands More...
 
void AddG34v1U8 (byte index, ushort deadBand)
 Add a g34v1 (unsigned 16-bit) dead-band with 8-bit indexing to the request More...
 
void AddG34v2U8 (byte index, uint deadBand)
 Add a g34v2 (unsigned 32-bit) dead-band with 8-bit indexing to the request More...
 
void AddG34v3U8 (byte index, float deadBand)
 Add a g34v3 (single-precision floating point) dead-band with 8-bit indexing to the request More...
 
void AddG34v1U16 (ushort index, ushort deadBand)
 Add a g34v1 (unsigned 16-bit) dead-band with 16-bit indexing to the request More...
 
void AddG34v2U16 (ushort index, uint deadBand)
 Add a g34v2 (unsigned 32-bit) dead-band with 16-bit indexing to the request More...
 
void AddG34v3U16 (ushort index, float deadBand)
 Add a g34v3 (single-precision floating point) dead-band with 16-bit indexing to the request More...
 
void FinishHeader ()
 If a header is currently being written, then this will complete the header so that no new objects may be added to it More...
 

Detailed Description

Define a custom request to WRITE analog input dead-bands

Constructor & Destructor Documentation

◆ WriteDeadBandRequest()

dnp3.WriteDeadBandRequest.WriteDeadBandRequest ( )
inline

A builder class to create one or more headers of analog input dead-bands

Member Function Documentation

◆ AddG34v1U16()

void dnp3.WriteDeadBandRequest.AddG34v1U16 ( ushort  index,
ushort  deadBand 
)
inline

Add a g34v1 (unsigned 16-bit) dead-band with 16-bit indexing to the request

If this variation and index are the same as the current header, then it will be added to it. Otherwise, this call we create a new header of this type.d

Parameters
indexIndex of the analog input to which the dead-band applies
deadBandValue of the dead-band

◆ AddG34v1U8()

void dnp3.WriteDeadBandRequest.AddG34v1U8 ( byte  index,
ushort  deadBand 
)
inline

Add a g34v1 (unsigned 16-bit) dead-band with 8-bit indexing to the request

If this variation and index are the same as the current header, then it will be added to it. Otherwise, this call we create a new header of this type.d

Parameters
indexIndex of the analog input to which the dead-band applies
deadBandValue of the dead-band

◆ AddG34v2U16()

void dnp3.WriteDeadBandRequest.AddG34v2U16 ( ushort  index,
uint  deadBand 
)
inline

Add a g34v2 (unsigned 32-bit) dead-band with 16-bit indexing to the request

If this variation and index are the same as the current header, then it will be added to it. Otherwise, this call we create a new header of this type.d

Parameters
indexIndex of the analog input to which the dead-band applies
deadBandValue of the dead-band

◆ AddG34v2U8()

void dnp3.WriteDeadBandRequest.AddG34v2U8 ( byte  index,
uint  deadBand 
)
inline

Add a g34v2 (unsigned 32-bit) dead-band with 8-bit indexing to the request

If this variation and index are the same as the current header, then it will be added to it. Otherwise, this call we create a new header of this type.d

Parameters
indexIndex of the analog input to which the dead-band applies
deadBandValue of the dead-band

◆ AddG34v3U16()

void dnp3.WriteDeadBandRequest.AddG34v3U16 ( ushort  index,
float  deadBand 
)
inline

Add a g34v3 (single-precision floating point) dead-band with 16-bit indexing to the request

If this variation and index are the same as the current header, then it will be added to it. Otherwise, this call we create a new header of this type.d

Parameters
indexIndex of the analog input to which the dead-band applies
deadBandValue of the dead-band

◆ AddG34v3U8()

void dnp3.WriteDeadBandRequest.AddG34v3U8 ( byte  index,
float  deadBand 
)
inline

Add a g34v3 (single-precision floating point) dead-band with 8-bit indexing to the request

If this variation and index are the same as the current header, then it will be added to it. Otherwise, this call we create a new header of this type.d

Parameters
indexIndex of the analog input to which the dead-band applies
deadBandValue of the dead-band

◆ FinishHeader()

void dnp3.WriteDeadBandRequest.FinishHeader ( )
inline

If a header is currently being written, then this will complete the header so that no new objects may be added to it

This happens automatically if you change the type or index when adding dead-band values. This method allows you to fragment the same type across multiple object headers.


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