StepKinematics_PlanarPairWithRange Class Reference

Representation of STEP entity PlanarPairWithRange. More...

#include <StepKinematics_PlanarPairWithRange.hxx>

Inheritance diagram for StepKinematics_PlanarPairWithRange:

Public Member Functions
	StepKinematics_PlanarPairWithRange ()
	default constructor
void	Init (const occ::handle< TCollection_HAsciiString > &theRepresentationItem_Name, const occ::handle< TCollection_HAsciiString > &theItemDefinedTransformation_Name, const bool hasItemDefinedTransformation_Description, const occ::handle< TCollection_HAsciiString > &theItemDefinedTransformation_Description, const occ::handle< StepRepr_RepresentationItem > &theItemDefinedTransformation_TransformItem1, const occ::handle< StepRepr_RepresentationItem > &theItemDefinedTransformation_TransformItem2, const occ::handle< StepKinematics_KinematicJoint > &theKinematicPair_Joint, const bool theLowOrderKinematicPair_TX, const bool theLowOrderKinematicPair_TY, const bool theLowOrderKinematicPair_TZ, const bool theLowOrderKinematicPair_RX, const bool theLowOrderKinematicPair_RY, const bool theLowOrderKinematicPair_RZ, const bool hasLowerLimitActualRotation, const double theLowerLimitActualRotation, const bool hasUpperLimitActualRotation, const double theUpperLimitActualRotation, const bool hasLowerLimitActualTranslationX, const double theLowerLimitActualTranslationX, const bool hasUpperLimitActualTranslationX, const double theUpperLimitActualTranslationX, const bool hasLowerLimitActualTranslationY, const double theLowerLimitActualTranslationY, const bool hasUpperLimitActualTranslationY, const double theUpperLimitActualTranslationY)
	Initialize all fields (own and inherited).
double	LowerLimitActualRotation () const
	Returns field LowerLimitActualRotation.
void	SetLowerLimitActualRotation (const double theLowerLimitActualRotation)
	Sets field LowerLimitActualRotation.
bool	HasLowerLimitActualRotation () const
	Returns True if optional field LowerLimitActualRotation is defined.
double	UpperLimitActualRotation () const
	Returns field UpperLimitActualRotation.
void	SetUpperLimitActualRotation (const double theUpperLimitActualRotation)
	Sets field UpperLimitActualRotation.
bool	HasUpperLimitActualRotation () const
	Returns True if optional field UpperLimitActualRotation is defined.
double	LowerLimitActualTranslationX () const
	Returns field LowerLimitActualTranslationX.
void	SetLowerLimitActualTranslationX (const double theLowerLimitActualTranslationX)
	Sets field LowerLimitActualTranslationX.
bool	HasLowerLimitActualTranslationX () const
	Returns True if optional field LowerLimitActualTranslationX is defined.
double	UpperLimitActualTranslationX () const
	Returns field UpperLimitActualTranslationX.
void	SetUpperLimitActualTranslationX (const double theUpperLimitActualTranslationX)
	Sets field UpperLimitActualTranslationX.
bool	HasUpperLimitActualTranslationX () const
	Returns True if optional field UpperLimitActualTranslationX is defined.
double	LowerLimitActualTranslationY () const
	Returns field LowerLimitActualTranslationY.
void	SetLowerLimitActualTranslationY (const double theLowerLimitActualTranslationY)
	Sets field LowerLimitActualTranslationY.
bool	HasLowerLimitActualTranslationY () const
	Returns True if optional field LowerLimitActualTranslationY is defined.
double	UpperLimitActualTranslationY () const
	Returns field UpperLimitActualTranslationY.
void	SetUpperLimitActualTranslationY (const double theUpperLimitActualTranslationY)
	Sets field UpperLimitActualTranslationY.
bool	HasUpperLimitActualTranslationY () const
	Returns True if optional field UpperLimitActualTranslationY is defined.
Public Member Functions inherited from StepKinematics_PlanarPair
	StepKinematics_PlanarPair ()
	default constructor
Public Member Functions inherited from StepKinematics_LowOrderKinematicPair
	StepKinematics_LowOrderKinematicPair ()
	default constructor
void	Init (const occ::handle< TCollection_HAsciiString > &theRepresentationItem_Name, const occ::handle< TCollection_HAsciiString > &theItemDefinedTransformation_Name, const bool hasItemDefinedTransformation_Description, const occ::handle< TCollection_HAsciiString > &theItemDefinedTransformation_Description, const occ::handle< StepRepr_RepresentationItem > &theItemDefinedTransformation_TransformItem1, const occ::handle< StepRepr_RepresentationItem > &theItemDefinedTransformation_TransformItem2, const occ::handle< StepKinematics_KinematicJoint > &theKinematicPair_Joint, const bool theTX, const bool theTY, const bool theTZ, const bool theRX, const bool theRY, const bool theRZ)
	Initialize all fields (own and inherited).
bool	TX () const
	Returns field TX.
void	SetTX (const bool theTX)
	Sets field TX.
bool	TY () const
	Returns field TY.
void	SetTY (const bool theTY)
	Sets field TY.
bool	TZ () const
	Returns field TZ.
void	SetTZ (const bool theTZ)
	Sets field TZ.
bool	RX () const
	Returns field RX.
void	SetRX (const bool theRX)
	Sets field RX.
bool	RY () const
	Returns field RY.
void	SetRY (const bool theRY)
	Sets field RY.
bool	RZ () const
	Returns field RZ.
void	SetRZ (const bool theRZ)
	Sets field RZ.
Public Member Functions inherited from StepKinematics_KinematicPair
	StepKinematics_KinematicPair ()
	default constructor
void	Init (const occ::handle< TCollection_HAsciiString > &theRepresentationItem_Name, const occ::handle< TCollection_HAsciiString > &theItemDefinedTransformation_Name, const bool hasItemDefinedTransformation_Description, const occ::handle< TCollection_HAsciiString > &theItemDefinedTransformation_Description, const occ::handle< StepRepr_RepresentationItem > &theItemDefinedTransformation_TransformItem1, const occ::handle< StepRepr_RepresentationItem > &theItemDefinedTransformation_TransformItem2, const occ::handle< StepKinematics_KinematicJoint > &theJoint)
	Initialize all fields (own and inherited).
occ::handle< StepRepr_ItemDefinedTransformation >	ItemDefinedTransformation () const
	Returns data for supertype ItemDefinedTransformation.
void	SetItemDefinedTransformation (const occ::handle< StepRepr_ItemDefinedTransformation > &theItemDefinedTransformation)
	Sets data for supertype ItemDefinedTransformation.
occ::handle< StepKinematics_KinematicJoint >	Joint () const
	Returns field Joint.
void	SetJoint (const occ::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 occ::handle< TCollection_HAsciiString > &aName)
void	SetName (const occ::handle< TCollection_HAsciiString > &aName)
occ::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 ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
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 PlanarPairWithRange.

Constructor & Destructor Documentation

StepKinematics_PlanarPairWithRange()

StepKinematics_PlanarPairWithRange::StepKinematics_PlanarPairWithRange

(

)

default constructor

Member Function Documentation

HasLowerLimitActualRotation()

bool StepKinematics_PlanarPairWithRange::HasLowerLimitActualRotation

(

)

const

Returns True if optional field LowerLimitActualRotation is defined.

HasLowerLimitActualTranslationX()

bool StepKinematics_PlanarPairWithRange::HasLowerLimitActualTranslationX

(

)

const

Returns True if optional field LowerLimitActualTranslationX is defined.

HasLowerLimitActualTranslationY()

bool StepKinematics_PlanarPairWithRange::HasLowerLimitActualTranslationY

(

)

const

Returns True if optional field LowerLimitActualTranslationY is defined.

HasUpperLimitActualRotation()

bool StepKinematics_PlanarPairWithRange::HasUpperLimitActualRotation

(

)

const

Returns True if optional field UpperLimitActualRotation is defined.

HasUpperLimitActualTranslationX()

bool StepKinematics_PlanarPairWithRange::HasUpperLimitActualTranslationX

(

)

const

Returns True if optional field UpperLimitActualTranslationX is defined.

HasUpperLimitActualTranslationY()

bool StepKinematics_PlanarPairWithRange::HasUpperLimitActualTranslationY

(

)

const

Returns True if optional field UpperLimitActualTranslationY is defined.

Init()

void StepKinematics_PlanarPairWithRange::Init	(	const occ::handle< TCollection_HAsciiString > &	theRepresentationItem_Name,
		const occ::handle< TCollection_HAsciiString > &	theItemDefinedTransformation_Name,
		const bool	hasItemDefinedTransformation_Description,
		const occ::handle< TCollection_HAsciiString > &	theItemDefinedTransformation_Description,
		const occ::handle< StepRepr_RepresentationItem > &	theItemDefinedTransformation_TransformItem1,
		const occ::handle< StepRepr_RepresentationItem > &	theItemDefinedTransformation_TransformItem2,
		const occ::handle< StepKinematics_KinematicJoint > &	theKinematicPair_Joint,
		const bool	theLowOrderKinematicPair_TX,
		const bool	theLowOrderKinematicPair_TY,
		const bool	theLowOrderKinematicPair_TZ,
		const bool	theLowOrderKinematicPair_RX,
		const bool	theLowOrderKinematicPair_RY,
		const bool	theLowOrderKinematicPair_RZ,
		const bool	hasLowerLimitActualRotation,
		const double	theLowerLimitActualRotation,
		const bool	hasUpperLimitActualRotation,
		const double	theUpperLimitActualRotation,
		const bool	hasLowerLimitActualTranslationX,
		const double	theLowerLimitActualTranslationX,
		const bool	hasUpperLimitActualTranslationX,
		const double	theUpperLimitActualTranslationX,
		const bool	hasLowerLimitActualTranslationY,
		const double	theLowerLimitActualTranslationY,
		const bool	hasUpperLimitActualTranslationY,
		const double	theUpperLimitActualTranslationY )

Initialize all fields (own and inherited).

LowerLimitActualRotation()

double StepKinematics_PlanarPairWithRange::LowerLimitActualRotation

(

)

const

Returns field LowerLimitActualRotation.

LowerLimitActualTranslationX()

double StepKinematics_PlanarPairWithRange::LowerLimitActualTranslationX

(

)

const

Returns field LowerLimitActualTranslationX.

LowerLimitActualTranslationY()

double StepKinematics_PlanarPairWithRange::LowerLimitActualTranslationY

(

)

const

Returns field LowerLimitActualTranslationY.

SetLowerLimitActualRotation()

void StepKinematics_PlanarPairWithRange::SetLowerLimitActualRotation

(

const double

theLowerLimitActualRotation

)

Sets field LowerLimitActualRotation.

SetLowerLimitActualTranslationX()

void StepKinematics_PlanarPairWithRange::SetLowerLimitActualTranslationX

(

const double

theLowerLimitActualTranslationX

)

Sets field LowerLimitActualTranslationX.

SetLowerLimitActualTranslationY()

void StepKinematics_PlanarPairWithRange::SetLowerLimitActualTranslationY

(

const double

theLowerLimitActualTranslationY

)

Sets field LowerLimitActualTranslationY.

SetUpperLimitActualRotation()

void StepKinematics_PlanarPairWithRange::SetUpperLimitActualRotation

(

const double

theUpperLimitActualRotation

)

Sets field UpperLimitActualRotation.

SetUpperLimitActualTranslationX()

void StepKinematics_PlanarPairWithRange::SetUpperLimitActualTranslationX

(

const double

theUpperLimitActualTranslationX

)

Sets field UpperLimitActualTranslationX.

SetUpperLimitActualTranslationY()

void StepKinematics_PlanarPairWithRange::SetUpperLimitActualTranslationY

(

const double

theUpperLimitActualTranslationY

)

Sets field UpperLimitActualTranslationY.

UpperLimitActualRotation()

double StepKinematics_PlanarPairWithRange::UpperLimitActualRotation

(

)

const

Returns field UpperLimitActualRotation.

UpperLimitActualTranslationX()

double StepKinematics_PlanarPairWithRange::UpperLimitActualTranslationX

(

)

const

Returns field UpperLimitActualTranslationX.

UpperLimitActualTranslationY()

double StepKinematics_PlanarPairWithRange::UpperLimitActualTranslationY

(

)

const

Returns field UpperLimitActualTranslationY.

---

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

• StepKinematics_PlanarPairWithRange.hxx