XCAFDimTolObjects_DatumObject Class Reference

object to store datum More...

#include <XCAFDimTolObjects_DatumObject.hxx>

Inheritance diagram for XCAFDimTolObjects_DatumObject:

Public Member Functions
	XCAFDimTolObjects_DatumObject ()
	XCAFDimTolObjects_DatumObject (const Handle< XCAFDimTolObjects_DatumObject > &theObj)
Handle< TCollection_HAsciiString >	GetName () const
void	SetName (const Handle< TCollection_HAsciiString > &theTag)
XCAFDimTolObjects_DatumModifiersSequence	GetModifiers () const
void	SetModifiers (const XCAFDimTolObjects_DatumModifiersSequence &theModifiers)
void	GetModifierWithValue (XCAFDimTolObjects_DatumModifWithValue &theModifier, Standard_Real &theValue) const
void	SetModifierWithValue (const XCAFDimTolObjects_DatumModifWithValue theModifier, const Standard_Real theValue)
void	AddModifier (const XCAFDimTolObjects_DatumSingleModif theModifier)
TopoDS_Shape	GetDatumTarget () const
void	SetDatumTarget (const TopoDS_Shape &theShape)
Standard_Integer	GetPosition () const
void	SetPosition (const Standard_Integer thePosition)
Standard_Boolean	IsDatumTarget () const
void	IsDatumTarget (const Standard_Boolean theIsDT)
XCAFDimTolObjects_DatumTargetType	GetDatumTargetType () const
void	SetDatumTargetType (const XCAFDimTolObjects_DatumTargetType theType)
gp_Ax2	GetDatumTargetAxis () const
void	SetDatumTargetAxis (const gp_Ax2 &theAxis)
Standard_Real	GetDatumTargetLength () const
void	SetDatumTargetLength (const Standard_Real theLength)
Standard_Real	GetDatumTargetWidth () const
void	SetDatumTargetWidth (const Standard_Real theWidth)
Standard_Integer	GetDatumTargetNumber () const
void	SetDatumTargetNumber (const Standard_Integer theNumber)
void	SetPlane (const gp_Ax2 &thePlane)
const gp_Ax2 &	GetPlane () const
void	SetPoint (const gp_Pnt &thePnt)
const gp_Pnt &	GetPoint () const
void	SetPointTextAttach (const gp_Pnt &thePntText)
const gp_Pnt &	GetPointTextAttach () const
Standard_Boolean	HasPlane () const
Standard_Boolean	HasPoint () const
Standard_Boolean	HasPointText () const
void	SetPresentation (const TopoDS_Shape &thePresentation, const Handle< TCollection_HAsciiString > &thePresentationName)
	Set graphical presentation for object. More...
TopoDS_Shape	GetPresentation () const
	Returns graphical presentation of the object. More...
Handle< TCollection_HAsciiString >	GetPresentationName () const
	Returns graphical presentation of the object. More...
Standard_Boolean	HasDatumTargetParams ()
	Returns true if datum has valid parameters for datum target (width, length, circle radius etc) More...
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...
Standard_Transient &	operator= (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_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. 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

object to store datum

Constructor & Destructor Documentation

XCAFDimTolObjects_DatumObject() [1/2]

XCAFDimTolObjects_DatumObject::XCAFDimTolObjects_DatumObject

(

)

XCAFDimTolObjects_DatumObject() [2/2]

XCAFDimTolObjects_DatumObject::XCAFDimTolObjects_DatumObject

(

const Handle< XCAFDimTolObjects_DatumObject > &

theObj

)

Member Function Documentation

AddModifier()

void XCAFDimTolObjects_DatumObject::AddModifier

(

const XCAFDimTolObjects_DatumSingleModif

theModifier

)

GetDatumTarget()

TopoDS_Shape XCAFDimTolObjects_DatumObject::GetDatumTarget

(

)

const

GetDatumTargetAxis()

gp_Ax2 XCAFDimTolObjects_DatumObject::GetDatumTargetAxis

(

)

const

GetDatumTargetLength()

Standard_Real XCAFDimTolObjects_DatumObject::GetDatumTargetLength

(

)

const

GetDatumTargetNumber()

Standard_Integer XCAFDimTolObjects_DatumObject::GetDatumTargetNumber

(

)

const

GetDatumTargetType()

XCAFDimTolObjects_DatumTargetType XCAFDimTolObjects_DatumObject::GetDatumTargetType

(

)

const

GetDatumTargetWidth()

Standard_Real XCAFDimTolObjects_DatumObject::GetDatumTargetWidth

(

)

const

GetModifiers()

XCAFDimTolObjects_DatumModifiersSequence XCAFDimTolObjects_DatumObject::GetModifiers

(

)

const

GetModifierWithValue()

void XCAFDimTolObjects_DatumObject::GetModifierWithValue	(	XCAFDimTolObjects_DatumModifWithValue &	theModifier,
		Standard_Real &	theValue
	)		const

GetName()

Handle< TCollection_HAsciiString > XCAFDimTolObjects_DatumObject::GetName

(

)

const

GetPlane()

const gp_Ax2& XCAFDimTolObjects_DatumObject::GetPlane ( ) const

inline

GetPoint()

const gp_Pnt& XCAFDimTolObjects_DatumObject::GetPoint ( ) const

inline

GetPointTextAttach()

const gp_Pnt& XCAFDimTolObjects_DatumObject::GetPointTextAttach ( ) const

inline

GetPosition()

Standard_Integer XCAFDimTolObjects_DatumObject::GetPosition

(

)

const

GetPresentation()

TopoDS_Shape XCAFDimTolObjects_DatumObject::GetPresentation ( ) const

inline

Returns graphical presentation of the object.

GetPresentationName()

Handle< TCollection_HAsciiString > XCAFDimTolObjects_DatumObject::GetPresentationName ( ) const

inline

Returns graphical presentation of the object.

HasDatumTargetParams()

Standard_Boolean XCAFDimTolObjects_DatumObject::HasDatumTargetParams ( )

inline

Returns true if datum has valid parameters for datum target (width, length, circle radius etc)

HasPlane()

Standard_Boolean XCAFDimTolObjects_DatumObject::HasPlane ( ) const

inline

HasPoint()

Standard_Boolean XCAFDimTolObjects_DatumObject::HasPoint ( ) const

inline

HasPointText()

Standard_Boolean XCAFDimTolObjects_DatumObject::HasPointText ( ) const

inline

IsDatumTarget() [1/2]

Standard_Boolean XCAFDimTolObjects_DatumObject::IsDatumTarget

(

)

const

IsDatumTarget() [2/2]

void XCAFDimTolObjects_DatumObject::IsDatumTarget

(

const Standard_Boolean

theIsDT

)

SetDatumTarget()

void XCAFDimTolObjects_DatumObject::SetDatumTarget

(

const TopoDS_Shape &

theShape

)

SetDatumTargetAxis()

void XCAFDimTolObjects_DatumObject::SetDatumTargetAxis

(

const gp_Ax2 &

theAxis

)

SetDatumTargetLength()

void XCAFDimTolObjects_DatumObject::SetDatumTargetLength

(

const Standard_Real

theLength

)

SetDatumTargetNumber()

void XCAFDimTolObjects_DatumObject::SetDatumTargetNumber

(

const Standard_Integer

theNumber

)

SetDatumTargetType()

void XCAFDimTolObjects_DatumObject::SetDatumTargetType

(

const XCAFDimTolObjects_DatumTargetType

theType

)

SetDatumTargetWidth()

void XCAFDimTolObjects_DatumObject::SetDatumTargetWidth

(

const Standard_Real

theWidth

)

SetModifiers()

void XCAFDimTolObjects_DatumObject::SetModifiers

(

const XCAFDimTolObjects_DatumModifiersSequence &

theModifiers

)

SetModifierWithValue()

void XCAFDimTolObjects_DatumObject::SetModifierWithValue	(	const XCAFDimTolObjects_DatumModifWithValue	theModifier,
		const Standard_Real	theValue
	)

SetName()

void XCAFDimTolObjects_DatumObject::SetName

(

const Handle< TCollection_HAsciiString > &

theTag

)

SetPlane()

void XCAFDimTolObjects_DatumObject::SetPlane ( const gp_Ax2 &  thePlane )

inline

SetPoint()

void XCAFDimTolObjects_DatumObject::SetPoint ( const gp_Pnt &  thePnt )

inline

SetPointTextAttach()

void XCAFDimTolObjects_DatumObject::SetPointTextAttach ( const gp_Pnt &  thePntText )

inline

SetPosition()

void XCAFDimTolObjects_DatumObject::SetPosition

(

const Standard_Integer

thePosition

)

SetPresentation()

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

inline

Set graphical presentation for object.

---

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

• XCAFDimTolObjects_DatumObject.hxx