include/opencascade/StepKinematics_GearPair.hxx

0001 // Created on : Sat May 02 12:41:15 2020
0002 // Created by: Irina KRYLOVA
0003 // Generator:   Express (EXPRESS -> CASCADE/XSTEP Translator) V3.0
0004 // Copyright (c) Open CASCADE 2020
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _StepKinematics_GearPair_HeaderFile_
0018 #define _StepKinematics_GearPair_HeaderFile_
0019
0020 #include <Standard.hxx>
0021 #include <StepKinematics_LowOrderKinematicPairWithMotionCoupling.hxx>
0022
0023 #include <TCollection_HAsciiString.hxx>
0024 #include <StepRepr_RepresentationItem.hxx>
0025 #include <StepKinematics_KinematicJoint.hxx>
0026
0027 DEFINE_STANDARD_HANDLE(StepKinematics_GearPair, StepKinematics_LowOrderKinematicPairWithMotionCoupling)
0028
0029 //! Representation of STEP entity GearPair
0030 class StepKinematics_GearPair : public StepKinematics_LowOrderKinematicPairWithMotionCoupling
0031 {
0032 public :
0033
0034   //! default constructor
0035   Standard_EXPORT StepKinematics_GearPair();
0036
0037   //! Initialize all fields (own and inherited)
0038  Standard_EXPORT void Init(const Handle(TCollection_HAsciiString)& theRepresentationItem_Name,
0039                            const Handle(TCollection_HAsciiString)& theItemDefinedTransformation_Name,
0040                            const Standard_Boolean hasItemDefinedTransformation_Description,
0041                            const Handle(TCollection_HAsciiString)& theItemDefinedTransformation_Description,
0042                            const Handle(StepRepr_RepresentationItem)& theItemDefinedTransformation_TransformItem1,
0043                            const Handle(StepRepr_RepresentationItem)& theItemDefinedTransformation_TransformItem2,
0044                            const Handle(StepKinematics_KinematicJoint)& theKinematicPair_Joint,
0045                            const Standard_Real theRadiusFirstLink,
0046                            const Standard_Real theRadiusSecondLink,
0047                            const Standard_Real theBevel,
0048                            const Standard_Real theHelicalAngle,
0049                            const Standard_Real theGearRatio);
0050
0051   //! Returns field RadiusFirstLink
0052   Standard_EXPORT Standard_Real RadiusFirstLink() const;
0053   //! Sets field RadiusFirstLink
0054   Standard_EXPORT void SetRadiusFirstLink (const Standard_Real theRadiusFirstLink);
0055
0056   //! Returns field RadiusSecondLink
0057   Standard_EXPORT Standard_Real RadiusSecondLink() const;
0058   //! Sets field RadiusSecondLink
0059   Standard_EXPORT void SetRadiusSecondLink (const Standard_Real theRadiusSecondLink);
0060
0061   //! Returns field Bevel
0062   Standard_EXPORT Standard_Real Bevel() const;
0063   //! Sets field Bevel
0064   Standard_EXPORT void SetBevel (const Standard_Real theBevel);
0065
0066   //! Returns field HelicalAngle
0067   Standard_EXPORT Standard_Real HelicalAngle() const;
0068   //! Sets field HelicalAngle
0069   Standard_EXPORT void SetHelicalAngle (const Standard_Real theHelicalAngle);
0070
0071   //! Returns field GearRatio
0072   Standard_EXPORT Standard_Real GearRatio() const;
0073   //! Sets field GearRatio
0074   Standard_EXPORT void SetGearRatio (const Standard_Real theGearRatio);
0075
0076 DEFINE_STANDARD_RTTIEXT(StepKinematics_GearPair, StepKinematics_LowOrderKinematicPairWithMotionCoupling)
0077
0078 private:
0079   Standard_Real myRadiusFirstLink;
0080   Standard_Real myRadiusSecondLink;
0081   Standard_Real myBevel;
0082   Standard_Real myHelicalAngle;
0083   Standard_Real myGearRatio;
0084
0085 };
0086 #endif // _StepKinematics_GearPair_HeaderFile_