Module: IOPCAutoServer

Includes:
WIN32OLE::VARIANT
Defined in:
lib/picopc/olegen_opc_automation.rb

Overview

OPCServer Object

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#lastargsObject (readonly)

Returns the value of attribute lastargs.



105
106
107
# File 'lib/picopc/olegen_opc_automation.rb', line 105

def lastargs
  @lastargs
end

Instance Method Details

#BandwidthObject

I4 Bandwidth Might possibly be Percent utilization



200
201
202
203
204
# File 'lib/picopc/olegen_opc_automation.rb', line 200

def Bandwidth()
  ret = _getproperty(1610743822, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#BuildNumberObject

I2 BuildNumber



145
146
147
148
149
# File 'lib/picopc/olegen_opc_automation.rb', line 145

def BuildNumber()
  ret = _getproperty(1610743813, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#ClientNameObject

BSTR ClientName Identify the client



185
186
187
188
189
# File 'lib/picopc/olegen_opc_automation.rb', line 185

def ClientName()
  ret = _getproperty(1610743818, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#ClientName=(arg0) ⇒ Object

VOID ClientName Identify the client



224
225
226
227
228
# File 'lib/picopc/olegen_opc_automation.rb', line 224

def ClientName=(arg0)
  ret = _setproperty(1610743818, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end

#Connect(arg0, arg1 = nil) ⇒ Object

VOID Connect Connect to a named OPC Server

BSTR arg0 --- ProgID [IN]
VARIANT arg1 --- Node [IN]


250
251
252
253
254
# File 'lib/picopc/olegen_opc_automation.rb', line 250

def Connect(arg0, arg1=nil)
  ret = _invoke(1610743826, [arg0, arg1], [VT_BSTR, VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end

#CreateBrowserObject

OPCBrowser CreateBrowser Create a new OPCBrowser Object



266
267
268
269
270
# File 'lib/picopc/olegen_opc_automation.rb', line 266

def CreateBrowser()
  ret = _invoke(1610743828, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#CurrentTimeObject

DATE CurrentTime



116
117
118
119
120
# File 'lib/picopc/olegen_opc_automation.rb', line 116

def CurrentTime()
  ret = _getproperty(1610743809, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#DisconnectObject

VOID Disconnect End Connection with OPC Server



258
259
260
261
262
# File 'lib/picopc/olegen_opc_automation.rb', line 258

def Disconnect()
  ret = _invoke(1610743827, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#GetErrorString(arg0) ⇒ Object

BSTR GetErrorString Convert an error code to a descriptive string

I4 arg0 --- ErrorCode [IN]


275
276
277
278
279
# File 'lib/picopc/olegen_opc_automation.rb', line 275

def GetErrorString(arg0)
  ret = _invoke(1610743829, [arg0], [VT_I4])
  @lastargs = WIN32OLE::ARGV
  ret
end

#GetItemProperties(arg0, arg1, arg2, arg3, arg4) ⇒ Object

VOID GetItemProperties

BSTR arg0 --- ItemID [IN]
I4 arg1 --- Count [IN]
I4 arg2 --- PropertyIDs [IN]
VARIANT arg3 --- PropertyValues [OUT]
I4 arg4 --- Errors [OUT]


307
308
309
310
311
# File 'lib/picopc/olegen_opc_automation.rb', line 307

def GetItemProperties(arg0, arg1, arg2, arg3, arg4)
  ret = _invoke(1610743832, [arg0, arg1, arg2, arg3, arg4], [VT_BSTR, VT_I4, VT_BYREF|VT_ARRAY|VT_I4, VT_BYREF|VT_ARRAY|VT_VARIANT, VT_BYREF|VT_ARRAY|VT_I4])
  @lastargs = WIN32OLE::ARGV
  ret
end

#GetOPCServers(arg0 = nil) ⇒ Object

VARIANT GetOPCServers Returns an array of Server names, optionally on another node

VARIANT arg0 --- Node [IN]


240
241
242
243
244
# File 'lib/picopc/olegen_opc_automation.rb', line 240

def GetOPCServers(arg0=nil)
  ret = _invoke(1610743825, [arg0], [VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end

#LastUpdateTimeObject

DATE LastUpdateTime Last time the server sent data



124
125
126
127
128
# File 'lib/picopc/olegen_opc_automation.rb', line 124

def LastUpdateTime()
  ret = _getproperty(1610743810, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#LocaleIDObject

I4 LocaleID



192
193
194
195
196
# File 'lib/picopc/olegen_opc_automation.rb', line 192

def LocaleID()
  ret = _getproperty(1610743820, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#LocaleID=(arg0) ⇒ Object

VOID LocaleID



231
232
233
234
235
# File 'lib/picopc/olegen_opc_automation.rb', line 231

def LocaleID=(arg0)
  ret = _setproperty(1610743820, [arg0], [VT_I4])
  @lastargs = WIN32OLE::ARGV
  ret
end

#LookupItemIDs(arg0, arg1, arg2, arg3, arg4) ⇒ Object

VOID LookupItemIDs

BSTR arg0 --- ItemID [IN]
I4 arg1 --- Count [IN]
I4 arg2 --- PropertyIDs [IN]
BSTR arg3 --- NewItemIDs [OUT]
I4 arg4 --- Errors [OUT]


319
320
321
322
323
# File 'lib/picopc/olegen_opc_automation.rb', line 319

def LookupItemIDs(arg0, arg1, arg2, arg3, arg4)
  ret = _invoke(1610743833, [arg0, arg1, arg2, arg3, arg4], [VT_BSTR, VT_I4, VT_BYREF|VT_ARRAY|VT_I4, VT_BYREF|VT_ARRAY|VT_BSTR, VT_BYREF|VT_ARRAY|VT_I4])
  @lastargs = WIN32OLE::ARGV
  ret
end

#MajorVersionObject

I2 MajorVersion



131
132
133
134
135
# File 'lib/picopc/olegen_opc_automation.rb', line 131

def MajorVersion()
  ret = _getproperty(1610743811, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#MinorVersionObject

I2 MinorVersion



138
139
140
141
142
# File 'lib/picopc/olegen_opc_automation.rb', line 138

def MinorVersion()
  ret = _getproperty(1610743812, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#OPCGroupsObject

OPCGroups OPCGroups The collection of OPCGroup Objects



208
209
210
211
212
# File 'lib/picopc/olegen_opc_automation.rb', line 208

def OPCGroups()
  ret = _getproperty(0, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#PublicGroupNamesObject

VARIANT PublicGroupNames Returns an array of names



216
217
218
219
220
# File 'lib/picopc/olegen_opc_automation.rb', line 216

def PublicGroupNames()
  ret = _getproperty(1610743824, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#QueryAvailableLocaleIDsObject

VARIANT QueryAvailableLocaleIDs The LocaleIDs supported by this server



283
284
285
286
287
# File 'lib/picopc/olegen_opc_automation.rb', line 283

def QueryAvailableLocaleIDs()
  ret = _invoke(1610743830, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#QueryAvailableProperties(arg0, arg1, arg2, arg3, arg4) ⇒ Object

VOID QueryAvailableProperties

BSTR arg0 --- ItemID [IN]
I4 arg1 --- Count [OUT]
I4 arg2 --- PropertyIDs [OUT]
BSTR arg3 --- Descriptions [OUT]
I2 arg4 --- DataTypes [OUT]


295
296
297
298
299
# File 'lib/picopc/olegen_opc_automation.rb', line 295

def QueryAvailableProperties(arg0, arg1, arg2, arg3, arg4)
  ret = _invoke(1610743831, [arg0, arg1, arg2, arg3, arg4], [VT_BSTR, VT_BYREF|VT_I4, VT_BYREF|VT_ARRAY|VT_I4, VT_BYREF|VT_ARRAY|VT_BSTR, VT_BYREF|VT_ARRAY|VT_I2])
  @lastargs = WIN32OLE::ARGV
  ret
end

#ServerNameObject

BSTR ServerName Returns this server’s name



169
170
171
172
173
# File 'lib/picopc/olegen_opc_automation.rb', line 169

def ServerName()
  ret = _getproperty(1610743816, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#ServerNodeObject

BSTR ServerNode Returns this server’s node



177
178
179
180
181
# File 'lib/picopc/olegen_opc_automation.rb', line 177

def ServerNode()
  ret = _getproperty(1610743817, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#ServerStateObject

I4 ServerState Returns an OPCServerState



161
162
163
164
165
# File 'lib/picopc/olegen_opc_automation.rb', line 161

def ServerState()
  ret = _getproperty(1610743815, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#StartTimeObject

DATE StartTime Time the Server Started



109
110
111
112
113
# File 'lib/picopc/olegen_opc_automation.rb', line 109

def StartTime()
  ret = _getproperty(1610743808, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#VendorInfoObject

BSTR VendorInfo Server Vendor’s name



153
154
155
156
157
# File 'lib/picopc/olegen_opc_automation.rb', line 153

def VendorInfo()
  ret = _getproperty(1610743814, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end