rodbus.Database Class Reference

Class used to add, remove, update, and retrieve values More...

Public Member Functions
bool	AddCoil (ushort index, bool value)
	Add a new coil to the database More...
bool	AddDiscreteInput (ushort index, bool value)
	Add a new discrete input to the database More...
bool	AddHoldingRegister (ushort index, ushort value)
	Add a new holding register to the database More...
bool	AddInputRegister (ushort index, ushort value)
	Add a new input register to the database More...
bool	GetCoil (ushort index)
	Get the current coil value of the database More...
bool	GetDiscreteInput (ushort index)
	Get the current discrete input value of the database More...
ushort	GetHoldingRegister (ushort index)
	Get the current holding register value of the database More...
ushort	GetInputRegister (ushort index)
	Get the current input register value of the database More...
bool	UpdateCoil (ushort index, bool value)
	Update the current value of a coil in the database More...
bool	UpdateDiscreteInput (ushort index, bool value)
	Update the current value of a discrete input in the database More...
bool	UpdateHoldingRegister (ushort index, ushort value)
	Update the current value of a holding register in the database More...
bool	UpdateInputRegister (ushort index, ushort value)
	Update the current value of a input register in the database More...
bool	DeleteCoil (ushort index)
	Remove a coil address from the database More...
bool	DeleteDiscreteInput (ushort index)
	Remove a discrete input address from the database More...
bool	DeleteHoldingRegister (ushort index)
	Remove a holding register address from the database More...
bool	DeleteInputRegister (ushort index)
	Remove a input register address from the database More...

Detailed Description

Class used to add, remove, update, and retrieve values

Member Function Documentation

AddCoil()

bool rodbus.Database.AddCoil ( ushort  index, bool  value  )

inline

Add a new coil to the database

Parameters

index	Address of the coil
value	Initial value of the coil

Returns

true if the value is new, false otherwise

AddDiscreteInput()

bool rodbus.Database.AddDiscreteInput ( ushort  index, bool  value  )

inline

Add a new discrete input to the database

Parameters

index	Address of the discrete input
value	Initial value of the discrete input

Returns

true if the value is new, false otherwise

AddHoldingRegister()

bool rodbus.Database.AddHoldingRegister ( ushort  index, ushort  value  )

inline

Add a new holding register to the database

Parameters

index	Address of the holding register
value	Initial value of the holding register

Returns

true if the value is new, false otherwise

AddInputRegister()

bool rodbus.Database.AddInputRegister ( ushort  index, ushort  value  )

inline

Add a new input register to the database

Parameters

index	Address of the input register
value	Initial value of the input register

Returns

true if the value is new, false otherwise

DeleteCoil()

bool rodbus.Database.DeleteCoil ( ushort  index )

inline

Remove a coil address from the database

Parameters

index

Address of the coil

Returns

true if the value is new, false otherwise

DeleteDiscreteInput()

bool rodbus.Database.DeleteDiscreteInput ( ushort  index )

inline

Remove a discrete input address from the database

Parameters

index

Address of the discrete input

Returns

true if the value is new, false otherwise

DeleteHoldingRegister()

bool rodbus.Database.DeleteHoldingRegister ( ushort  index )

inline

Remove a holding register address from the database

Parameters

index

Address of the holding register

Returns

true if the value is new, false otherwise

DeleteInputRegister()

bool rodbus.Database.DeleteInputRegister ( ushort  index )

inline

Remove a input register address from the database

Parameters

index

Address of the input register

Returns

true if the value is new, false otherwise

GetCoil()

bool rodbus.Database.GetCoil ( ushort  index )

inline

Get the current coil value of the database

Parameters

index

Address of the coil

Returns

Current value of the point

Exceptions

ParamException

GetDiscreteInput()

bool rodbus.Database.GetDiscreteInput ( ushort  index )

inline

Get the current discrete input value of the database

Parameters

index

Address of the discrete input

Returns

Current value of the point

Exceptions

ParamException

GetHoldingRegister()

ushort rodbus.Database.GetHoldingRegister ( ushort  index )

inline

Get the current holding register value of the database

Parameters

index

Address of the holding register

Returns

Current value of the point

Exceptions

ParamException

GetInputRegister()

ushort rodbus.Database.GetInputRegister ( ushort  index )

inline

Get the current input register value of the database

Parameters

index

Address of the input register

Returns

Current value of the point

Exceptions

ParamException

UpdateCoil()

bool rodbus.Database.UpdateCoil ( ushort  index, bool  value  )

inline

Update the current value of a coil in the database

Parameters

index	Address of the coil
value	New value of the coil

Returns

true if the address is defined, false otherwise

UpdateDiscreteInput()

bool rodbus.Database.UpdateDiscreteInput ( ushort  index, bool  value  )

inline

Update the current value of a discrete input in the database

Parameters

index	Address of the discrete input
value	New value of the discrete input

Returns

true if the address is defined, false otherwise

UpdateHoldingRegister()

bool rodbus.Database.UpdateHoldingRegister ( ushort  index, ushort  value  )

inline

Update the current value of a holding register in the database

Parameters

index	Address of the holding register
value	New value of the holding register

Returns

true if the address is defined, false otherwise

UpdateInputRegister()

bool rodbus.Database.UpdateInputRegister ( ushort  index, ushort  value  )

inline

Update the current value of a input register in the database

Parameters

index	Address of the input register
value	New value of the input register

Returns

true if the address is defined, false otherwise

---

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

• Database.cs