Internal database access More...

Public Member Functions
bool	AddBinaryInput (ushort index, EventClass pointClass, BinaryInputConfig config)
	Add a new BinaryInput point More...

bool	RemoveBinaryInput (ushort index)
	Remove a BinaryInput point More...

bool	UpdateBinaryInput (BinaryInput value, UpdateOptions options)
	Update a BinaryInput point More...

UpdateInfo	UpdateBinaryInput2 (BinaryInput value, UpdateOptions options)
	Update a BinaryInput point More...

BinaryInput	GetBinaryInput (ushort index)
	Get a BinaryInput point More...

bool	AddDoubleBitBinaryInput (ushort index, EventClass pointClass, DoubleBitBinaryInputConfig config)
	Add a new Double-Bit Binary Input point More...

bool	RemoveDoubleBitBinaryInput (ushort index)
	Remove a Double-Bit Binary Input point More...

bool	UpdateDoubleBitBinaryInput (DoubleBitBinaryInput value, UpdateOptions options)
	Update a Double-Bit Binary Input point More...

UpdateInfo	UpdateDoubleBitBinaryInput2 (DoubleBitBinaryInput value, UpdateOptions options)
	Update a Double-Bit Binary Input point More...

DoubleBitBinaryInput	GetDoubleBitBinaryInput (ushort index)
	Get a Double-Bit Binary Input point More...

bool	AddBinaryOutputStatus (ushort index, EventClass pointClass, BinaryOutputStatusConfig config)
	Add a new Binary Output Status point More...

bool	RemoveBinaryOutputStatus (ushort index)
	Remove a Binary Output Status point More...

bool	UpdateBinaryOutputStatus (BinaryOutputStatus value, UpdateOptions options)
	Update a Binary Output Status point More...

UpdateInfo	UpdateBinaryOutputStatus2 (BinaryOutputStatus value, UpdateOptions options)
	Update a Binary Output Status point More...

BinaryOutputStatus	GetBinaryOutputStatus (ushort index)
	Get a Binary Output Status point More...

bool	AddCounter (ushort index, EventClass pointClass, CounterConfig config)
	Add a new Counter point More...

bool	RemoveCounter (ushort index)
	Remove a Counter point More...

bool	UpdateCounter (Counter value, UpdateOptions options)
	Update a Counter point More...

UpdateInfo	UpdateCounter2 (Counter value, UpdateOptions options)
	Update a Counter point More...

Counter	GetCounter (ushort index)
	Get a Counter point More...

bool	AddFrozenCounter (ushort index, EventClass pointClass, FrozenCounterConfig config)
	Add a new Frozen Counter point More...

bool	RemoveFrozenCounter (ushort index)
	Remove a Frozen Counter point More...

bool	UpdateFrozenCounter (FrozenCounter value, UpdateOptions options)
	Update an Frozen Counter point More...

UpdateInfo	UpdateFrozenCounter2 (FrozenCounter value, UpdateOptions options)
	Update an Frozen Counter point More...

FrozenCounter	GetFrozenCounter (ushort index)
	Get a Frozen Counter point More...

bool	AddAnalogInput (ushort index, EventClass pointClass, AnalogInputConfig config)
	Add a new AnalogInput point More...

bool	RemoveAnalogInput (ushort index)
	Remove an AnalogInput point More...

bool	UpdateAnalogInput (AnalogInput value, UpdateOptions options)
	Update a AnalogInput point More...

UpdateInfo	UpdateAnalogInput2 (AnalogInput value, UpdateOptions options)
	Update a AnalogInput point More...

AnalogInput	GetAnalogInput (ushort index)
	Get a AnalogInput point More...

bool	AddAnalogOutputStatus (ushort index, EventClass pointClass, AnalogOutputStatusConfig config)
	Add a new Analog Output Status point More...

bool	RemoveAnalogOutputStatus (ushort index)
	Remove an Analog Output Status point More...

bool	UpdateAnalogOutputStatus (AnalogOutputStatus value, UpdateOptions options)
	Update a Analog Output Status point More...

UpdateInfo	UpdateAnalogOutputStatus2 (AnalogOutputStatus value, UpdateOptions options)
	Update a Analog Output Status point More...

AnalogOutputStatus	GetAnalogOutputStatus (ushort index)
	Get a Analog Output Status point More...

bool	AddOctetString (ushort index, EventClass pointClass)
	Add a new Octet String point More...

bool	RemoveOctetString (ushort index)
	Remove an Octet String point More...

bool	UpdateOctetString (ushort index, System.Collections.Generic.ICollection< byte > value, UpdateOptions options)
	Update an Octet String point More...

UpdateInfo	UpdateOctetString2 (ushort index, System.Collections.Generic.ICollection< byte > value, UpdateOptions options)
	Update an Octet String point More...

AttrDefError	DefineStringAttr (byte set, bool writable, byte variation, string value)
	Define a string attribute More...

AttrDefError	DefineIntAttr (byte set, bool writable, byte variation, int value)
	Define a signed integer attribute More...

AttrDefError	DefineUintAttr (byte set, bool writable, byte variation, uint value)
	Define an unsigned integer attribute More...

AttrDefError	DefineTimeAttr (byte set, bool writable, byte variation, ulong value)
	Define a DNP3 time attribute More...

AttrDefError	DefineBoolAttr (byte set, bool writable, byte variation, bool value)
	Define a boolean attribute which is mapped to an unsigned integer internally More...

AttrDefError	DefineFloatAttr (byte set, bool writable, byte variation, float value)
	Define a 32-bit floating point attribute More...

AttrDefError	DefineDoubleAttr (byte set, bool writable, byte variation, double value)
	Define a 64-bit floating point attribute More...

Detailed Description

Internal database access

Warning: This object is only valid within a transaction

Member Function Documentation

◆ AddAnalogInput()

bool dnp3.Database.AddAnalogInput	(	ushort	index,
		EventClass	pointClass,
		AnalogInputConfig	config
	)

inline

Add a new AnalogInput point

Parameters

index	Index of the point
pointClass	Event class
config	Configuration

Returns: True if the point was successfully added, false otherwise

◆ AddAnalogOutputStatus()

bool dnp3.Database.AddAnalogOutputStatus	(	ushort	index,
		EventClass	pointClass,
		AnalogOutputStatusConfig	config
	)

inline

Add a new Analog Output Status point

Parameters

index	Index of the point
pointClass	Event class
config	Configuration

Returns: True if the point was successfully added, false otherwise

◆ AddBinaryInput()

bool dnp3.Database.AddBinaryInput	(	ushort	index,
		EventClass	pointClass,
		BinaryInputConfig	config
	)

inline

Add a new BinaryInput point

Parameters

index	Index of the point
pointClass	Event class
config	Configuration

Returns: True if the point was successfully added, false otherwise

◆ AddBinaryOutputStatus()

bool dnp3.Database.AddBinaryOutputStatus	(	ushort	index,
		EventClass	pointClass,
		BinaryOutputStatusConfig	config
	)

inline

Add a new Binary Output Status point

Parameters

index	Index of the point
pointClass	Event class
config	Configuration

Returns: True if the point was successfully added, false otherwise

◆ AddCounter()

bool dnp3.Database.AddCounter	(	ushort	index,
		EventClass	pointClass,
		CounterConfig	config
	)

inline

Add a new Counter point

Parameters

index	Index of the point
pointClass	Event class
config	Configuration

Returns: True if the point was successfully added, false otherwise

◆ AddDoubleBitBinaryInput()

bool dnp3.Database.AddDoubleBitBinaryInput	(	ushort	index,
		EventClass	pointClass,
		DoubleBitBinaryInputConfig	config
	)

inline

Add a new Double-Bit Binary Input point

Parameters

index	Index of the point
pointClass	Event class
config	Configuration

Returns: True if the point was successfully added, false otherwise

◆ AddFrozenCounter()

bool dnp3.Database.AddFrozenCounter	(	ushort	index,
		EventClass	pointClass,
		FrozenCounterConfig	config
	)

inline

Add a new Frozen Counter point

Parameters

index	Index of the point
pointClass	Event class
config	Configuration

Returns: True if the point was successfully added, false otherwise

◆ AddOctetString()

bool dnp3.Database.AddOctetString	(	ushort	index,
		EventClass	pointClass
	)

inline

Add a new Octet String point

Parameters

index	Index of the point
pointClass	Event class

Returns: True if the point was successfully added, false otherwise

◆ DefineBoolAttr()

AttrDefError dnp3.Database.DefineBoolAttr	(	byte	set,
		bool	writable,
		byte	variation,
		bool	value
	)

inline

Define a boolean attribute which is mapped to an unsigned integer internally

Parameters

set	The set to which the attribute belongs
writable	True if the attribute may be written
variation	The variation of the attribute
value	The value of the attribute

Returns: Enumeration indicating if the operation was successful

◆ DefineDoubleAttr()

AttrDefError dnp3.Database.DefineDoubleAttr	(	byte	set,
		bool	writable,
		byte	variation,
		double	value
	)

inline

Define a 64-bit floating point attribute

Parameters

set	The set to which the attribute belongs
writable	True if the attribute may be written
variation	The variation of the attribute
value	The value of the attribute

Returns: Enumeration indicating if the operation was successful

◆ DefineFloatAttr()

AttrDefError dnp3.Database.DefineFloatAttr	(	byte	set,
		bool	writable,
		byte	variation,
		float	value
	)

inline

Define a 32-bit floating point attribute

Parameters

set	The set to which the attribute belongs
writable	True if the attribute may be written
variation	The variation of the attribute
value	The value of the attribute

Returns: Enumeration indicating if the operation was successful

◆ DefineIntAttr()

AttrDefError dnp3.Database.DefineIntAttr	(	byte	set,
		bool	writable,
		byte	variation,
		int	value
	)

inline

Define a signed integer attribute

Parameters

set	The set to which the attribute belongs
writable	True if the attribute may be written
variation	The variation of the attribute
value	The value of the attribute

Returns: Enumeration indicating if the operation was successful

◆ DefineStringAttr()

AttrDefError dnp3.Database.DefineStringAttr	(	byte	set,
		bool	writable,
		byte	variation,
		string	value
	)

inline

Define a string attribute

Parameters

set	The set to which the attribute belongs
writable	True if the attribute may be written
variation	The variation of the attribute
value	The value of the attribute

Returns: Enumeration indicating if the operation was successful

◆ DefineTimeAttr()

AttrDefError dnp3.Database.DefineTimeAttr	(	byte	set,
		bool	writable,
		byte	variation,
		ulong	value
	)

inline

Define a DNP3 time attribute

Parameters

set	The set to which the attribute belongs
writable	True if the attribute may be written
variation	The variation of the attribute
value	The DNP3 timestamp value of the attribute. Only the lower 48-bits are used.

Returns: Enumeration indicating if the operation was successful

◆ DefineUintAttr()

AttrDefError dnp3.Database.DefineUintAttr	(	byte	set,
		bool	writable,
		byte	variation,
		uint	value
	)

inline

Define an unsigned integer attribute

Parameters

set	The set to which the attribute belongs
writable	True if the attribute may be written
variation	The variation of the attribute
value	The value of the attribute

Returns: Enumeration indicating if the operation was successful

◆ GetAnalogInput()

AnalogInput dnp3.Database.GetAnalogInput ( ushort index )

inline

Get a AnalogInput point

Parameters

index Index of the point to get

Returns: Analog point

Exceptions

ParamException

◆ GetAnalogOutputStatus()

AnalogOutputStatus dnp3.Database.GetAnalogOutputStatus ( ushort index )

inline

Get a Analog Output Status point

Parameters

index Index of the point to get

Returns: Analog Output Status point

Exceptions

ParamException

◆ GetBinaryInput()

BinaryInput dnp3.Database.GetBinaryInput ( ushort index )

inline

Get a BinaryInput point

Parameters

index Index of the point to get

Returns: Binary Input point

Exceptions

ParamException

◆ GetBinaryOutputStatus()

BinaryOutputStatus dnp3.Database.GetBinaryOutputStatus ( ushort index )

inline

Get a Binary Output Status point

Parameters

index Index of the point to get

Returns: Binary Output Status point

Exceptions

ParamException

◆ GetCounter()

Counter dnp3.Database.GetCounter ( ushort index )

inline

Get a Counter point

Parameters

index Index of the point to get

Returns: Counter point

Exceptions

ParamException

◆ GetDoubleBitBinaryInput()

DoubleBitBinaryInput dnp3.Database.GetDoubleBitBinaryInput ( ushort index )

inline

Get a Double-Bit Binary Input point

Parameters

index Index of the point to get

Returns: Double-Bit Binary Input point

Exceptions

ParamException

◆ GetFrozenCounter()

FrozenCounter dnp3.Database.GetFrozenCounter ( ushort index )

inline

Get a Frozen Counter point

Parameters

index Index of the point to get

Returns: Frozen Counter point

Exceptions

ParamException

◆ RemoveAnalogInput()

bool dnp3.Database.RemoveAnalogInput ( ushort index )

inline

Remove an AnalogInput point

Parameters

index Index of the point

Returns: True if the point was successfully removed, false otherwise

◆ RemoveAnalogOutputStatus()

bool dnp3.Database.RemoveAnalogOutputStatus ( ushort index )

inline

Remove an Analog Output Status point

Parameters

index Index of the point

Returns: True if the point was successfully removed, false otherwise

◆ RemoveBinaryInput()

bool dnp3.Database.RemoveBinaryInput ( ushort index )

inline

Remove a BinaryInput point

Parameters

index Index of the point

Returns: True if the point was successfully removed, false otherwise

◆ RemoveBinaryOutputStatus()

bool dnp3.Database.RemoveBinaryOutputStatus ( ushort index )

inline

Remove a Binary Output Status point

Parameters

index Index of the point

Returns: True if the point was successfully removed, false otherwise

◆ RemoveCounter()

bool dnp3.Database.RemoveCounter ( ushort index )

inline

Remove a Counter point

Parameters

index Index of the point

Returns: True if the point was successfully removed, false otherwise

◆ RemoveDoubleBitBinaryInput()

bool dnp3.Database.RemoveDoubleBitBinaryInput ( ushort index )

inline

Remove a Double-Bit Binary Input point

Parameters

index Index of the point

Returns: True if the point was successfully removed, false otherwise

◆ RemoveFrozenCounter()

bool dnp3.Database.RemoveFrozenCounter ( ushort index )

inline

Remove a Frozen Counter point

Parameters

index Index of the point

Returns: True if the point was successfully removed, false otherwise

◆ RemoveOctetString()

bool dnp3.Database.RemoveOctetString ( ushort index )

inline

Remove an Octet String point

Parameters

index Index of the point

Returns: True if the point was successfully removed, false otherwise

◆ UpdateAnalogInput()

bool dnp3.Database.UpdateAnalogInput	(	AnalogInput	value,
		UpdateOptions	options
	)

inline

Update a AnalogInput point

Parameters

value	New value of the point
options	Update options

Returns: True if the point was successfully updated, false otherwise

◆ UpdateAnalogInput2()

UpdateInfo dnp3.Database.UpdateAnalogInput2	(	AnalogInput	value,
		UpdateOptions	options
	)

inline

Update a AnalogInput point

Parameters

value	New value of the point
options	Update options

Returns: Provides detailed information about what occurred during the update operation

◆ UpdateAnalogOutputStatus()

bool dnp3.Database.UpdateAnalogOutputStatus	(	AnalogOutputStatus	value,
		UpdateOptions	options
	)

inline

Update a Analog Output Status point

Parameters

value	New value of the point
options	Update options

Returns: True if the point was successfully updated, false otherwise

◆ UpdateAnalogOutputStatus2()

UpdateInfo dnp3.Database.UpdateAnalogOutputStatus2	(	AnalogOutputStatus	value,
		UpdateOptions	options
	)

inline

Update a Analog Output Status point

Parameters

value	New value of the point
options	Update options

Returns: Provides detailed information about what occurred during the update operation

◆ UpdateBinaryInput()

bool dnp3.Database.UpdateBinaryInput	(	BinaryInput	value,
		UpdateOptions	options
	)

inline

Update a BinaryInput point

Parameters

value	New value of the point
options	Update options

Returns: True if the point was successfully updated, false otherwise

◆ UpdateBinaryInput2()

UpdateInfo dnp3.Database.UpdateBinaryInput2	(	BinaryInput	value,
		UpdateOptions	options
	)

inline

Update a BinaryInput point

Parameters

value	New value of the point
options	Update options

Returns: Provides detailed information about what occurred during the update operation

◆ UpdateBinaryOutputStatus()

bool dnp3.Database.UpdateBinaryOutputStatus	(	BinaryOutputStatus	value,
		UpdateOptions	options
	)

inline

Update a Binary Output Status point

Parameters

value	New value of the point
options	Update options

Returns: True if the point was successfully updated, false otherwise

◆ UpdateBinaryOutputStatus2()

UpdateInfo dnp3.Database.UpdateBinaryOutputStatus2	(	BinaryOutputStatus	value,
		UpdateOptions	options
	)

inline

Update a Binary Output Status point

Parameters

value	New value of the point
options	Update options

Returns: Provides detailed information about what occurred during the update operation

◆ UpdateCounter()

bool dnp3.Database.UpdateCounter	(	Counter	value,
		UpdateOptions	options
	)

inline

Update a Counter point

Parameters

value	New value of the point
options	Update options

Returns: True if the point was successfully updated, false otherwise

◆ UpdateCounter2()

UpdateInfo dnp3.Database.UpdateCounter2	(	Counter	value,
		UpdateOptions	options
	)

inline

Update a Counter point

Parameters

value	New value of the point
options	Update options

Returns: Provides detailed information about what occurred during the update operation

◆ UpdateDoubleBitBinaryInput()

bool dnp3.Database.UpdateDoubleBitBinaryInput	(	DoubleBitBinaryInput	value,
		UpdateOptions	options
	)

inline

Update a Double-Bit Binary Input point

Parameters

value	New value of the point
options	Update options

Returns: True if the point was successfully updated, false otherwise

◆ UpdateDoubleBitBinaryInput2()

UpdateInfo dnp3.Database.UpdateDoubleBitBinaryInput2	(	DoubleBitBinaryInput	value,
		UpdateOptions	options
	)

inline

Update a Double-Bit Binary Input point

Parameters

value	New value of the point
options	Update options

Returns: Provides detailed information about what occurred during the update operation

◆ UpdateFrozenCounter()

bool dnp3.Database.UpdateFrozenCounter	(	FrozenCounter	value,
		UpdateOptions	options
	)

inline

Update an Frozen Counter point

Parameters

value	New value of the point
options	Update options

Returns: True if the point was successfully updated, false otherwise

◆ UpdateFrozenCounter2()

UpdateInfo dnp3.Database.UpdateFrozenCounter2	(	FrozenCounter	value,
		UpdateOptions	options
	)

inline

Update an Frozen Counter point

Parameters

value	New value of the point
options	Update options

Returns: Provides detailed information about what occurred during the update operation

◆ UpdateOctetString()

bool dnp3.Database.UpdateOctetString	(	ushort	index,
		System.Collections.Generic.ICollection< byte >	value,
		UpdateOptions	options
	)

inline

Update an Octet String point

Parameters

index	Index of the octet string
value	New value of the point
options	Update options

Returns: True if the point was successfully updated, false otherwise

◆ UpdateOctetString2()

UpdateInfo dnp3.Database.UpdateOctetString2	(	ushort	index,
		System.Collections.Generic.ICollection< byte >	value,
		UpdateOptions	options
	)

inline

Update an Octet String point

Parameters

index	Index of the octet string
value	New value of the point
options	Update options

Returns: Provides detailed information about what occurred during the update operation

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

Database.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddAnalogInput()

◆ AddAnalogOutputStatus()

◆ AddBinaryInput()

◆ AddBinaryOutputStatus()

◆ AddCounter()

◆ AddDoubleBitBinaryInput()

◆ AddFrozenCounter()

◆ AddOctetString()

◆ DefineBoolAttr()

◆ DefineDoubleAttr()

◆ DefineFloatAttr()

◆ DefineIntAttr()

◆ DefineStringAttr()

◆ DefineTimeAttr()

◆ DefineUintAttr()

◆ GetAnalogInput()

◆ GetAnalogOutputStatus()

◆ GetBinaryInput()

◆ GetBinaryOutputStatus()

◆ GetCounter()

◆ GetDoubleBitBinaryInput()

◆ GetFrozenCounter()

◆ RemoveAnalogInput()

◆ RemoveAnalogOutputStatus()

◆ RemoveBinaryInput()

◆ RemoveBinaryOutputStatus()

◆ RemoveCounter()

◆ RemoveDoubleBitBinaryInput()

◆ RemoveFrozenCounter()

◆ RemoveOctetString()

◆ UpdateAnalogInput()

◆ UpdateAnalogInput2()

◆ UpdateAnalogOutputStatus()

◆ UpdateAnalogOutputStatus2()

◆ UpdateBinaryInput()

◆ UpdateBinaryInput2()

◆ UpdateBinaryOutputStatus()

◆ UpdateBinaryOutputStatus2()

◆ UpdateCounter()

◆ UpdateCounter2()

◆ UpdateDoubleBitBinaryInput()

◆ UpdateDoubleBitBinaryInput2()

◆ UpdateFrozenCounter()

◆ UpdateFrozenCounter2()

◆ UpdateOctetString()

◆ UpdateOctetString2()