C# Class Gurux.DLMS.Objects.GXDLMSObject

GXDLMSObject provides an interface to DLMS registers.

Inheritance: IGXDLMSColumnObject

Mostra file Open project: Gurux/Gurux.DLMS.Net Class Usage Examples

Private Properties

Property	Type	Description
ClearDirty	void
GetDirty	bool
GetDirtyAttributeIndexes	int[]
SetLastReadTime	void
ToLogicalName	string
UpdateDirty	void

Public Methods

Method	Description
CanRead ( int index ) : bool	Is attribute of the object readable.
Clone ( ) : GXDLMSObject
GXDLMSObject ( ) : System	Constructor.
GetAccess ( int index ) : AccessMode	Returns is attribute read only.
GetDataType ( int index ) : DataType	Returns device data type of selected attribute index.
GetLastReadTime ( int attributeIndex ) : System.DateTime	Returns time when attribute was last time read.
GetMethodAccess ( int index ) : MethodAccessMode	Returns is Method attribute read only.
GetStatic ( int index ) : bool
GetUIDataType ( int index ) : DataType	Returns UI data type of selected index.
GetValues ( ) : object[]	Returns attributes as an array.
IsRead ( int index ) : bool	Is attribute read.
SetAccess ( int index, AccessMode access ) : void	Set attribute access.
SetDataType ( int index, DataType type ) : void
SetMethodAccess ( int index, MethodAccessMode access ) : void	Set Method attribute access.
SetStatic ( int index, bool isStatic ) : void
SetUIDataType ( int index, DataType type ) : void
ToString ( ) : string	Logical or Short Name of DLMS object.
ValidateLogicalName ( String ln ) : bool

Protected Methods

Method	Description
GXDLMSObject ( ObjectType objectType ) : System	Constructor,
GXDLMSObject ( ObjectType objectType, string ln, ushort sn ) : System	Constructor,
GetAttribute ( int index, GXAttributeCollection attributes ) : GXDLMSAttributeSettings

Private Methods

Method	Description
ClearDirty ( int attributeIndex ) : void
GetDirty ( int attributeIndex, object &value ) : bool
GetDirtyAttributeIndexes ( ) : int[]
SetLastReadTime ( int attributeIndex, System.DateTime tm ) : void
ToLogicalName ( byte buff ) : string	Reserved for internal use.
UpdateDirty ( int attributeIndex, object value ) : void

Method Details

CanRead() public method

Is attribute of the object readable.

public CanRead ( int index ) : bool
index	int	Attribute index of the object.
return	bool

Clone() public method

public Clone ( ) : GXDLMSObject
return	GXDLMSObject

GXDLMSObject() public method

Constructor.

public GXDLMSObject ( ) : System
return	System

GXDLMSObject() protected method

Constructor,

protected GXDLMSObject ( ObjectType objectType ) : System
objectType	ObjectType
return	System

GXDLMSObject() protected method

Constructor,

protected GXDLMSObject ( ObjectType objectType, string ln, ushort sn ) : System
objectType	ObjectType
ln	string
sn	ushort
return	System

GetAccess() public method

Returns is attribute read only.

public GetAccess ( int index ) : AccessMode
index	int	Attribute index.
return	AccessMode

GetAttribute() protected method

protected GetAttribute ( int index, GXAttributeCollection attributes ) : GXDLMSAttributeSettings
index	int
attributes	GXAttributeCollection
return	Gurux.DLMS.ManufacturerSettings.GXDLMSAttributeSettings

GetDataType() public method

Returns device data type of selected attribute index.

public GetDataType ( int index ) : DataType
index	int	Attribute index of the object.
return	DataType

GetLastReadTime() public method

Returns time when attribute was last time read.

public GetLastReadTime ( int attributeIndex ) : System.DateTime
attributeIndex	int	Attribute index.
return	System.DateTime

GetMethodAccess() public method

Returns is Method attribute read only.

public GetMethodAccess ( int index ) : MethodAccessMode
index	int	Method Attribute index.
return	MethodAccessMode

GetStatic() public method

public GetStatic ( int index ) : bool
index	int
return	bool

GetUIDataType() public method

Returns UI data type of selected index.

public GetUIDataType ( int index ) : DataType
index	int	Attribute index of the object.
return	DataType

GetValues() public method

Returns attributes as an array.

public GetValues ( ) : object[]
return	object[]

IsRead() public method

Is attribute read.

public IsRead ( int index ) : bool
index	int	Attribute index to read.
return	bool

SetAccess() public method

Set attribute access.

public SetAccess ( int index, AccessMode access ) : void
index	int
access	AccessMode
return	void

SetDataType() public method

public SetDataType ( int index, DataType type ) : void
index	int
type	DataType
return	void

SetMethodAccess() public method

Set Method attribute access.

public SetMethodAccess ( int index, MethodAccessMode access ) : void
index	int
access	MethodAccessMode
return	void

SetStatic() public method

public SetStatic ( int index, bool isStatic ) : void
index	int
isStatic	bool
return	void

SetUIDataType() public method

public SetUIDataType ( int index, DataType type ) : void
index	int
type	DataType
return	void

ToString() public method

Logical or Short Name of DLMS object.

public ToString ( ) : string
return	string

ValidateLogicalName() public static method

public static ValidateLogicalName ( String ln ) : bool
ln	String
return	bool