Open Core Interface - MLPI
MLPI-MotionLogicProgrammingInterface(mlpi4COM)  1.26.2
IGroupConfig.idl
Go to the documentation of this file.
1 // -----------------------------------------------------------------------
2 // MLPI - <IGroupConfig.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 
62 [
63  object,
64  uuid(BCE19BC9-625A-4537-9276-FC0697CA2827),
65  dual,
66  nonextensible,
67  helpstring("IGroupConfig Interface"),
68  pointer_default(unique)
69 ]
70 interface IGroupConfig : IDispatch{
71 #if defined(WIN32) || defined(WIN64)
72  [id(1), helpstring("Method AddAllAxisToGroup")] HRESULT AddAllAxisToGroup( void );
84 
96  [id(2), helpstring("Method RemAllAxisFromGroup")] HRESULT RemAllAxisFromGroup( void );
97 
121  [id(3), helpstring("Method SetCartesianTransform")] HRESULT SetCartesianTransform([in] enum RobotCoordinateSystem coordSys, [in] DOUBLE posX, [in] DOUBLE posY, [in] DOUBLE posZ, [in] DOUBLE rotA, [in] DOUBLE rotB, [in] DOUBLE rotC);
122 
146  [id(4), helpstring("Method SetCylindricTransform")] HRESULT SetCylindricTransform([in] enum RobotCoordinateSystem coordSys, [in] DOUBLE posX, [in] DOUBLE posY, [in] DOUBLE posZ, [in] DOUBLE rotA, [in] DOUBLE rotB, [in] DOUBLE rotC);
147 
173  [id(5), helpstring("Method SetBeltConfiguration")] HRESULT SetBeltConfiguration([in] AxisRef* beltAxis, [in] DOUBLE posX, [in] DOUBLE posY, [in] DOUBLE posZ, [in] DOUBLE rotA, [in] DOUBLE rotB, [in] DOUBLE rotC, [in] DOUBLE beginLength, [in] DOUBLE totalLength);
174 
200  [id(6), helpstring("Method SetRotaryTableConfiguration")] HRESULT SetRotaryTableConfiguration([in] AxisRef* beltAxis, [in] DOUBLE posX, [in] DOUBLE posY, [in] DOUBLE posZ, [in] DOUBLE rotA, [in] DOUBLE rotB, [in] DOUBLE rotC, [in] DOUBLE beginLength, [in] DOUBLE totalLength);
201 
223  [id(7), helpstring("Method SetBeltErrorReaction")] HRESULT SetBeltErrorReaction([in] AxisRef* beltAxis, [in] enum RobotSyncErrorReactionMode errorType, [in] DOUBLE time, [in] DOUBLE deceleration, [in] DOUBLE jerk);
224 
238  [id(8), helpstring("Method SetName")] HRESULT SetName([in] BSTR name);
239 
267  [id(9), helpstring("Method SetAxisConfiguration")] HRESULT SetAxisConfiguration([in] SAFEARRAY(struct RobotAxisConfiguration) axisConfig);
268 
286  [id(10), helpstring("Method SetKinematicType")] HRESULT SetKinematicType([in]LONG type);
287 
304  [id(11), helpstring("Method Reset")] HRESULT Reset();
305 
329  [id(12), helpstring("Method SetSafeZone")] HRESULT SetSafeZone([in]SHORT zoneNumber, [in]enum RobotSafeZoneType zoneType, [in]DOUBLE maxPosX, [in]DOUBLE maxPosY, [in]DOUBLE maxPosZ, [in]DOUBLE minPosX, [in]DOUBLE minPosY, [in]DOUBLE minPosZ);
330 
331 #endif
332 };
333 
334 
335 
336 // -----------------------------------------------------------------------
337 // HISTORY
338 // -----------------------------------------------------------------------
339 // 01-Jan-2012
340 // - first release
341 // 21-May-2013
342 // - added SetSafeZone()
343 // 22-May-2013 JUR
344 // - documentation update
345 //
346 
347 
HRESULT SetAxisConfiguration([in] SAFEARRAY(struct RobotAxisConfiguration) axisConfig)
This function sets the axis configuration of the group.
HRESULT RemAllAxisFromGroup(void)
This function removes all configured axes from the group.
HRESULT SetBeltErrorReaction([in] AxisRef *beltAxis, [in] enum RobotSyncErrorReactionMode errorType, [in] DOUBLE time, [in] DOUBLE deceleration, [in] DOUBLE jerk)
This function configures a error reaction for a kinematic and belt synchronous moves.
Definition of the IGroupConfig interface used to access motion commands to move an group...
HRESULT Reset()
This function resets the kinematic.
HRESULT SetSafeZone([in]SHORT zoneNumber, [in]enum RobotSafeZoneType zoneType, [in]DOUBLE maxPosX, [in]DOUBLE maxPosY, [in]DOUBLE maxPosZ, [in]DOUBLE minPosX, [in]DOUBLE minPosY, [in]DOUBLE minPosZ)
This function configures a safe zone of the robot.
HRESULT SetName([in] BSTR name)
This function sets the name of the Group.
HRESULT SetCartesianTransform([in] enum RobotCoordinateSystem coordSys, [in] DOUBLE posX, [in] DOUBLE posY, [in] DOUBLE posZ, [in] DOUBLE rotA, [in] DOUBLE rotB, [in] DOUBLE rotC)
This function sets a Cartesian transformation for PCS to WCS within the kinematic.
HRESULT SetRotaryTableConfiguration([in] AxisRef *beltAxis, [in] DOUBLE posX, [in] DOUBLE posY, [in] DOUBLE posZ, [in] DOUBLE rotA, [in] DOUBLE rotB, [in] DOUBLE rotC, [in] DOUBLE beginLength, [in] DOUBLE totalLength)
This function sets a cylindric transformation for PCS to WCS within the kinematic and configures a be...
HRESULT SetCylindricTransform([in] enum RobotCoordinateSystem coordSys, [in] DOUBLE posX, [in] DOUBLE posY, [in] DOUBLE posZ, [in] DOUBLE rotA, [in] DOUBLE rotB, [in] DOUBLE rotC)
This function sets a cylindric transformation for PCS to WCS within the kinematic.
HRESULT SetBeltConfiguration([in] AxisRef *beltAxis, [in] DOUBLE posX, [in] DOUBLE posY, [in] DOUBLE posZ, [in] DOUBLE rotA, [in] DOUBLE rotB, [in] DOUBLE rotC, [in] DOUBLE beginLength, [in] DOUBLE totalLength)
This function sets a Cartesian transformation for PCS to WCS within the kinematic and configures a be...
HRESULT AddAllAxisToGroup(void)
This function adds all configured axis to the group.
HRESULT SetKinematicType([in]LONG type)
This function sets the kinematic type (transformation scheme) of the robot.