DataViews Custom Data Reference Manual. DataViews for Windows Version 2.2

Transcription

1 DataViews Custom Data Reference Manual DataViews for Windows Version 2.2

2 Introduction GE Fanuc DataViews Corporate Headquarters 47 Pleasant Street Northampton, MA U.S.A. Telephone:(413) FAX:(413) web: GE Fanuc DataViews Japan Operations 16 Parale Mitsui Bldg 8 Higashida-cho Kawasaki-ku, Kawasaki Kanagawa, , Japan. Telephone: FAX: dv-japan@dvcorp.com GE Fanuc DataViews U.K. Sales Office 1210 Parkview Arlington Business Park Theale, Reading, RG7 4SA United Kingdom Telephone: FAX: info@dataviews.co.uk web: Copyrights and Trademarks Copyright 2000 GE Fanuc DataViews All Rights Reserved. This manual is subject to copyright protection. No portion of the contents of this book may be reproduced in any form or by any means without prior written consent from GE Fanuc DataViews. DataViews, DV-Tools, and DV-Draw are registered trademarks of GE Fanuc DataViews. DVX-Designer is a trademarks of GE Fanuc DataViews. All other trademarks are acknowledged as the property of their respective owners. August 2000 Software Release Version 2.2 Document Number Document Revision C

3 iii DataViews Custom Data Reference Manual Table of Contents Chapter 1: DataViews Custom Data Reference - Visual Basic... 1 Custom Data Objects Table... 2 Custom Data Object Map... 2 DVCustomDataSource... 5 DVCustomDataVar... 6 DVDataArg... 8 DVDataArgs Chapter 2: DataViews Custom Data Reference - Visual C Custom Data Class Table Custom Data Class Map CDVCustomDataSourceHndl CDVCustomDataVarHndl CDVDataArgHndl... 21

4

5 23 Chapter 1 1DataViews Custom Data Reference - Visual Basic 1 The Custom Data Editor Edition of DataViews includes several specialized COM objects for handling custom data sources. These custom data objects work with the rest of the DataViews COM Object Type Library programming interface. This interface is made up of several objects, each with methods and properties, that allow you to create and manipulate DataViews objects in Visual Basic. If you are programming in Visual Basic using the DVPlayer ActiveX control, you can use the DataViews type library, as well as the custom data objects to create and manipulate your DataViews objects, and connect to various custom data sources. For more information, see Custom Data Objects Table Custom Data Object Map

6 24 DataViews Custom Data Editor Toolkit Documentation Custom Data Objects Table The following table lists the various data objects in the DataViews COM Object Type Library: TheCustomDataObjects DVCustomDataSource DVCustomDataVar DVDataArg DVDataArgs All properties are read/write unless otherwise noted. Methods that return BOOL return FALSE on failure. Failure usually results when the method requires a view to be attached to the interface but none is. Custom Data Object Map The following figure illustrates the DataViews custom data objects and their relationships to the rest of the data structures: The Data Objects Map

7 Chapter 1: DataViews Custom Data Reference - Visual Basic 25 The Data Objects Map DVView DVDataSources DVDataSource DVDataVars DVDataVar DVFunctionDataSource DVCustomDataSource DVFunctionDataVar DVCustomDataVar DVDataArgs DVDataArgs DVDataArg DVDataArg Custom Data Edition Only

8 26 DataViews Custom Data Editor Toolkit Documentation The Custom Data Objects DVCustomDataSource DVCustomDataVar DVDataArg DVDataArgs See Also: The Data Objects Map

9 Chapter 1: DataViews Custom Data Reference - Visual Basic 27 DVCustomDataSource DVCustomDataSource Methods DVCustomDataSource Properties The Data Objects Map Since custom data sources may require additional information to be properly configured, the DataViews custom data source model allows the attachment of user-defined information to data sources and data variables. The DVCustomDataSource object represents a data source with the ability to manage userdefined information. DVCustomDataSource Methods No COM methods for this object. DVCustomDataSource Properties DataArgs Property DataArgs Property DataArgs As DVDataArgs In Visual Basic, this property returns the DVDataArgs collection of DVDataArg objects. Read only. Example: Dim cds As DVCustomDataSource cds.dataargs

10 28 DataViews Custom Data Editor Toolkit Documentation DVCustomDataVar DVCustomDataVar Methods DVCustomDataVar Properties The Data Objects Map Since custom data sources may require additional information to be properly configured, the DataViews custom data source model allows the attachment of user-defined information to data sources and data variables. This object represents a data source variable with the ability to manage user-defined information. DVCustomDataVar Methods Write Method Write Method WriteString Method Write(val As Double) As Boolean Allows you to write data values from a custom data variable out to another part of the application. WriteString Method WriteString(val As String) As Boolean Allows you to write string data values from a custom data variable out to another part of the application. DVCustomDataVar Properties Access Property DataArgs Property

11 Chapter 1: DataViews Custom Data Reference - Visual Basic 29 Access Property Access As dvdatavaraccess Manages the accessibility of the custom data variable: whether it is read only, read and write, or write only, using the dvddatavaraccess enumerated type: enum { dvdvareadonly, dvdvareadwrite, dvdvawriteonly } dvdatavaraccess DataArgs Property DataArgs As DVDataArgs In Visual Basic, this property returns the DVDataArgs collection of DVDataArg objects. Read only. Example: Dim cdv As DVCustomDataVar Dim min As Double min = cdv.dataargs(1).getvalue()

12 30 DataViews Custom Data Editor Toolkit Documentation DVDataArg DVDataArg Methods DVDataArg Properties The Data Objects Map Since custom data sources may require additional information to be properly configured, the DataViews custom data source model allows the attachment of user-defined information to data sources and data variables. This object represents a singular user-defined data item. Permitted types for the information items are Long, Double, String, anddvdatavar. DVDataArg Methods GetValue Method PutValue Method GetValue Method GetValue() In Visual Basic, this method gets the value of the data variable. Example: Dim cdv As DVCustomDataVar Dim min As Double min = cdv.dataargs(1).getvalue() PutValue Method PutValue(argtype As dvdataargtype, value) As Boolean In Visual Basic, this method sets the value of the data variable.

13 Chapter 1: DataViews Custom Data Reference - Visual Basic 31 Example: Dim ds As DVCustomDataSource Dim Increments As Long Increments = ds.dataargs(1).getvalue() ds.dataargs(1).putvalue dvdatlong, Increments DVDataArg Properties DataArgType Property IsPermament Property IsValid Property PermArgNameProperty DataArgType Property DataArgType As dvdataargtype Sets/returns a particular type of data argument. Read only. In Visual Basic, this property returns a dvdataargtype enum that specified the type of data argument. Example: Dim data_arg As DVDataArg data_arg.dataargtype IsPermament Property IsPermanent As Boolean Always returns FALSE for a custom data source. Returns TRUE for a mandatory function data source argument. Read only in Visual Basic.

14 32 DataViews Custom Data Editor Toolkit Documentation Example: Dim data_arg As DVDataArg data_arg.ispermanent IsValid Property IsValid As Boolean Returns TRUE for a validdata source or data variable, otherwise returnsfalse. Read only in Visual Basic. Example: Dim data_arg As DVDataArg data_arg.isvalid PermArgNameProperty PermArgName As String Read only. Returns the string designated as the name of the permanent data argument, used primarily for function data sources and function data variables. Example: Dim data_arg As DVDataArg Dim name As String Set name = data_arg.permargname

15 Chapter 1: DataViews Custom Data Reference - Visual Basic 33 DVDataArgs DVDataArgs Methods DVDataArgs Properties The Data Objects Map Since custom data sources may require additional information to be properly configured, the DataViews custom data source model allows the attachment of user-defined information to data sources and data variables. The DVDataArgs object is a collection of DVDataArg objects. DVDataArgs Methods Add Method Item Method Remove Method Add Method Add() As DVDataArg Adds the data argument to the collection. Example: Dim iptmp As String Dim cdv As DVCustomDataVar cdv.dataargs.add.putvalue dvdattext, iptmp Item Method Item(vntIndexKey) As DVDataArg Returns the specified data argument in the collection.

16 34 DataViews Custom Data Editor Toolkit Documentation Example: Dim da As DVDataArg Dim cdv As DVCustomDataVar Set da = cdv.dataargs.item(1) Remove Method Remove(vntIndexKey) Removes the data argument from the collection. Example: Dim cdv As DVCustomDataVar cdv.dataargs.remove(1) DVDataArgs Properties Count Property Count Property Count As Long Returns the number of data arguments in the collection. Read only. Example: Dim cds As DVCustomDataSource If cds.dataargs.count >= 2 Then... End If

17 35 Chapter 2 2DataViews Custom Data Reference - Visual C++ 2 The Custom Data Editor Edition of DataViews includes several specialized C++ classes for handling custom data sources. These custom data objects work with the rest of the DataViews C++ Class Library programming interface. This interface is made up of several classes, each with methods and properties, that allow you to create and manipulate DataViews objects in a Visual C++ application. Using the DataViews C++ Class Library you can display and manipulate DataViews views, work with graphical objects, and manage object data and dynamics, and connect to various custom data sources. For more information, see Custom Data Class Table Custom Data Class Map

18 36 DataViews Custom Data Editor Toolkit Documentation Custom Data Class Table The following table lists the various custom data classes: The Custom Data Classes CDVCustomDataSourceHndl CDVCustomDataVarHndl CDVDataArgHndl All properties are read/write unless otherwise noted. Methods that return BOOL return FALSE on failure. Failure usually results when the method requires a view to be attached to the interface but none is.

19 Chapter 2: DataViews Custom Data Reference - Visual C++ 37 Custom Data Class Map The following figure illustrates the DataViews custom data classes and their relationships to the other data classes: TheDataClassesMap

20 38 DataViews Custom Data Editor Toolkit Documentation The Data Classes Map CDVViewHndl CDVDataSourceHndl CDVDataVarHndl CDVFunctionDataSourceHndl CDVCustomDataSourceHndl CDVFunctionDataVarHndl CDVCustomDataVarHndl CDVDataArgHndl CDVDataArgHndl Custom Data Edition Only

21 Chapter 2: DataViews Custom Data Reference - Visual C++ 39 The Custom Data Classes CDVCustomDataSourceHndl CDVCustomDataVarHndl CDVDataArgHndl See Also: TheDataClassesMap

22 40 DataViews Custom Data Editor Toolkit Documentation CDVCustomDataSourceHndl CDVCustomDataSourceHndl Methods CDVCustomDataSourceHndl Properties TheDataClassesMap #include <DVUserDataSourceHndl.h> Since custom data sources may require additional information to be properly configured, the DataViews custom data source model allows the attachment of user-defined information to data sources and data variables. The CDVCustomDataSourceHndl class represents a data source with the ability to manage user-defined information. CDVCustomDataSourceHndl Methods No methods for this object. CDVCustomDataSourceHndl Properties DataArgs Property DataArgs Property int GetDataArgCount() CDVDataArgHndl GetDataArg(int index) CDVDataArgHndl NewDataArg() BOOL DeleteDataArg(int index) In C++, there are several additional methods that handle the data argument property and maintain the individual CDVDataArgHndl objects. GetArgCount() returns the number of data arguments. GetDataArg() returns the specified data argument from the data source. NewDataArg() creates a new data argument. DeleteDataArg() removes the specified data argument from the data source.

23 Chapter 2: DataViews Custom Data Reference - Visual C++ 41 CDVCustomDataVarHndl CDVCustomDataVarHndl Methods CDVCustomDataVarHndl Properties TheDataClassesMap #include <DVUserDataVarHndl.h> Since custom data sources may require additional information to be properly configured, the DataViews custom data source model allows the attachment of user-defined information to data sources and data variables. This object represents a data source variable with the ability to manage user-defined information. CDVCustomDataVarHndl Methods Write Method Write Method WriteString Method BOOL Write(double value) Allows you to write data values from a custom data variable out to another part of the application. WriteString Method BOOL WriteString(const char* value) Allows you to write string data values from a custom data variable out to another part of the application. CDVCustomDataVarHndl Properties Access Property DataArgs Property

24 42 DataViews Custom Data Editor Toolkit Documentation Access Property void SetAccess(DV_DATA_VAR_ACCESS_ENUM access) DV_DATA_VAR_ACCESS_ENUM GetAccess() Manages the accessibility of the custom data variable: whether it is read only, read and write, or write only, using the DV_DATA_VAR_ACCESS_ENUM: enum DV_DATA_VAR_ACCESS_ENUM { DV_DATA_VAR_ACCESS_READONLY, DV_DATA_VAR_ACCESS_READWRITE, DV_DATA_VAR_ACCESS_WRITEONLY } DataArgs Property int GetDataArgCount() CDVDataArgHndl GetDataArg(int index) CDVDataArgHndl NewDataArg() BOOL DeleteDataArg(int index) In C++, there are several additional methods that handle the data argument property and maintain the individual CDVDataArgHndl objects. GetArgCount() returns the number of data arguments. GetDataArg() returns the specified data argument from the data variable. NewDataArg() creates a new data argument. DeleteDataArg() removes the specified data argument from the data variable.

25 Chapter 2: DataViews Custom Data Reference - Visual C++ 43 CDVDataArgHndl CDVDataArgHndl Methods CDVDataArgHndl Properties TheDataClassesMap #include <DVDataArgHndl.h> Since custom data sources may require additional information to be properly configured, the DataViews custom data source model allows the attachment of user-defined information to data sources and data variables. This object represents a singular user-defined data item. Permitted types for the information items are Long, Double, String, anddvdatavar. CDVDataArgHndl Methods GetValue Method PutValue Method GetValue Method For C++ implementation, see DataArgType Property. PutValue Method For C++ implementation, see DataArgType Property. CDVDataArgHndl Properties DataArgType Property IsPermament Property IsValid Property PermArgName Property

26 44 DataViews Custom Data Editor Toolkit Documentation DataArgType Property DV_DATA_ARG_TYPE_ENUM GetType() BOOL SetLong(long lng) long GetLong() BOOL SetDouble(double dbl) double GetDouble() BOOL SetString(const char* str) const char* GetString() BOOL SetDataVar(CDVDataVarHndl dvh) CDVDataVarHndl GetDataVar() Sets/returns a particular type of data argument. In C++, note there are several additional methods used in getting/setting the various types of data arguments. Note that you are required to use GetType() in order to get the type of data variable before you can set the data variable to a new type using SetDouble(), SetLong(),etc. IsPermament Property BOOL IsPermanent() Always returns FALSE for a custom data source. Returns TRUE for a mandatory function data source argument. IsValid Property BOOL IsValid() Returns TRUE for a valid data source or data variable, otherwise returns FALSE.

27 Chapter 2: DataViews Custom Data Reference - Visual C++ 45 PermArgName Property const char* GetPermArgName() Read only. Returns the string designated as the name of the permanent data argument, used primarily for function data sources and function data variables.

28

29 25 Index A Access Property 7 Add Method 11 C C++ classes custom data class maps 15 custom data tables 14 CDVCustomDataSourceHndl 18 CDVCustomDataVarHndl 19 CDVDataArgHndl 21 COM object type library custom data reference tables 2 maps 2 Count Property 12 D DataArgs Property 5, 7 DataArgType Property 9 DataViews Visual Basic custom data source reference 1 Visual C++ custom data source reference 13 DataViews Class Library reference custom data objects 13 DataViews COM Object Type Library reference custom data objects 1 DeleteDataArg() 18, 20 DVCustomDataSource 5 DVCustomDataVar 6 DVDataArg 8 DVDataArgs 11 G GetAccess() 20 GetDataArg() 18, 20 GetDataArgCount() 18, 20 GetDataVar() 22 GetDouble() 22 GetLong() 22 GetPermArgName() 23 GetString() 22 GetType() 22 GetValue Method 8 I IsPermament Property 9 IsPermanent() 22 IsValid Property 10 IsValid() 22 Item Method 11 N NewDataArg() 18, 20 O object custom data reference tables 2 maps 2 P PermArgName Property 10 PutValue Method 8 R Remove Method 12 S SetAccess() 20 SetDataVar() 22 SetDouble() 22

30 26 DataViews Custom Data Reference Manual SetLong() 22 SetString() 22 W Write Method 6 Write() 19 WriteString Method 6 WriteString() 19