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,
0028                        StepKinematics_LowOrderKinematicPairWithMotionCoupling)
0029
0030 //! Representation of STEP entity GearPair
0031 class StepKinematics_GearPair : public StepKinematics_LowOrderKinematicPairWithMotionCoupling
0032 {
0033 public:
0034   //! default constructor
0035   Standard_EXPORT StepKinematics_GearPair();
0036
0037   //! Initialize all fields (own and inherited)
0038   Standard_EXPORT void Init(
0039     const Handle(TCollection_HAsciiString)&      theRepresentationItem_Name,
0040     const Handle(TCollection_HAsciiString)&      theItemDefinedTransformation_Name,
0041     const Standard_Boolean                       hasItemDefinedTransformation_Description,
0042     const Handle(TCollection_HAsciiString)&      theItemDefinedTransformation_Description,
0043     const Handle(StepRepr_RepresentationItem)&   theItemDefinedTransformation_TransformItem1,
0044     const Handle(StepRepr_RepresentationItem)&   theItemDefinedTransformation_TransformItem2,
0045     const Handle(StepKinematics_KinematicJoint)& theKinematicPair_Joint,
0046     const Standard_Real                          theRadiusFirstLink,
0047     const Standard_Real                          theRadiusSecondLink,
0048     const Standard_Real                          theBevel,
0049     const Standard_Real                          theHelicalAngle,
0050     const Standard_Real                          theGearRatio);
0051
0052   //! Returns field RadiusFirstLink
0053   Standard_EXPORT Standard_Real RadiusFirstLink() const;
0054   //! Sets field RadiusFirstLink
0055   Standard_EXPORT void SetRadiusFirstLink(const Standard_Real theRadiusFirstLink);
0056
0057   //! Returns field RadiusSecondLink
0058   Standard_EXPORT Standard_Real RadiusSecondLink() const;
0059   //! Sets field RadiusSecondLink
0060   Standard_EXPORT void SetRadiusSecondLink(const Standard_Real theRadiusSecondLink);
0061
0062   //! Returns field Bevel
0063   Standard_EXPORT Standard_Real Bevel() const;
0064   //! Sets field Bevel
0065   Standard_EXPORT void SetBevel(const Standard_Real theBevel);
0066
0067   //! Returns field HelicalAngle
0068   Standard_EXPORT Standard_Real HelicalAngle() const;
0069   //! Sets field HelicalAngle
0070   Standard_EXPORT void SetHelicalAngle(const Standard_Real theHelicalAngle);
0071
0072   //! Returns field GearRatio
0073   Standard_EXPORT Standard_Real GearRatio() const;
0074   //! Sets field GearRatio
0075   Standard_EXPORT void SetGearRatio(const Standard_Real theGearRatio);
0076
0077   DEFINE_STANDARD_RTTIEXT(StepKinematics_GearPair,
0078                           StepKinematics_LowOrderKinematicPairWithMotionCoupling)
0079
0080 private:
0081   Standard_Real myRadiusFirstLink;
0082   Standard_Real myRadiusSecondLink;
0083   Standard_Real myBevel;
0084   Standard_Real myHelicalAngle;
0085   Standard_Real myGearRatio;
0086 };
0087 #endif // _StepKinematics_GearPair_HeaderFile_