Open Core Interface - MLPI
MLPI-MotionLogicProgrammingInterface(mlpi4COM)  1.26.2
IRobotPoint.idl
Go to the documentation of this file.
1 // -----------------------------------------------------------------------
2 // MLPI - <IRobotPoint.idl>
3 // -----------------------------------------------------------------------
4 // Copyright (c) 2012 Bosch Rexroth. All rights reserved.
5 // Redistribution and use in source and binary forms of this MLPI software
6 // (SW) provided to you, with or without modification, are permitted
7 // without prior approval provided that the following conditions are met:
8 //
9 // 1. Redistributions of source code of SW must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // 2. Redistributions in binary form of SW must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // 3. User recognizes and acknowledges that it acquires no right,
17 // title or interest in or to any of the names or trademarks used in
18 // connection with the SW ("names") by virtue of this License and waives
19 // any right to or interest in the names. User recognizes and acknowledges
20 // that names of companies or names or products of companies displayed
21 // in the documentation of SW to indicate the interoperability of products
22 // with the SW are the names of their respective owners. The use of such
23 // names in the documentation of SW does not imply any sponsorship,
24 // approval, or endorsement by such companies of this product.
25 //
26 // 4. Modified code versions, i.e. any addition to or deletion from
27 // the substance or structure of the original code of the SW running
28 // the MLPI must be plainly marked as such and must not be misrepresented
29 // as being original SW.
30 //
31 // 5. The SW may only be used in connection with a Bosch Rexroth product.
32 //
33 // THIS INFORMATION IS PROVIDED BY BOSCH REXROTH CORPORATION "AS IS"
34 // AND WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING
35 // (BUT NOTLIMITED TO) ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
36 // FITNESS FOR ANY PARTICULAR PURPOSE, OR NON-INFRINGEMENT. WHILE THE
37 // INFORMATION PROVIDED IS BELIEVED TO BE ACCURATE, IT MAY INCLUDE
38 // ERRORS OR INACCURACIES.
39 // SUBJECT TO COMPULSORY STATUTORY PROVISIONS OF THE GERMAN LAW AS
40 // THE APPLICABLE LAW FOR THIS LICENSE BOSCH REXROTH CORPORATION WILL
41 // NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND ARISING FROM THE USE OF
42 // THE SOFTWARE DISTRIBUTED HEREUNDER, INCLUDING BUT NOT LIMITED TO
43 // DIRECT, INDIRECT, INCIDENTAL, PUNITIVE, AND CONSEQUENTIAL DAMAGES.
44 // -----------------------------------------------------------------------
45 //
55 //
56 // -----------------------------------------------------------------------
57 
58 
59 
63 [
64  object,
65  uuid(061A1B7D-80EF-495f-952A-17A713397FE9),
66  dual,
67  nonextensible,
68  helpstring("IRobotPoint Interface"),
69  pointer_default(unique)
70 ]
71 interface IRobotPoint : IDispatch{
72 
89  [propget, id(DISPID_VALUE), helpstring("property Item")] HRESULT Item([in] VARIANT nameOrIndex, [out, retval] DOUBLE *value);
90 
107  [propput, id(DISPID_VALUE), helpstring("property Item")] HRESULT Item([in] VARIANT nameOrIndex, [in] DOUBLE value);
108 
109 #if defined(WINCE)
110 #elif defined(WIN32) || defined(WIN64)
111 
127  [propget, id(1), helpstring("property Type")] HRESULT Type([out, retval] RobotCoordinateSystem *Type);
128 
135  // @code
136  // RobotPoint myPoint = Robot.CreatePoint(new double[] { 4.0 }, RobotCoordinateSystem.ROBOT_CS_MCS);
137  // double xValue = myPoint.get_Point().coordinate[0]; // only read access;
138  // @endcode
145  [propget, id(2), helpstring("property Point")] HRESULT Point([out, retval] DOUBLE *Point);
146  [propput, id(2), helpstring("property Point")] HRESULT Point([in] DOUBLE *Point);
147 #endif
148 
149 };
150 
151 
152 
153 
154 // -----------------------------------------------------------------------
155 // HISTORY
156 // -----------------------------------------------------------------------
157 // 01-Jan-2012
158 // - first release
159 //
160 
161 
162 
DOUBLE Item([in] VARIANT nameOrIndex)
This property returns the value of the given coordinate index.
RobotCoordinateSystem Type
This property returns IRobot::RobotCoordinateSystem type of the point.
Definition of the IRobotPoint interface.
Definition: IRobotPoint.idl:71
DOUBLE Point
This property returns GroupPoint of the Point.