Open CASCADE Technology  7.6.0
Public Member Functions

XCAFDimTolObjects_DatumObject Class Reference

Access object to store datum. More...

#include <XCAFDimTolObjects_DatumObject.hxx>

Inheritance diagram for XCAFDimTolObjects_DatumObject:
Inheritance graph
[legend]

Public Member Functions

 XCAFDimTolObjects_DatumObject ()
 
 XCAFDimTolObjects_DatumObject (const Handle< XCAFDimTolObjects_DatumObject > &theObj)
 
Handle< TCollection_HAsciiStringGetSemanticName () const
 Returns semantic name. More...
 
void SetSemanticName (const Handle< TCollection_HAsciiString > &theName)
 Sets semantic name. More...
 
Handle< TCollection_HAsciiStringGetName () const
 Returns datum name. More...
 
void SetName (const Handle< TCollection_HAsciiString > &theTag)
 Sets datum name. More...
 
XCAFDimTolObjects_DatumModifiersSequence GetModifiers () const
 Returns a sequence of modifiers of the datum. More...
 
void SetModifiers (const XCAFDimTolObjects_DatumModifiersSequence &theModifiers)
 Sets new sequence of datum modifiers. More...
 
void GetModifierWithValue (XCAFDimTolObjects_DatumModifWithValue &theModifier, Standard_Real &theValue) const
 Retrieves datum modifier with value. More...
 
void SetModifierWithValue (const XCAFDimTolObjects_DatumModifWithValue theModifier, const Standard_Real theValue)
 Sets datum modifier with value. More...
 
void AddModifier (const XCAFDimTolObjects_DatumSingleModif theModifier)
 Adds a modifier to the datum sequence of modifiers. More...
 
TopoDS_Shape GetDatumTarget () const
 Returns datum target shape. More...
 
void SetDatumTarget (const TopoDS_Shape &theShape)
 Sets datum target shape. More...
 
Standard_Integer GetPosition () const
 Returns datum position in the related geometric tolerance object. More...
 
void SetPosition (const Standard_Integer thePosition)
 Sets datum position in the related geometric tolerance object. More...
 
Standard_Boolean IsDatumTarget () const
 Returns True if the datum target is specified. More...
 
void IsDatumTarget (const Standard_Boolean theIsDT)
 Sets or drops the datum target indicator. More...
 
XCAFDimTolObjects_DatumTargetType GetDatumTargetType () const
 Returns datum target type. More...
 
void SetDatumTargetType (const XCAFDimTolObjects_DatumTargetType theType)
 Sets datum target to point, line, rectangle, circle or area type. More...
 
gp_Ax2 GetDatumTargetAxis () const
 Returns datum target axis. The Z axis of the datum placement denotes the normal of the surface pointing away from the material. More...
 
void SetDatumTargetAxis (const gp_Ax2 &theAxis)
 Sets datum target axis. More...
 
Standard_Real GetDatumTargetLength () const
 Returns datum target length for line and rectangle types. The length along the X axis of the datum placement. More...
 
void SetDatumTargetLength (const Standard_Real theLength)
 Sets datum target length. More...
 
Standard_Real GetDatumTargetWidth () const
 Returns datum target width for rectangle type. The width along the derived Y axis, with the placement itself positioned at the centre of the rectangle. More...
 
void SetDatumTargetWidth (const Standard_Real theWidth)
 Sets datum target width. More...
 
Standard_Integer GetDatumTargetNumber () const
 Returns datum target number. More...
 
void SetDatumTargetNumber (const Standard_Integer theNumber)
 Sets datum target number. More...
 
void SetPlane (const gp_Ax2 &thePlane)
 Sets annotation plane. More...
 
const gp_Ax2GetPlane () const
 Returns annotation plane. More...
 
void SetPoint (const gp_Pnt &thePnt)
 Sets a point on the datum target shape. More...
 
const gp_PntGetPoint () const
 Gets point on the datum shape. More...
 
void SetPointTextAttach (const gp_Pnt &thePntText)
 Sets a position of the datum text. More...
 
const gp_PntGetPointTextAttach () const
 Gets datum text position. More...
 
Standard_Boolean HasPlane () const
 Returns True if the datum has annotation plane. More...
 
Standard_Boolean HasPoint () const
 Returns True if point on the datum target is specified. More...
 
Standard_Boolean HasPointText () const
 Returns True if the datum text position is specified. More...
 
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_HAsciiStringGetPresentationName () const
 Returns graphical presentation of the object. More...
 
Standard_Boolean HasDatumTargetParams ()
 Returns True if the datum has valid parameters for datum target (width, length, circle radius etc) More...
 
void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (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_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. 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

Access 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)

Adds a modifier to the datum sequence of modifiers.

◆ DumpJson()

void XCAFDimTolObjects_DatumObject::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const

Dumps the content of me into the stream.

◆ GetDatumTarget()

TopoDS_Shape XCAFDimTolObjects_DatumObject::GetDatumTarget ( ) const

Returns datum target shape.

◆ GetDatumTargetAxis()

gp_Ax2 XCAFDimTolObjects_DatumObject::GetDatumTargetAxis ( ) const

Returns datum target axis. The Z axis of the datum placement denotes the normal of the surface pointing away from the material.

◆ GetDatumTargetLength()

Standard_Real XCAFDimTolObjects_DatumObject::GetDatumTargetLength ( ) const

Returns datum target length for line and rectangle types. The length along the X axis of the datum placement.

◆ GetDatumTargetNumber()

Standard_Integer XCAFDimTolObjects_DatumObject::GetDatumTargetNumber ( ) const

Returns datum target number.

◆ GetDatumTargetType()

XCAFDimTolObjects_DatumTargetType XCAFDimTolObjects_DatumObject::GetDatumTargetType ( ) const

Returns datum target type.

◆ GetDatumTargetWidth()

Standard_Real XCAFDimTolObjects_DatumObject::GetDatumTargetWidth ( ) const

Returns datum target width for rectangle type. The width along the derived Y axis, with the placement itself positioned at the centre of the rectangle.

◆ GetModifiers()

XCAFDimTolObjects_DatumModifiersSequence XCAFDimTolObjects_DatumObject::GetModifiers ( ) const

Returns a sequence of modifiers of the datum.

◆ GetModifierWithValue()

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

Retrieves datum modifier with value.

◆ GetName()

Handle< TCollection_HAsciiString > XCAFDimTolObjects_DatumObject::GetName ( ) const

Returns datum name.

◆ GetPlane()

const gp_Ax2& XCAFDimTolObjects_DatumObject::GetPlane ( ) const
inline

Returns annotation plane.

◆ GetPoint()

const gp_Pnt& XCAFDimTolObjects_DatumObject::GetPoint ( ) const
inline

Gets point on the datum shape.

◆ GetPointTextAttach()

const gp_Pnt& XCAFDimTolObjects_DatumObject::GetPointTextAttach ( ) const
inline

Gets datum text position.

◆ GetPosition()

Standard_Integer XCAFDimTolObjects_DatumObject::GetPosition ( ) const

Returns datum position in the related geometric tolerance object.

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

◆ GetSemanticName()

Handle< TCollection_HAsciiString > XCAFDimTolObjects_DatumObject::GetSemanticName ( ) const

Returns semantic name.

◆ HasDatumTargetParams()

Standard_Boolean XCAFDimTolObjects_DatumObject::HasDatumTargetParams ( )
inline

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

◆ HasPlane()

Standard_Boolean XCAFDimTolObjects_DatumObject::HasPlane ( ) const
inline

Returns True if the datum has annotation plane.

◆ HasPoint()

Standard_Boolean XCAFDimTolObjects_DatumObject::HasPoint ( ) const
inline

Returns True if point on the datum target is specified.

◆ HasPointText()

Standard_Boolean XCAFDimTolObjects_DatumObject::HasPointText ( ) const
inline

Returns True if the datum text position is specified.

◆ IsDatumTarget() [1/2]

Standard_Boolean XCAFDimTolObjects_DatumObject::IsDatumTarget ( ) const

Returns True if the datum target is specified.

◆ IsDatumTarget() [2/2]

void XCAFDimTolObjects_DatumObject::IsDatumTarget ( const Standard_Boolean  theIsDT)

Sets or drops the datum target indicator.

◆ SetDatumTarget()

void XCAFDimTolObjects_DatumObject::SetDatumTarget ( const TopoDS_Shape theShape)

Sets datum target shape.

◆ SetDatumTargetAxis()

void XCAFDimTolObjects_DatumObject::SetDatumTargetAxis ( const gp_Ax2 theAxis)

Sets datum target axis.

◆ SetDatumTargetLength()

void XCAFDimTolObjects_DatumObject::SetDatumTargetLength ( const Standard_Real  theLength)

Sets datum target length.

◆ SetDatumTargetNumber()

void XCAFDimTolObjects_DatumObject::SetDatumTargetNumber ( const Standard_Integer  theNumber)

Sets datum target number.

◆ SetDatumTargetType()

void XCAFDimTolObjects_DatumObject::SetDatumTargetType ( const XCAFDimTolObjects_DatumTargetType  theType)

Sets datum target to point, line, rectangle, circle or area type.

◆ SetDatumTargetWidth()

void XCAFDimTolObjects_DatumObject::SetDatumTargetWidth ( const Standard_Real  theWidth)

Sets datum target width.

◆ SetModifiers()

void XCAFDimTolObjects_DatumObject::SetModifiers ( const XCAFDimTolObjects_DatumModifiersSequence theModifiers)

Sets new sequence of datum modifiers.

◆ SetModifierWithValue()

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

Sets datum modifier with value.

◆ SetName()

void XCAFDimTolObjects_DatumObject::SetName ( const Handle< TCollection_HAsciiString > &  theTag)

Sets datum name.

◆ SetPlane()

void XCAFDimTolObjects_DatumObject::SetPlane ( const gp_Ax2 thePlane)
inline

Sets annotation plane.

◆ SetPoint()

void XCAFDimTolObjects_DatumObject::SetPoint ( const gp_Pnt thePnt)
inline

Sets a point on the datum target shape.

◆ SetPointTextAttach()

void XCAFDimTolObjects_DatumObject::SetPointTextAttach ( const gp_Pnt thePntText)
inline

Sets a position of the datum text.

◆ SetPosition()

void XCAFDimTolObjects_DatumObject::SetPosition ( const Standard_Integer  thePosition)

Sets datum position in the related geometric tolerance object.

◆ SetPresentation()

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

Set graphical presentation for object.

◆ SetSemanticName()

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

Sets semantic name.


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