Access object to store dimension and tolerance. More...

#include <XCAFDimTolObjects_GeomToleranceObject.hxx>

Inheritance diagram for XCAFDimTolObjects_GeomToleranceObject:

Public Member Functions
	XCAFDimTolObjects_GeomToleranceObject ()

	XCAFDimTolObjects_GeomToleranceObject (const Handle< XCAFDimTolObjects_GeomToleranceObject > &theObj)

Handle< TCollection_HAsciiString >	GetSemanticName () const
	Returns semantic name.

void	SetSemanticName (const Handle< TCollection_HAsciiString > &theName)
	Sets semantic name.

void	SetType (const XCAFDimTolObjects_GeomToleranceType theType)
	Sets type of the object.

XCAFDimTolObjects_GeomToleranceType	GetType () const
	Returns type of the object.

void	SetTypeOfValue (const XCAFDimTolObjects_GeomToleranceTypeValue theTypeOfValue)
	Sets type of tolerance value.

XCAFDimTolObjects_GeomToleranceTypeValue	GetTypeOfValue () const
	Returns type of tolerance value.

void	SetValue (const Standard_Real theValue)
	Sets tolerance value.

Standard_Real	GetValue () const
	Returns tolerance value.

void	SetMaterialRequirementModifier (const XCAFDimTolObjects_GeomToleranceMatReqModif theMatReqModif)
	Sets material requirement of the tolerance.

XCAFDimTolObjects_GeomToleranceMatReqModif	GetMaterialRequirementModifier () const
	Returns material requirement of the tolerance.

void	SetZoneModifier (const XCAFDimTolObjects_GeomToleranceZoneModif theZoneModif)
	Sets tolerance zone.

XCAFDimTolObjects_GeomToleranceZoneModif	GetZoneModifier () const
	Returns tolerance zone.

void	SetValueOfZoneModifier (const Standard_Real theValue)
	Sets value associated with tolerance zone.

Standard_Real	GetValueOfZoneModifier () const
	Returns value associated with tolerance zone.

void	SetModifiers (const XCAFDimTolObjects_GeomToleranceModifiersSequence &theModifiers)
	Sets new sequence of tolerance modifiers.

void	AddModifier (const XCAFDimTolObjects_GeomToleranceModif theModifier)
	Adds a tolerance modifier to the sequence of modifiers.

XCAFDimTolObjects_GeomToleranceModifiersSequence	GetModifiers () const
	Returns a sequence of modifiers of the tolerance.

void	SetMaxValueModifier (const Standard_Real theModifier)
	Sets the maximal upper tolerance value for tolerance with modifiers.

Standard_Real	GetMaxValueModifier () const
	Returns the maximal upper tolerance.

void	SetAxis (const gp_Ax2 &theAxis)

gp_Ax2	GetAxis () const

Standard_Boolean	HasAxis () const

void	SetPlane (const gp_Ax2 &thePlane)
	Sets annotation plane.

const gp_Ax2 &	GetPlane () const
	Returns annotation plane.

void	SetPoint (const gp_Pnt &thePnt)
	Sets reference point.

const gp_Pnt &	GetPoint () const
	Returns reference point.

void	SetPointTextAttach (const gp_Pnt &thePntText)
	Sets text position.

const gp_Pnt &	GetPointTextAttach () const
	Returns the text position.

Standard_Boolean	HasPlane () const
	Returns True if the object has annotation plane.

Standard_Boolean	HasPoint () const
	Returns True if reference point is specified.

Standard_Boolean	HasPointText () const
	Returns True if text position is specified.

void	SetPresentation (const TopoDS_Shape &thePresentation, const Handle< TCollection_HAsciiString > &thePresentationName)
	Set graphical presentation for object.

TopoDS_Shape	GetPresentation () const
	Returns graphical presentation of the object.

Handle< TCollection_HAsciiString >	GetPresentationName () const
	Returns graphical presentation of the object.

bool	HasAffectedPlane () const

XCAFDimTolObjects_ToleranceZoneAffectedPlane	GetAffectedPlaneType () const

void	SetAffectedPlaneType (const XCAFDimTolObjects_ToleranceZoneAffectedPlane theType)

void	SetAffectedPlane (const gp_Pln &thePlane)
	Sets affected plane.

void	SetAffectedPlane (const gp_Pln &thePlane, const XCAFDimTolObjects_ToleranceZoneAffectedPlane theType)
	Sets affected plane.

const gp_Pln &	GetAffectedPlane () const
	Returns affected plane.

void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream.

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

Access object to store dimension and tolerance.

Constructor & Destructor Documentation

◆ XCAFDimTolObjects_GeomToleranceObject() [1/2]

XCAFDimTolObjects_GeomToleranceObject::XCAFDimTolObjects_GeomToleranceObject ( )

◆ XCAFDimTolObjects_GeomToleranceObject() [2/2]

XCAFDimTolObjects_GeomToleranceObject::XCAFDimTolObjects_GeomToleranceObject ( const Handle< XCAFDimTolObjects_GeomToleranceObject > & theObj )

Member Function Documentation

◆ AddModifier()

void XCAFDimTolObjects_GeomToleranceObject::AddModifier ( const XCAFDimTolObjects_GeomToleranceModif theModifier )

Adds a tolerance modifier to the sequence of modifiers.

◆ DumpJson()

void XCAFDimTolObjects_GeomToleranceObject::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = `-1`
	)		const

Dumps the content of me into the stream.

◆ GetAffectedPlane()

const gp_Pln & XCAFDimTolObjects_GeomToleranceObject::GetAffectedPlane ( ) const

inline

Returns affected plane.

◆ GetAffectedPlaneType()

XCAFDimTolObjects_ToleranceZoneAffectedPlane XCAFDimTolObjects_GeomToleranceObject::GetAffectedPlaneType ( ) const

inline

◆ GetAxis()

gp_Ax2 XCAFDimTolObjects_GeomToleranceObject::GetAxis ( ) const

◆ GetMaterialRequirementModifier()

XCAFDimTolObjects_GeomToleranceMatReqModif XCAFDimTolObjects_GeomToleranceObject::GetMaterialRequirementModifier ( ) const

Returns material requirement of the tolerance.

◆ GetMaxValueModifier()

Standard_Real XCAFDimTolObjects_GeomToleranceObject::GetMaxValueModifier ( ) const

Returns the maximal upper tolerance.

◆ GetModifiers()

XCAFDimTolObjects_GeomToleranceModifiersSequence XCAFDimTolObjects_GeomToleranceObject::GetModifiers ( ) const

Returns a sequence of modifiers of the tolerance.

◆ GetPlane()

const gp_Ax2 & XCAFDimTolObjects_GeomToleranceObject::GetPlane ( ) const

inline

Returns annotation plane.

◆ GetPoint()

const gp_Pnt & XCAFDimTolObjects_GeomToleranceObject::GetPoint ( ) const

inline

Returns reference point.

◆ GetPointTextAttach()

const gp_Pnt & XCAFDimTolObjects_GeomToleranceObject::GetPointTextAttach ( ) const

inline

Returns the text position.

◆ GetPresentation()

TopoDS_Shape XCAFDimTolObjects_GeomToleranceObject::GetPresentation ( ) const

inline

Returns graphical presentation of the object.

◆ GetPresentationName()

Handle< TCollection_HAsciiString > XCAFDimTolObjects_GeomToleranceObject::GetPresentationName ( ) const

inline

Returns graphical presentation of the object.

◆ GetSemanticName()

Handle< TCollection_HAsciiString > XCAFDimTolObjects_GeomToleranceObject::GetSemanticName ( ) const

Returns semantic name.

◆ GetType()

XCAFDimTolObjects_GeomToleranceType XCAFDimTolObjects_GeomToleranceObject::GetType ( ) const

Returns type of the object.

◆ GetTypeOfValue()

XCAFDimTolObjects_GeomToleranceTypeValue XCAFDimTolObjects_GeomToleranceObject::GetTypeOfValue ( ) const

Returns type of tolerance value.

◆ GetValue()

Standard_Real XCAFDimTolObjects_GeomToleranceObject::GetValue ( ) const

Returns tolerance value.

◆ GetValueOfZoneModifier()

Standard_Real XCAFDimTolObjects_GeomToleranceObject::GetValueOfZoneModifier ( ) const

Returns value associated with tolerance zone.

◆ GetZoneModifier()

XCAFDimTolObjects_GeomToleranceZoneModif XCAFDimTolObjects_GeomToleranceObject::GetZoneModifier ( ) const

Returns tolerance zone.

◆ HasAffectedPlane()

bool XCAFDimTolObjects_GeomToleranceObject::HasAffectedPlane ( ) const

inline

◆ HasAxis()

Standard_Boolean XCAFDimTolObjects_GeomToleranceObject::HasAxis ( ) const

◆ HasPlane()

Standard_Boolean XCAFDimTolObjects_GeomToleranceObject::HasPlane ( ) const

inline

Returns True if the object has annotation plane.

◆ HasPoint()

Standard_Boolean XCAFDimTolObjects_GeomToleranceObject::HasPoint ( ) const

inline

Returns True if reference point is specified.

◆ HasPointText()

Standard_Boolean XCAFDimTolObjects_GeomToleranceObject::HasPointText ( ) const

inline

Returns True if text position is specified.

◆ SetAffectedPlane() [1/2]

void XCAFDimTolObjects_GeomToleranceObject::SetAffectedPlane ( const gp_Pln & thePlane )

inline

Sets affected plane.

◆ SetAffectedPlane() [2/2]

void XCAFDimTolObjects_GeomToleranceObject::SetAffectedPlane	(	const gp_Pln &	thePlane,
		const XCAFDimTolObjects_ToleranceZoneAffectedPlane	theType
	)

inline

Sets affected plane.

◆ SetAffectedPlaneType()

void XCAFDimTolObjects_GeomToleranceObject::SetAffectedPlaneType ( const XCAFDimTolObjects_ToleranceZoneAffectedPlane theType )

inline

◆ SetAxis()

void XCAFDimTolObjects_GeomToleranceObject::SetAxis ( const gp_Ax2 & theAxis )

◆ SetMaterialRequirementModifier()

void XCAFDimTolObjects_GeomToleranceObject::SetMaterialRequirementModifier ( const XCAFDimTolObjects_GeomToleranceMatReqModif theMatReqModif )

Sets material requirement of the tolerance.

◆ SetMaxValueModifier()

void XCAFDimTolObjects_GeomToleranceObject::SetMaxValueModifier ( const Standard_Real theModifier )

Sets the maximal upper tolerance value for tolerance with modifiers.

◆ SetModifiers()

void XCAFDimTolObjects_GeomToleranceObject::SetModifiers ( const XCAFDimTolObjects_GeomToleranceModifiersSequence & theModifiers )

Sets new sequence of tolerance modifiers.

◆ SetPlane()

void XCAFDimTolObjects_GeomToleranceObject::SetPlane ( const gp_Ax2 & thePlane )

inline

Sets annotation plane.

◆ SetPoint()

void XCAFDimTolObjects_GeomToleranceObject::SetPoint ( const gp_Pnt & thePnt )

inline

Sets reference point.

◆ SetPointTextAttach()

void XCAFDimTolObjects_GeomToleranceObject::SetPointTextAttach ( const gp_Pnt & thePntText )

inline

Sets text position.

◆ SetPresentation()

void XCAFDimTolObjects_GeomToleranceObject::SetPresentation	(	const TopoDS_Shape &	thePresentation,
		const Handle< TCollection_HAsciiString > &	thePresentationName
	)

inline

Set graphical presentation for object.

◆ SetSemanticName()

void XCAFDimTolObjects_GeomToleranceObject::SetSemanticName ( const Handle< TCollection_HAsciiString > & theName )

Sets semantic name.

◆ SetType()

void XCAFDimTolObjects_GeomToleranceObject::SetType ( const XCAFDimTolObjects_GeomToleranceType theType )

Sets type of the object.

◆ SetTypeOfValue()

void XCAFDimTolObjects_GeomToleranceObject::SetTypeOfValue ( const XCAFDimTolObjects_GeomToleranceTypeValue theTypeOfValue )

Sets type of tolerance value.

◆ SetValue()

void XCAFDimTolObjects_GeomToleranceObject::SetValue ( const Standard_Real theValue )

Sets tolerance value.

◆ SetValueOfZoneModifier()

void XCAFDimTolObjects_GeomToleranceObject::SetValueOfZoneModifier ( const Standard_Real theValue )

Sets value associated with tolerance zone.

◆ SetZoneModifier()

void XCAFDimTolObjects_GeomToleranceObject::SetZoneModifier ( const XCAFDimTolObjects_GeomToleranceZoneModif theZoneModif )

Sets tolerance zone.

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

XCAFDimTolObjects_GeomToleranceObject.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XCAFDimTolObjects_GeomToleranceObject() [1/2]

◆ XCAFDimTolObjects_GeomToleranceObject() [2/2]

Member Function Documentation

◆ AddModifier()

◆ DumpJson()

◆ GetAffectedPlane()

◆ GetAffectedPlaneType()

◆ GetAxis()

◆ GetMaterialRequirementModifier()

◆ GetMaxValueModifier()

◆ GetModifiers()

◆ GetPlane()

◆ GetPoint()

◆ GetPointTextAttach()

◆ GetPresentation()

◆ GetPresentationName()

◆ GetSemanticName()

◆ GetType()

◆ GetTypeOfValue()

◆ GetValue()

◆ GetValueOfZoneModifier()

◆ GetZoneModifier()

◆ HasAffectedPlane()

◆ HasAxis()

◆ HasPlane()

◆ HasPoint()

◆ HasPointText()

◆ SetAffectedPlane() [1/2]

◆ SetAffectedPlane() [2/2]

◆ SetAffectedPlaneType()

◆ SetAxis()

◆ SetMaterialRequirementModifier()

◆ SetMaxValueModifier()

◆ SetModifiers()

◆ SetPlane()

◆ SetPoint()

◆ SetPointTextAttach()

◆ SetPresentation()

◆ SetSemanticName()

◆ SetType()

◆ SetTypeOfValue()

◆ SetValue()

◆ SetValueOfZoneModifier()

◆ SetZoneModifier()