dnp3.UpdateOptions Class Reference

Options that control how the update is performed. More...

Public Member Functions
UpdateOptions	WithUpdateStatic (bool value)
	Optionally bypass updating the static database (the current value) More...
UpdateOptions	WithEventMode (EventMode value)
	Determines how/if an event is produced More...

Static Public Member Functions
static UpdateOptions	DetectEvent ()
	Default event detection mode. Updates the static value and automatically detects event. More...
static UpdateOptions	NoEvent ()
	Only update the static value. Usefull during initialization of the database. More...

Public Attributes
bool	UpdateStatic
	Optionally bypass updating the static database (the current value) More...
EventMode	EventMode
	Determines how/if an event is produced More...

Detailed Description

Options that control how the update is performed.

99% of the time, the default value should be used.

Member Function Documentation

DetectEvent()

static UpdateOptions dnp3.UpdateOptions.DetectEvent ( )

inlinestatic

Default event detection mode. Updates the static value and automatically detects event.

Default values:

• UpdateOptions.UpdateStatic: true
• UpdateOptions.EventMode: EventMode.Detect

Returns

Initialized UpdateOptions instance

NoEvent()

static UpdateOptions dnp3.UpdateOptions.NoEvent ( )

inlinestatic

Only update the static value. Usefull during initialization of the database.

Default values:

• UpdateOptions.UpdateStatic: true
• UpdateOptions.EventMode: EventMode.Suppress

Returns

Initialized UpdateOptions instance

WithEventMode()

UpdateOptions dnp3.UpdateOptions.WithEventMode ( EventMode  value )

inline

Determines how/if an event is produced

WithUpdateStatic()

UpdateOptions dnp3.UpdateOptions.WithUpdateStatic ( bool  value )

inline

Optionally bypass updating the static database (the current value)

Member Data Documentation

EventMode

EventMode dnp3.UpdateOptions.EventMode

Determines how/if an event is produced

UpdateStatic

bool dnp3.UpdateOptions.UpdateStatic

Optionally bypass updating the static database (the current value)

---

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

• UpdateOptions.cs