StepKinematics_ScrewPair Class Reference

Representation of STEP entity ScrewPair. More...

#include <StepKinematics_ScrewPair.hxx>

Inheritance diagram for StepKinematics_ScrewPair:

Public Member Functions
	StepKinematics_ScrewPair ()
	default constructor
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)
Standard_Real	Pitch () const
	Returns field Pitch.
void	SetPitch (const Standard_Real thePitch)
	Sets field Pitch.
Public Member Functions inherited from StepKinematics_LowOrderKinematicPairWithMotionCoupling
	StepKinematics_LowOrderKinematicPairWithMotionCoupling ()
	default constructor
Public Member Functions inherited from StepKinematics_KinematicPair
	StepKinematics_KinematicPair ()
	default constructor
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)
Handle< StepRepr_ItemDefinedTransformation >	ItemDefinedTransformation () const
	Returns data for supertype ItemDefinedTransformation.
void	SetItemDefinedTransformation (const Handle< StepRepr_ItemDefinedTransformation > &theItemDefinedTransformation)
	Sets data for supertype ItemDefinedTransformation.
Handle< StepKinematics_KinematicJoint >	Joint () const
	Returns field Joint.
void	SetJoint (const Handle< StepKinematics_KinematicJoint > &theJoint)
	Sets field Joint.
Public Member Functions inherited from StepGeom_GeometricRepresentationItem
	StepGeom_GeometricRepresentationItem ()
	Returns a GeometricRepresentationItem.
Public Member Functions inherited from StepRepr_RepresentationItem
	StepRepr_RepresentationItem ()
	Returns a RepresentationItem.
void	Init (const Handle< TCollection_HAsciiString > &aName)
void	SetName (const Handle< TCollection_HAsciiString > &aName)
Handle< TCollection_HAsciiString >	Name () const
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
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.
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.
Standard_Transient *	This () 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.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

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

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:

• StepKinematics_ScrewPair.hxx