Open CASCADE Technology  7.7.0
Public Member Functions

StepKinematics_ScrewPair Class Reference

Representation of STEP entity ScrewPair. More...

#include <StepKinematics_ScrewPair.hxx>

Inheritance diagram for StepKinematics_ScrewPair:
Inheritance graph
[legend]

Public Member Functions

 StepKinematics_ScrewPair ()
 default constructor More...
 
void Init (const Handle< TCollection_HAsciiString > &theRepresentationItem_Name, const Handle< TCollection_HAsciiString > &theItemDefinedTransformation_Name, const Standard_Boolean hasItemDefinedTransformation_Description, const Handle< TCollection_HAsciiString > &theItemDefinedTransformation_Description, const Handle< StepRepr_RepresentationItem > &theItemDefinedTransformation_TransformItem1, const Handle< StepRepr_RepresentationItem > &theItemDefinedTransformation_TransformItem2, const Handle< StepKinematics_KinematicJoint > &theKinematicPair_Joint, const Standard_Real thePitch)
 Initialize all fields (own and inherited) More...
 
Standard_Real Pitch () const
 Returns field Pitch. More...
 
void SetPitch (const Standard_Real thePitch)
 Sets field Pitch. More...
 
- Public Member Functions inherited from StepKinematics_LowOrderKinematicPairWithMotionCoupling
 StepKinematics_LowOrderKinematicPairWithMotionCoupling ()
 default constructor More...
 
- Public Member Functions inherited from StepKinematics_KinematicPair
 StepKinematics_KinematicPair ()
 default constructor More...
 
void Init (const Handle< TCollection_HAsciiString > &theRepresentationItem_Name, const Handle< TCollection_HAsciiString > &theItemDefinedTransformation_Name, const Standard_Boolean hasItemDefinedTransformation_Description, const Handle< TCollection_HAsciiString > &theItemDefinedTransformation_Description, const Handle< StepRepr_RepresentationItem > &theItemDefinedTransformation_TransformItem1, const Handle< StepRepr_RepresentationItem > &theItemDefinedTransformation_TransformItem2, const Handle< StepKinematics_KinematicJoint > &theJoint)
 Initialize all fields (own and inherited) More...
 
Handle< StepRepr_ItemDefinedTransformationItemDefinedTransformation () const
 Returns data for supertype ItemDefinedTransformation. More...
 
void SetItemDefinedTransformation (const Handle< StepRepr_ItemDefinedTransformation > &theItemDefinedTransformation)
 Sets data for supertype ItemDefinedTransformation. More...
 
Handle< StepKinematics_KinematicJointJoint () const
 Returns field Joint. More...
 
void SetJoint (const Handle< StepKinematics_KinematicJoint > &theJoint)
 Sets field Joint. More...
 
- Public Member Functions inherited from StepGeom_GeometricRepresentationItem
 StepGeom_GeometricRepresentationItem ()
 Returns a GeometricRepresentationItem. More...
 
- Public Member Functions inherited from StepRepr_RepresentationItem
 StepRepr_RepresentationItem ()
 Returns a RepresentationItem. More...
 
void Init (const Handle< TCollection_HAsciiString > &aName)
 
void SetName (const Handle< TCollection_HAsciiString > &aName)
 
Handle< TCollection_HAsciiStringName () const
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

Representation of STEP entity ScrewPair.

Constructor & Destructor Documentation

◆ StepKinematics_ScrewPair()

StepKinematics_ScrewPair::StepKinematics_ScrewPair ( )

default constructor

Member Function Documentation

◆ Init()

void StepKinematics_ScrewPair::Init ( const Handle< TCollection_HAsciiString > &  theRepresentationItem_Name,
const Handle< TCollection_HAsciiString > &  theItemDefinedTransformation_Name,
const Standard_Boolean  hasItemDefinedTransformation_Description,
const Handle< TCollection_HAsciiString > &  theItemDefinedTransformation_Description,
const Handle< StepRepr_RepresentationItem > &  theItemDefinedTransformation_TransformItem1,
const Handle< StepRepr_RepresentationItem > &  theItemDefinedTransformation_TransformItem2,
const Handle< StepKinematics_KinematicJoint > &  theKinematicPair_Joint,
const Standard_Real  thePitch 
)

Initialize all fields (own and inherited)

◆ Pitch()

Standard_Real StepKinematics_ScrewPair::Pitch ( ) const

Returns field Pitch.

◆ SetPitch()

void StepKinematics_ScrewPair::SetPitch ( const Standard_Real  thePitch)

Sets field Pitch.


The documentation for this class was generated from the following file: