OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    StepKinematics_PointOnPlanarCurvePairWithRange Class Reference

    Representation of STEP entity PointOnPlanarCurvePairWithRange. More...

    #include <StepKinematics_PointOnPlanarCurvePairWithRange.hxx>

    Inheritance diagram for StepKinematics_PointOnPlanarCurvePairWithRange:

    Public Member Functions

     StepKinematics_PointOnPlanarCurvePairWithRange ()
     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 occ::handle< StepGeom_Curve > &thePointOnPlanarCurvePair_PairCurve, const bool thePointOnPlanarCurvePair_Orientation, const occ::handle< StepGeom_TrimmedCurve > &theRangeOnPairCurve, const bool hasLowerLimitYaw, const double theLowerLimitYaw, const bool hasUpperLimitYaw, const double theUpperLimitYaw, const bool hasLowerLimitPitch, const double theLowerLimitPitch, const bool hasUpperLimitPitch, const double theUpperLimitPitch, const bool hasLowerLimitRoll, const double theLowerLimitRoll, const bool hasUpperLimitRoll, const double theUpperLimitRoll)
     Initialize all fields (own and inherited).
    occ::handle< StepGeom_TrimmedCurveRangeOnPairCurve () const
     Returns field RangeOnPairCurve.
    void SetRangeOnPairCurve (const occ::handle< StepGeom_TrimmedCurve > &theRangeOnPairCurve)
     Sets field RangeOnPairCurve.
    double LowerLimitYaw () const
     Returns field LowerLimitYaw.
    void SetLowerLimitYaw (const double theLowerLimitYaw)
     Sets field LowerLimitYaw.
    bool HasLowerLimitYaw () const
     Returns True if optional field LowerLimitYaw is defined.
    double UpperLimitYaw () const
     Returns field UpperLimitYaw.
    void SetUpperLimitYaw (const double theUpperLimitYaw)
     Sets field UpperLimitYaw.
    bool HasUpperLimitYaw () const
     Returns True if optional field UpperLimitYaw is defined.
    double LowerLimitPitch () const
     Returns field LowerLimitPitch.
    void SetLowerLimitPitch (const double theLowerLimitPitch)
     Sets field LowerLimitPitch.
    bool HasLowerLimitPitch () const
     Returns True if optional field LowerLimitPitch is defined.
    double UpperLimitPitch () const
     Returns field UpperLimitPitch.
    void SetUpperLimitPitch (const double theUpperLimitPitch)
     Sets field UpperLimitPitch.
    bool HasUpperLimitPitch () const
     Returns True if optional field UpperLimitPitch is defined.
    double LowerLimitRoll () const
     Returns field LowerLimitRoll.
    void SetLowerLimitRoll (const double theLowerLimitRoll)
     Sets field LowerLimitRoll.
    bool HasLowerLimitRoll () const
     Returns True if optional field LowerLimitRoll is defined.
    double UpperLimitRoll () const
     Returns field UpperLimitRoll.
    void SetUpperLimitRoll (const double theUpperLimitRoll)
     Sets field UpperLimitRoll.
    bool HasUpperLimitRoll () const
     Returns True if optional field UpperLimitRoll is defined.
    Public Member Functions inherited from StepKinematics_PointOnPlanarCurvePair
     StepKinematics_PointOnPlanarCurvePair ()
     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 occ::handle< StepGeom_Curve > &thePairCurve, const bool theOrientation)
     Initialize all fields (own and inherited).
    occ::handle< StepGeom_CurvePairCurve () const
     Returns field PairCurve.
    void SetPairCurve (const occ::handle< StepGeom_Curve > &thePairCurve)
     Sets field PairCurve.
    bool Orientation () const
     Returns field Orientation.
    void SetOrientation (const bool theOrientation)
     Sets field Orientation.
    Public Member Functions inherited from StepKinematics_HighOrderKinematicPair
     StepKinematics_HighOrderKinematicPair ()
     default constructor
    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_ItemDefinedTransformationItemDefinedTransformation () const
     Returns data for supertype ItemDefinedTransformation.
    void SetItemDefinedTransformation (const occ::handle< StepRepr_ItemDefinedTransformation > &theItemDefinedTransformation)
     Sets data for supertype ItemDefinedTransformation.
    occ::handle< StepKinematics_KinematicJointJoint () 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_HAsciiStringName () const
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transientoperator= (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_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.
    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.

    Data Fields

    DEFINE_STANDARD_RTTIEXT(StepKinematics_PointOnPlanarCurvePairWithRange, StepKinematics_PointOnPlanarCurvePair) private double myLowerLimitYaw
     optional
    double myUpperLimitYaw
     optional
    double myLowerLimitPitch
     optional
    double myUpperLimitPitch
     optional
    double myLowerLimitRoll
     optional
    double myUpperLimitRoll
     optional
    bool defLowerLimitYaw
     flag "is LowerLimitYaw defined"
    bool defUpperLimitYaw
     flag "is UpperLimitYaw defined"
    bool defLowerLimitPitch
     flag "is LowerLimitPitch defined"
    bool defUpperLimitPitch
     flag "is UpperLimitPitch defined"
    bool defLowerLimitRoll
     flag "is LowerLimitRoll defined"
    bool defUpperLimitRoll
     flag "is UpperLimitRoll defined"
    Data Fields inherited from StepKinematics_PointOnPlanarCurvePair
    DEFINE_STANDARD_RTTIEXT(StepKinematics_PointOnPlanarCurvePair, StepKinematics_HighOrderKinematicPair) private bool myOrientation

    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 PointOnPlanarCurvePairWithRange.

    Constructor & Destructor Documentation

    ◆ StepKinematics_PointOnPlanarCurvePairWithRange()

    StepKinematics_PointOnPlanarCurvePairWithRange::StepKinematics_PointOnPlanarCurvePairWithRange ( )

    default constructor

    Member Function Documentation

    ◆ HasLowerLimitPitch()

    bool StepKinematics_PointOnPlanarCurvePairWithRange::HasLowerLimitPitch ( ) const

    Returns True if optional field LowerLimitPitch is defined.

    ◆ HasLowerLimitRoll()

    bool StepKinematics_PointOnPlanarCurvePairWithRange::HasLowerLimitRoll ( ) const

    Returns True if optional field LowerLimitRoll is defined.

    ◆ HasLowerLimitYaw()

    bool StepKinematics_PointOnPlanarCurvePairWithRange::HasLowerLimitYaw ( ) const

    Returns True if optional field LowerLimitYaw is defined.

    ◆ HasUpperLimitPitch()

    bool StepKinematics_PointOnPlanarCurvePairWithRange::HasUpperLimitPitch ( ) const

    Returns True if optional field UpperLimitPitch is defined.

    ◆ HasUpperLimitRoll()

    bool StepKinematics_PointOnPlanarCurvePairWithRange::HasUpperLimitRoll ( ) const

    Returns True if optional field UpperLimitRoll is defined.

    ◆ HasUpperLimitYaw()

    bool StepKinematics_PointOnPlanarCurvePairWithRange::HasUpperLimitYaw ( ) const

    Returns True if optional field UpperLimitYaw is defined.

    ◆ Init()

    void StepKinematics_PointOnPlanarCurvePairWithRange::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 occ::handle< StepGeom_Curve > & thePointOnPlanarCurvePair_PairCurve,
    const bool thePointOnPlanarCurvePair_Orientation,
    const occ::handle< StepGeom_TrimmedCurve > & theRangeOnPairCurve,
    const bool hasLowerLimitYaw,
    const double theLowerLimitYaw,
    const bool hasUpperLimitYaw,
    const double theUpperLimitYaw,
    const bool hasLowerLimitPitch,
    const double theLowerLimitPitch,
    const bool hasUpperLimitPitch,
    const double theUpperLimitPitch,
    const bool hasLowerLimitRoll,
    const double theLowerLimitRoll,
    const bool hasUpperLimitRoll,
    const double theUpperLimitRoll )

    Initialize all fields (own and inherited).

    ◆ LowerLimitPitch()

    double StepKinematics_PointOnPlanarCurvePairWithRange::LowerLimitPitch ( ) const

    Returns field LowerLimitPitch.

    ◆ LowerLimitRoll()

    double StepKinematics_PointOnPlanarCurvePairWithRange::LowerLimitRoll ( ) const

    Returns field LowerLimitRoll.

    ◆ LowerLimitYaw()

    double StepKinematics_PointOnPlanarCurvePairWithRange::LowerLimitYaw ( ) const

    Returns field LowerLimitYaw.

    ◆ RangeOnPairCurve()

    occ::handle< StepGeom_TrimmedCurve > StepKinematics_PointOnPlanarCurvePairWithRange::RangeOnPairCurve ( ) const

    Returns field RangeOnPairCurve.

    ◆ SetLowerLimitPitch()

    void StepKinematics_PointOnPlanarCurvePairWithRange::SetLowerLimitPitch ( const double theLowerLimitPitch)

    Sets field LowerLimitPitch.

    ◆ SetLowerLimitRoll()

    void StepKinematics_PointOnPlanarCurvePairWithRange::SetLowerLimitRoll ( const double theLowerLimitRoll)

    Sets field LowerLimitRoll.

    ◆ SetLowerLimitYaw()

    void StepKinematics_PointOnPlanarCurvePairWithRange::SetLowerLimitYaw ( const double theLowerLimitYaw)

    Sets field LowerLimitYaw.

    ◆ SetRangeOnPairCurve()

    void StepKinematics_PointOnPlanarCurvePairWithRange::SetRangeOnPairCurve ( const occ::handle< StepGeom_TrimmedCurve > & theRangeOnPairCurve)

    Sets field RangeOnPairCurve.

    ◆ SetUpperLimitPitch()

    void StepKinematics_PointOnPlanarCurvePairWithRange::SetUpperLimitPitch ( const double theUpperLimitPitch)

    Sets field UpperLimitPitch.

    ◆ SetUpperLimitRoll()

    void StepKinematics_PointOnPlanarCurvePairWithRange::SetUpperLimitRoll ( const double theUpperLimitRoll)

    Sets field UpperLimitRoll.

    ◆ SetUpperLimitYaw()

    void StepKinematics_PointOnPlanarCurvePairWithRange::SetUpperLimitYaw ( const double theUpperLimitYaw)

    Sets field UpperLimitYaw.

    ◆ UpperLimitPitch()

    double StepKinematics_PointOnPlanarCurvePairWithRange::UpperLimitPitch ( ) const

    Returns field UpperLimitPitch.

    ◆ UpperLimitRoll()

    double StepKinematics_PointOnPlanarCurvePairWithRange::UpperLimitRoll ( ) const

    Returns field UpperLimitRoll.

    ◆ UpperLimitYaw()

    double StepKinematics_PointOnPlanarCurvePairWithRange::UpperLimitYaw ( ) const

    Returns field UpperLimitYaw.

    Field Documentation

    ◆ defLowerLimitPitch

    bool StepKinematics_PointOnPlanarCurvePairWithRange::defLowerLimitPitch

    flag "is LowerLimitPitch defined"

    ◆ defLowerLimitRoll

    bool StepKinematics_PointOnPlanarCurvePairWithRange::defLowerLimitRoll

    flag "is LowerLimitRoll defined"

    ◆ defLowerLimitYaw

    bool StepKinematics_PointOnPlanarCurvePairWithRange::defLowerLimitYaw

    flag "is LowerLimitYaw defined"

    ◆ defUpperLimitPitch

    bool StepKinematics_PointOnPlanarCurvePairWithRange::defUpperLimitPitch

    flag "is UpperLimitPitch defined"

    ◆ defUpperLimitRoll

    bool StepKinematics_PointOnPlanarCurvePairWithRange::defUpperLimitRoll

    flag "is UpperLimitRoll defined"

    ◆ defUpperLimitYaw

    bool StepKinematics_PointOnPlanarCurvePairWithRange::defUpperLimitYaw

    flag "is UpperLimitYaw defined"

    ◆ myLowerLimitPitch

    double StepKinematics_PointOnPlanarCurvePairWithRange::myLowerLimitPitch

    optional

    ◆ myLowerLimitRoll

    double StepKinematics_PointOnPlanarCurvePairWithRange::myLowerLimitRoll

    optional

    ◆ myLowerLimitYaw

    DEFINE_STANDARD_RTTIEXT (StepKinematics_PointOnPlanarCurvePairWithRange, StepKinematics_PointOnPlanarCurvePair) private double StepKinematics_PointOnPlanarCurvePairWithRange::myLowerLimitYaw

    optional

    ◆ myUpperLimitPitch

    double StepKinematics_PointOnPlanarCurvePairWithRange::myUpperLimitPitch

    optional

    ◆ myUpperLimitRoll

    double StepKinematics_PointOnPlanarCurvePairWithRange::myUpperLimitRoll

    optional

    ◆ myUpperLimitYaw

    double StepKinematics_PointOnPlanarCurvePairWithRange::myUpperLimitYaw

    optional


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