IAxis.idl

Go to the documentation of this file.

// -----------------------------------------------------------------------
// MLPI - <IAxis.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(51FDD884-13B4-4067-8FFB-70C3164544AF),
  dual,
  nonextensible,
  helpstring("IAxis Interface"),
  pointer_default(unique)
]
interface IAxis : IDispatch{


  [propget, id(1), helpstring("Property Movement")] HRESULT Movement([out, retval] IMovement** Movement);
#if defined(WIN32) || defined(WIN64)
  [propget, id(2), helpstring("Property AxisRef")] HRESULT AxisRef([out, retval] struct AxisRef* axis);
#endif

  [id(3), helpstring("Method GetActualPosition")] HRESULT GetActualPosition([out,retval] DOUBLE* position);

  [id(4), helpstring("Method GetActualVelocity")] HRESULT GetActualVelocity([out, retval] DOUBLE* velocity);

  [id(5), helpstring("Method GetActualAcceleration")] HRESULT GetActualAcceleration([out, retval] DOUBLE* acceleration);

  [id(6), helpstring("Method GetActualTorque")] HRESULT GetActualTorque([out, retval] DOUBLE* torque);

  [id(7), helpstring("Method GetInterpolatedPosition")] HRESULT GetInterpolatedPosition([out, retval] DOUBLE* position);

  [id(8), helpstring("Method GetInterpolatedVelocity")] HRESULT GetInterpolatedVelocity([out, retval] DOUBLE* velocity);

  [id(9), helpstring("Method GetInterpolatedTorque")] HRESULT GetInterpolatedTorque([out, retval] DOUBLE* torque);

  [id(10), helpstring("Method GetDiagnosisNumber")] HRESULT GetDiagnosisNumber([out, retval] LONG* diagnosisNumber);

  [id(11), helpstring("Method GetDiagnosisText")] HRESULT GetDiagnosisText([out, retval] BSTR* diag);

  [id(12), helpstring("Method LoadDefaultParameters")] HRESULT LoadDefaultParameters(void);

  [id(13), helpstring("Method ClearError")] HRESULT ClearError(void);

  [id(14), helpstring("Method GetName")] HRESULT GetName([out, retval] BSTR* name);
  
  [id(15), helpstring("Method SetName")] HRESULT SetName([in] BSTR name);

  [id(18), helpstring("Method GetModulo")] HRESULT GetModulo([out, retval] DOUBLE* modulo);
  
  [id(19), helpstring("Method SetModulo")] HRESULT SetModulo([in] DOUBLE modulo);

  [id(20), helpstring("Method GetPositionLimitPos")] HRESULT GetPositionLimitPos([out,retval ] DOUBLE *positionLimit);

  [id(21), helpstring("Method SetPositionLimitPos")] HRESULT SetPositionLimitPos([in] DOUBLE positionLimit);

  [id(22), helpstring("Method GetPositionLimitNeg")] HRESULT GetPositionLimitNeg ([out,retval ] DOUBLE *positionLimit);

  [id(23), helpstring("Method SetPositionLimitNeg")] HRESULT SetPositionLimitNeg([in] DOUBLE positionLimit);

  [id(24), helpstring("Method GetVelocityLimitPos")] HRESULT GetVelocityLimitPos([out, retval] DOUBLE* velocityLimit);

  [id(25), helpstring("Method SetVelocityLimitPos")] HRESULT SetVelocityLimitPos([in] DOUBLE velocityLimit);

  [id(26), helpstring("Method GetVelocityLimitNeg")] HRESULT GetVelocityLimitNeg([out, retval] DOUBLE* velocityLimit);

  [id(27), helpstring("Method SetVelocityLimitNeg")] HRESULT SetVelocityLimitNeg([in] DOUBLE velocityLimit);

  [id(28), helpstring("Method GetAccelerationLimitBip")] HRESULT GetAccelerationLimitBip ([out,retval ] DOUBLE *accelerationLimit);

  [id(29), helpstring("Method SetAccelerationLimitBip")] HRESULT SetAccelerationLimitBip([in] DOUBLE accelerationLimit);

  [id(30), helpstring("Method GetJerkLimitBip")] HRESULT GetJerkLimitBip([out, retval] DOUBLE* jerkLimit);

  [id(31), helpstring("Method SetJerkLimitBip")] HRESULT SetJerkLimitBip([in] DOUBLE jerkLimit);

  [id(32), helpstring("Method GetTorqueLimitBip")] HRESULT GetTorqueLimitBip([out, retval] DOUBLE* torqueLimit);
  
  [id(33), helpstring("Method SetTorqueLimitBip")] HRESULT SetTorqueLimitBip([in] DOUBLE torqueLimit);

  [id(34), helpstring("Method GetSlaveDriveFeedTravel")] HRESULT GetSlaveDriveFeedTravel([out, retval] DOUBLE* feedtravel);
   
  [id(35), helpstring("Method SetSlaveDriveFeedTravel")] HRESULT SetSlaveDriveFeedTravel([in] DOUBLE feedtravel);

  [id(36), helpstring("Method GetState")] HRESULT GetState([out, retval] LONG* state);
  
  [id(37), helpstring("Method GetStateExtended")] HRESULT GetStateExtended([out, retval] LONG* stateExtended);
  
  [id(38), helpstring("Method GetAxisType")] HRESULT GetAxisType([out, retval] SHORT* type);

  [id(39), helpstring("Method GetCondition")] HRESULT GetCondition([out, retval] enum AxisCondition* condition);
    
  [id(40), helpstring("Method SetCondition")] HRESULT SetCondition([in] enum AxisCondition condition);
};



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