GXDN: Gurux Developer Network
GXDevice Class
NamespacesGurux.DeviceGXDevice
GXDevice is the device that contains the GXProperty instance.
Members
All Members Constructors Methods Properties Events



Icon Member Description
GXDevice()()()
Constructor.

AboutBox()()()
Displays the copyright of the control, user license, and version information, in a dialog box.

AcceptChanges()()()
Commits all the changes made to this IGXProperties collection since it was loaded or since the last time AcceptChanges was called.

ActiveServerConnectionID
Retrieves or sets the Active Server Connection ID.

AllowedMediaTypes
AllowedMediaTypes is the collection of allowed media types. Allowed media types are determined in a device template. With AllowedMediaTypes, each protocol can define, which medias are supported.

AssignDefaultMediaSettings()()()
AssignDefaultMediaSettings assigns default media settings, determined in a device template.

AutoConnect
AutoConnect connects to a device, when a read or a write transaction is executed and the connection is not established. If the connection was opened, it is also closed after the transaction.

AutoConnectAtStartup
AutoConnectAtStartup determines, if the media is opened after it is loaded.

AutoDisconnect
AutoDisconnect determines, if the media is disconnected after transaction.

AvailableReadSpans
Determines available read span types.

BeginUpdate()()()
BeginUpdate maintains performance, when content is updated. Suspends sending of notifications until EndUpdate is called.

Categories
Categories is the collection of categories of the device.

Clone()()()
Creates a new object that is a copy of the current instance.
(Inherited from GXObject.)
Connect()()()
Connect opens a connection to the device.

ConnectionID
Retrieves or sets the Connection ID.

Copy(Object)
The Copy method copies object content from the target object.
(Inherited from GXObject.)
CreateCategory(Int32, Int32, String, String)
CreateCategory creates a new category based on template description.

CreateProperty(Int32, Int32, String, String, GXPropertyCollection)
CreateProperty creates a new property based on template description.

CreateTable(Int32, Int32, String, String)
CreateTable creates a new table based on template description.

Description
Description is the description of a device type.

DeviceID
This property gets/sets the DeviceID.

DeviceList
DeviceList property is a reference of the device list that owns the device.

DeviceType
DeviceType is the type of the device.

Dirty
Gets or sets a value indicating whether the device list has been marked as changed.

DisabledActions
Determines which actions are blocked from use.

Disconnect()()()
Disconnect closes the connection to the device.

Dispose(Boolean) (Overrides GXObject.Dispose(Boolean).)
Dispose()()() (Inherited from GXObject.)
Dynamic
Dynamic determines, if the property is created dynamically using CreateProperty method of the device.

DynamicLifetime
Determines, for how long the device is kept up, after connection is closed.

EnableTransactionProgress
Determines, if the progress of the transaction is shown. Default value is True.

EndUpdate()()()
EndUpdate notifies that the device group content has changed. Resumes sending of notifications.

Equals(Object)
Determines whether two objects are equal.
(Overrides GXObject.Equals(Object).)
ExecuteInitialActions(InitialAction)
Executes all initial property actions of specific type.

Finalize()()() (Inherited from GXObject.)
FindByParameter(String, Object)
Returns collection of objects that match search parameters.
(Inherited from GXObject.)
FindItemByID(UInt64)
FindItemByID finds an item using item identification.

FindProperty(String, String, String, Boolean)
FindProperty returns a GXProperty instance according to string parameters.

GetActiveSchedule()()()
GetActiveSchedule returns the schedule that is active at the moment.

GetChanges()()()
Gets a copy of the IGXProperties collection that contains all changes made to it since it was loaded or since AcceptChanges() was last called.

GetControls()()()
Returns a collection of controls that use this component.
(Inherited from GXObject.)
GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetMediaSettings(String%, String%)
GetMediaSettings gets the configuration of the current media component in XML form.

GetOcx()()()
Retrieves a reference to the underlying ActiveX control.
(Inherited from GXObject.)
GetOwnerGroups()()()
GetOwnerGroups gets device group(s), which the device belongs to. If device is not part of any device list, an empty collection is returned.

GetParametersRecursive(Boolean)
This method gets all parameters from the device, categories, tables and properties.

GetPrivateCategories()()()
GetPrivateCategories returns the private categories collection. This is for inner use only.

GetPropertiesRecursive(Boolean)
GetPropertiesRecursive gets all properties from all categories and tables of the device.

GetScriptParser()()()
GetScriptParser is reserved for inner use. Do not use!

GetStatistic(DeviceStatistic)
Gets statistic value of determined type.

GetTransactionProgress(Object%, Int32%, Int32%, States%)
Gets progress of the current transaction.

GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
GUID
GUID is the Global Unique Identifier of the device.

GXClient
GXClient is the instance that is used by the GXDevice object for the communication.

GXObjectType
Sender object type. Reserved for inner use. Do Not Use!
(Inherited from GXObject.)
ID
Object Identifier.
(Inherited from GXObject.)
IdentificationMode
Used device Identification.

IsActiveServer
Checks if the device is working as active server.

IsDeviceSelected
IsDeviceSelected determines, if the device type is selected using the SelectDevice method.

IsErrorOccurred
Checks, if any errors have occurred in the device.

IsPropertyChanged
Checks, if the user has changes any GXPropertyCollection of the device, after the latest reading.

IsServer()()()
Checks if the GXDevice is working in server mode.

KeepAliveEnabled
Is Keep Alive message enabled.

KeepAliveInterval
Keep Alive interval in ms.

LoadTemplate(Object)
Loads device(s) template files.

LockType
Used lock type.

MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Name (Overrides GXObject.Name.)
Notifies
Notifies if the IsNotify property of a collection of GXPropertyCollection is set to True. The collection is organized into tables and categories.

NotifyCategoryChange(GXCategory, CategoryStates)
NotifyCategoryChange causes the GXDevice object to notify the change of a GXCategory.

NotifyError(String, Int32)
NotifyError notifies a custom error message using this method.

NotifyPropertyChange(GXProperty, Int32, PropertyStates)
NotifyPropertyChange causes the GXDevice object to notify the change of a GXProperty.

NotifyTableChange(GXTable, Int32, TableStates)
NotifyTableChange causes the GXDevice object to notify the change of a GXTable.

NotifyTransactionProgress(Object, Int32, Int32, States, Boolean%)
Notifies the current transaction.

OnBeginUpdate
OnBeginUpdate notifies, when the content of an object is changing.

OnCategoriesClear
This method notifies, when a categories collection is cleared.

OnCategoryAdded
This method notifies, when a category is added to device.

OnCategoryChanged
Notifies, when the content of the category has changed.

OnCategoryRemoved
This method notifies, when a category is removed from device.

OnDeviceStateChanged
OnDeviceStateChanged notifies, if the state of the device has changed.

OnDirty
Notifies, when the device settings are changed.

OnDisplayTypeChanged
OnDisplayTypeChanged notifies, when the display type of property values changes.

OnEndUpdate
OnEndUpdate notifies, when the content of an object has changed.

OnError
OnError sends all occurred errors through here after the connection has been established.

OnItemAdded
This method notifies, when an item is added to the device.

OnItemClear
This method notifies, when the collection is cleared.

OnItemRemoved
This method notifies, when an item is removed from the device.

OnItemUpdated
This method notifies, when an item has changed.

OnPropertiesClear
OnPropertiesClear notifies, when a properties collection is cleared.

OnPropertyAdded
OnPropertyAdded notifies, when a property is added to device.

OnPropertyChanged
OnPropertyChanged notifies, when the state and/or value of a GXProperty has changed.

OnPropertyRemoved
OnPropertyRemoved notifies, when a property is removed from device.

OnReceiveData
OnReceiveData asks client, if it is interested of received data.

OnRowAdded
OnRowAdded notifies, when a new row is added.

OnRowRemoved
OnRowRemoved notifies, when a row is removed.

OnRowsClear
Notifies, when the collection is cleared.

OnRowsResized
OnRowsResized notifies, when row count is resized.

OnTableAdded
This method notifies, when a table is added to the device.

OnTableChanged
Notifies, when content of the table has changed.

OnTableRemoved
This method notifies, when a table is removed from the device.

OnTablesClear
This method notifies, when a tables collection is cleared.

OnTrace
OnTrace traces sent and received data. This method is reserved for inner use. Do not use!

OnTransactionProgress
OnTransactionProgress notifies read and write transactions in the DeviceGroup, Device, Category, Table and Property.

Parameters
Parameters is the collection of parameters of the device.

Parent
Parent property gets the device group, which the device belongs to. If the device is not part of any device group, this value is NULL.

Properties(IWin32Window)
Reserved for future use. Do not use!

Protocol
Returns Media dependent protocol settings.

ProtocolName
ProtocolName is the name of the protocol, if a common protocol(SNMP, Modbus etc.) is used, otherwise NULL.

ReadCategory(Object)
ReadCategory reads values of properties under the specified category.

ReadChanged()()()
ReadChanged reads values of the properties, whose status is ValueChanged (GX_PROPERTY_STATE_VALUE_CHANGED).

ReadErrorValues()()()
ReadErrorValues reads the values of the properties, whose previous read failed.

ReadProperty(Object)
ReadProperty reads the value of the GXProperty instance.

ReadSpan
Used read span type.

ReadTable(Object, Object, Object)
ReadTable reads values of properties in a table.

ReadValues()()()
ReadValues reads all GXProperty values of the GXDevice instance.

RejectChanges()()()
Rolls back all the changes made to the IGXProperties collection since it was created, or since the last time AcceptChanges was called.

Reset(ResetType)
Resets values or actions, whose type is given as parameter.

ResetErrors()()()
ResetErrors clears all errors of the selected device.

ResetLastReadValue()()()
ResetLastReadValue sets value of the GXProperty to last read. If the GXProperty has not been read, it is set to default value.

ResetStatistic(DeviceStatistic)
Reset statistic value of determined type.

ScriptPath
ScriptPath is the path of the script file.

SelectDevice(String, String, String, Boolean)
SelectDevice creates and selects the device. This must be done first.

SetMediaSettings(String, String)
SetMediaSettings creates media connection and configures it using XML string.

SetToDefault()()()
SetToDefault sets all values, errors and states to default values.

Severities
Severities returns the collection of available severity items.

StartMonitoring()()()
StartMonitoring starts monitoring the selected device.

StateItems
Retrieves a listing of state items (timestamped state changes) of the GXProperty.

Status
Status is an enumerated state of the device.

StopMonitoring()()()
StopMonitoring stops monitoring of the selected device.

Tables
Tables is the collection of tables included in the device.

TemplatePath
TemplatePath is the path of the device template file.

ToString()()()
ToString returns a string that represents the current object.
(Inherited from GXObject.)
TransactionDelay
TransactionDelay is the minimum transaction delay time, in ms, between transactions.

TransactionWaitTime
Maximum time (ms) waited for the completion of the transaction in progress.

UnloadTemplate()()()
Unloads device(s) template settings and releases GXCom connections.

UpdateInterval
UpdateInterval is the interval of update requests made to the device.

UpdateStatisticValue(DeviceStatistic, Object)
A statistic value, retrieved from the physical device, can be set to replace the current statistic value of a property.

WriteCategory(Object)
WriteCategory writes values of the properties under the category.

WriteChanged()()()
WriteChanged writes values of the properties, whose status is ValueChanged (GX_PROPERTY_STATE_VALUE_CHANGED).

WriteProperty(Object)
WriteProperty writes the value of the GXProperty instance.

WriteTable(Object, Object, Object)
WriteTable writes table of values to a device.

WriteValues()()()
WriteValues writes all GXProperty values of the GXDevice instance.

Inheritance Hierarchy
Object
GXObject
  GXDevice

Assembly: Gurux.Device (Module: Gurux.Device) Version: 5.0.0.1