|
INGEAR.NET.GELink Classes, Methods and
Properties
|
|
Controller Class
- A class that handles the communications with the PLCs.
EventCode Class
- Enumerates the different codes used by the Controller Class events.
ResultCode Class
- Enumerates the different codes used to define the results of the methods for the Controller, Tag, and TagGroup classes.
Tag Class
- A class that contains information about the tags used by the Controller Class to communicate with the AB PLCs.
TagGroup Class - A class that is a collection of Tags (see Tag Class)
|
|
CONTROLLER Class
- A class that handles the communications with the PLCs.
|
Properties
|
|
|
ErrorCode
|
Returns the last recorded error code as an integer for the Controller Class
|
|
ErrorString
|
Returns the last recorded error as a descriptive error for the Controller Class.
|
|
IPAddress
|
Gets or sets the IP Address
|
|
IsConnected
|
Returns TRUE if there is a current connection with the PLC
|
|
MyObject
|
Gets or set a user-defined object that is associated with this Controller instance.
|
|
Path
|
Gets or sets the routing path for this PLC. This property is provided to compatibility with other INGEAR.NET products and has no
meaning for the GELink product.
|
|
Timeout
|
Gets or sets the amount of time (in milliseconds) that the instance waits for a completed connection to the PLC.
|
|
Version
|
Gets the current version of the GELink component.
|
|
Methods
|
|
|
Connect
|
Attempts a connection to the PLC.
|
|
CreateNewGroup
|
Creates a new instance of IGroup (see Interfaces)
|
|
CreateNewTag
|
Creates a new instance of ITag (see Interfaces)
|
|
Disconnect
|
Disconnects the instance from the PLC.
|
|
GroupRead
|
Performs a Read of a TagGroup (see TagGroup class)
|
|
GroupWrite
|
Performs a Write of a TagGroup (see TagGroup class)
|
|
ReadTag
|
Performs a Read of a Tag (see Tag class)
|
|
WriteTag
|
Peforms a Write of a Tag (see Tag class)
|
|
To Top
EVENTCODE Class
- Enumerates the different codes used by the Controller Class events.
To Top
RESULTCODE Class
- Enumerates the different codes used to define the results of the methods for the Controller, Tag, and TagGroup classes.
To Top
TAG Class
- A class that contains information about the tags used by the Controller Class to communicate with the PLC.
|
Properties
|
|
|
Active
|
Sets / Gets the active state of the tag
|
|
Controller
|
Sets / Gets the instance of a Controller class
|
|
DataType
|
Sets / Gets data type for PLC register values
|
|
ErrorCode
|
Returns the error code for the last PLC access for the Tag instance
|
|
ErrorString
|
Returns the error code for the last PLC access for the Tag instance as a string
|
|
Length
|
Sets / Gets the number items to read or write from the PLC
|
|
MyObject
|
Sets / Gets user defined object
|
|
Name
|
Sets / Gets the PLC register address
|
|
NetType
|
Sets / Gets the .NET Type of the PLC value
|
|
Now
|
Executes immediate read / write operation
|
|
QualityCode
|
Returns the quality state of the last PLC access operation for the Tag instance
|
|
QualityString
|
Returns the quality state of the last PLC access operation for the Tag instance
|
|
TimeStamp
|
Gets time stamp for last successful PLC access operation for the Tag instance
|
|
Value
|
Sets / Gets the PLC register value
|
|
Events
|
|
|
Changed
|
Fires when the value of the tag has changed.
|
To Top
TAGGROUP Class
- A class that is a collection of Tags (see Tag Class above).
|
Properties
|
|
|
Active
|
Gets / Sets activate state of group
|
|
Controller
|
Sets / Gets instance of Controller class associated with TagGroup
|
|
Count
|
Gets the number to Tag class instances in the group
|
|
ErrorCode
|
Gets numeric value for last error encounted by group
|
|
ErrorString
|
Gets numeric value for last error encounted by group
|
|
MyObject
|
User-defined object associated with instance of TagGroup
|
|
Now
|
Preforms an immediate read of all ITag in the Group
|
|
Tags
|
Gets list of Tag classes in the group
|
|
Methods
|
|
|
AddTag
|
Adds instance of Tag class (or array of Tag classes) to TagGroup collection
|
|
Clear
|
Removes all Tag objects in TagGroup collection
|
|
CreateNewTag
|
Creates new instance of ITag
|
|
RemoveTag
|
Removes specific instance of Tag class from TagGroup
|
To Top
Sample code for various platforms can be found at our Code Center.
|