IMlpiConnection.idl

Go to the documentation of this file.

// -----------------------------------------------------------------------
// MLPI - <IMlpiConnection.idl>
// -----------------------------------------------------------------------
// Copyright (c) 2012 Bosch Rexroth. All rights reserved.
// Redistribution and use in source and binary forms of this MLPI software
// (SW) provided to you, with or without modification, are permitted
// without prior approval provided that the following conditions are met:
//
// 1. Redistributions of source code of SW must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form of SW must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. User recognizes and acknowledges that it acquires no right,
// title or interest in or to any of the names or trademarks used in
// connection with the SW ("names") by virtue of this License and waives
// any right to or interest in the names. User recognizes and acknowledges
// that names of companies or names or products of companies displayed
// in the documentation of SW to indicate the interoperability of products
// with the SW are the names of their respective owners. The use of such
// names in the documentation of SW does not imply any sponsorship,
// approval, or endorsement by such companies of this product.
//
// 4. Modified code versions, i.e. any addition to or deletion from
// the substance or structure of the original code of the SW running
// the MLPI must be plainly marked as such and must not be misrepresented
// as being original SW.
//
// 5. The SW may only be used in connection with a Bosch Rexroth product.
//
// THIS INFORMATION IS PROVIDED BY BOSCH REXROTH CORPORATION "AS IS"
// AND WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING
// (BUT NOTLIMITED TO) ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR ANY PARTICULAR PURPOSE, OR NON-INFRINGEMENT. WHILE THE
// INFORMATION PROVIDED IS BELIEVED TO BE ACCURATE, IT MAY INCLUDE
// ERRORS OR INACCURACIES.
// SUBJECT TO COMPULSORY STATUTORY PROVISIONS OF THE GERMAN LAW AS
// THE APPLICABLE LAW FOR THIS LICENSE BOSCH REXROTH CORPORATION WILL
// NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND ARISING FROM THE USE OF
// THE  SOFTWARE  DISTRIBUTED HEREUNDER, INCLUDING BUT NOT LIMITED TO
// DIRECT, INDIRECT, INCIDENTAL, PUNITIVE, AND CONSEQUENTIAL DAMAGES.
// -----------------------------------------------------------------------
//
//
// -----------------------------------------------------------------------




[
  object,
  uuid(FD70E73B-D0A4-4D3A-A105-C9FCDB83FA34),
  dual,
  nonextensible,
  helpstring("IMlpiConnection Interface"),
  pointer_default(unique)
]
interface IMlpiConnection : IDispatch{


  typedef [v1_enum] enum Type
  {
    TYPE_INVALID          =    0,   
                                
    TYPE_CHAR             =    1,   
    TYPE_UCHAR            =    2,   
    TYPE_SHORT            =    3,   
    TYPE_USHORT           =    4,   
    TYPE_LONG             =    5,   
    TYPE_ULONG            =    6,   
    TYPE_LLONG            =    7,   
    TYPE_ULLONG           =    8,   
    TYPE_FLOAT            =    9,   
    TYPE_DOUBLE           =   10,   
                                
    TYPE_CHAR_ARRAY       =   11,   
    TYPE_UCHAR_ARRAY      =   12,   
    TYPE_SHORT_ARRAY      =   13,   
    TYPE_USHORT_ARRAY     =   14,   
    TYPE_LONG_ARRAY       =   15,   
    TYPE_ULONG_ARRAY      =   16,   
    TYPE_LLONG_ARRAY      =   17,   
    TYPE_ULLONG_ARRAY     =   18,   
    TYPE_FLOAT_ARRAY      =   19,   
    TYPE_DOUBLE_ARRAY     =   20,   
                                
    TYPE_BOOL8            =   21,   
    TYPE_BOOL8_ARRAY      =   22,   
                                
    TYPE_CHAR_UTF8        =   23,   
    TYPE_CHAR_UTF16       =   24,   
    TYPE_CHAR_UTF8_ARRAY  =   25,   
    TYPE_CHAR_UTF16_ARRAY =   26    
  }Type;

  typedef struct Version
  {
    LONG major;           
    LONG minor;           
    LONG bugfix;          
    LONG patch;           
    LONG build;           
  }Version;


  typedef struct ConnectionInfo
  {
    DOUBLE minimum;             
    DOUBLE maximum;             
    DOUBLE average;             
    DOUBLE variance;            
    DOUBLE standardDeviation;   
  } ConnectionInfo;


  [id(1), helpstring("Connect to a MlpiConnection")] HRESULT Connect([in] BSTR address);

  [id(2), helpstring("Disconnect from MlpiConnection")] HRESULT Disconnect(void);

  [propget, id(3), helpstring("property IsConnected")] HRESULT IsConnected([out, retval] VARIANT_BOOL* pConnected);

  [id(4), helpstring("method TestConnection")] HRESULT TestConnection([in] LONG payload, [in] LONG numMeasurements, [out, retval] struct ConnectionInfo *connectInfo);

  [id(5), helpstring("method Delay")] HRESULT Delay([in] LONG delayMilliseconds);

  [id(6), helpstring("method GetClientCoreVersion")] HRESULT GetClientCoreVersion([out, retval] struct Version *versionInfo);

  [id(7), helpstring("method GetServerCoreVersion")] HRESULT GetServerCoreVersion([out, retval] struct Version *versionInfo);

  [propget, id(8), helpstring("property System")] HRESULT System([out, retval] ISystem** pVal);

  [propget, id(9), helpstring("property Motion")] HRESULT Motion([out, retval] IMotion** pVal);

  [propget, id(10), helpstring("property Logic")] HRESULT Logic([out, retval] ILogic** pVal);

  [propget, id(11), helpstring("property Parameter")] HRESULT Parameter([out, retval] IParameter** pVal);

  [propget, id(12), helpstring("property Watchdog")] HRESULT Watchdog([out, retval] IWatchdog** pVal);

  [propget, id(13), helpstring("property Io")] HRESULT Io([out, retval] IIo** pVal);

  [propget, id(14), helpstring("property Trace")] HRESULT Trace([out, retval] ITrace** pVal);

  [propget, id(15), helpstring("property Container")] HRESULT Container([out, retval] IContainer** pVal);

  [propget, id(16), helpstring("property Robot")] HRESULT Robot([out, retval] IRobot** pVal);
};



// -----------------------------------------------------------------------
// HISTORY
// -----------------------------------------------------------------------
// 01-Jan-2012
//   - first release
//