DATAKIT API  V2025.4
Dtk_FCFFeatureIndicator Class Referenceabstract

This is the Feature Indicator.
It is part of the Dtk_ToleranceSpecification.
It's basically composed of a type, a symbol and a Datum feature identifier. More...

+ Inheritance diagram for Dtk_FCFFeatureIndicator:

Public Member Functions

void Clear ()
 
Dtk_Int32 DtkDynamicType (const Dtk_Int32 &inId)
 Retrieves the dynamic entity type. More...
 
virtual int DtkDynamicType (const int &inId)=0
 
virtual void dump (FILE *file=stdout)
 
Dtk_ErrorStatus Explode (Dtk_CompositeText &outText, Dtk_tab< Dtk_CurvePtr > &outGeomsArray) const
 Explodes the Dtk_FCFFeatureIndicator into Dtk_CompositeText and geometrical elements - used for Dtk_Symbol conversion only -. More...
 
Dtk_ErrorStatus GetAnchorPoints (Dtk_pnt(&outTabPnts)[DTK_NB_ANCHOR_TYPES]) const
 Processes all the Dtk_FCFFeatureIndicator anchor points. More...
 
const Dtk_TextGetDatumFeatureIdentifier () const
 Retrieves the DatumFeature Identifier of the Dtk_FCFFeatureIndicator - Read Only -. More...
 
const Dtk_FCFFeatureIndicatorTypeGetFeatureIndicatorType () const
 Retrieves the Full Type of the Dtk_FCFFeatureIndicator - Read Only -. More...
 
Dtk_Oriented2dBBox GetOuterBoundingBox () const
 Retrieves the Dtk_FCFFeatureIndicator Outer Bounding Box. More...
 
virtual Dtk_Size_t GetSize () const
 
const Dtk_TextGetSymbol () const
 Retrieves the Symbol of the Dtk_FCFFeatureIndicator - Read Only -. More...
 
Dtk_FCFFeatureIndicatoroperator= (const Dtk_FCFFeatureIndicator &in)
 Copy assignment operator. More...
 
Dtk_FCFFeatureIndicatoroperator= (Dtk_FCFFeatureIndicator &&in) DTK_NOEXCEPT
 Move assignment operator. More...
 
Dtk_ErrorStatus SetAnchorPoint (const Dtk_pnt &inNewLocation, const Dtk_anchor_type &inLocationAnchorType)
 Sets the Dtk_FCFFeatureIndicator anchor point. More...
 
Dtk_ErrorStatus Transform (const Dtk_transfo &inTransfo)
 Transforms the Dtk_FCFFeatureIndicator giving a transformation matrix. More...
 
Dtk_ErrorStatus Translate (const Dtk_dir &inTranslationDir)
 Translates the Dtk_FCFFeatureIndicator giving a translation vector. More...
 

Static Public Member Functions

static Dtk_FCFFeatureIndicatorPtr Create ()
 Calls default constructor to allocate a new object. More...
 
static Dtk_FCFFeatureIndicatorPtr Create (const Dtk_FCFFeatureIndicator &in)
 Calls copy constructor to allocate a new object. More...
 
static Dtk_FCFFeatureIndicatorPtr Create (Dtk_FCFFeatureIndicator &&in)
 Calls move constructor to allocate a new object. More...
 
static Dtk_FCFFeatureIndicatorPtr Create (Dtk_FCFFeatureIndicatorType inFeatureIndicatorType, Dtk_Text inSymbol, Dtk_Text inDatumFeatureIdentifier)
 Calls full featured constructor to allocate a new object. More...
 
static Dtk_FCFFeatureIndicatorDtkDynamicCast (Dtk_Object *s)
 Performs a dynamic cast - doesn't need RTTI -. More...
 

Protected Types

enum  { _typeID = DTK_TYPE_OBJECT }
 
enum  { _typeID = DTK_TYPE_SPECIFICATION_INDICATOR }
 

Protected Member Functions

virtual Dtk_ObjectClone ()
 
 Dtk_FCFFeatureIndicator ()
 
 Dtk_FCFFeatureIndicator (const Dtk_FCFFeatureIndicator &in)
 
 Dtk_FCFFeatureIndicator (Dtk_FCFFeatureIndicator &&in) DTK_NOEXCEPT
 
 Dtk_FCFFeatureIndicator (Dtk_FCFFeatureIndicatorType inFeatureIndicatorType, Dtk_Text inSymbol, Dtk_Text inDatumFeatureIdentifier)
 
 ~Dtk_FCFFeatureIndicator ()
 Destructor. More...
 

Protected Attributes

unsigned long count_
 
Dtk_Handle * m_Private
 

Detailed Description

This is the Feature Indicator.
It is part of the Dtk_ToleranceSpecification.
It's basically composed of a type, a symbol and a Datum feature identifier.

See also
Use Dtk_FCFFeatureIndicator class to handle it.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
_typeID 

◆ anonymous enum

anonymous enum
protected
Enumerator
_typeID 

Constructor & Destructor Documentation

◆ Dtk_FCFFeatureIndicator() [1/4]

Dtk_FCFFeatureIndicator::Dtk_FCFFeatureIndicator ( )
protected
See also
Create()

◆ Dtk_FCFFeatureIndicator() [2/4]

Dtk_FCFFeatureIndicator::Dtk_FCFFeatureIndicator ( const Dtk_FCFFeatureIndicator in)
protected

◆ Dtk_FCFFeatureIndicator() [3/4]

Dtk_FCFFeatureIndicator::Dtk_FCFFeatureIndicator ( Dtk_FCFFeatureIndicator &&  in)
protected

◆ Dtk_FCFFeatureIndicator() [4/4]

Dtk_FCFFeatureIndicator::Dtk_FCFFeatureIndicator ( Dtk_FCFFeatureIndicatorType  inFeatureIndicatorType,
Dtk_Text  inSymbol,
Dtk_Text  inDatumFeatureIdentifier 
)
protected

◆ ~Dtk_FCFFeatureIndicator()

Dtk_FCFFeatureIndicator::~Dtk_FCFFeatureIndicator ( )
protected

Destructor.

Member Function Documentation

◆ Clear()

void Dtk_FCFFeatureIndicator::Clear ( )

◆ Clone()

virtual Dtk_Object* Dtk_FCFFeatureIndicator::Clone ( )
protectedvirtual

◆ Create() [1/4]

static Dtk_FCFFeatureIndicatorPtr Dtk_FCFFeatureIndicator::Create ( )
static

Calls default constructor to allocate a new object.

◆ Create() [2/4]

static Dtk_FCFFeatureIndicatorPtr Dtk_FCFFeatureIndicator::Create ( const Dtk_FCFFeatureIndicator in)
static

Calls copy constructor to allocate a new object.

Parameters
inObject to copy from.

◆ Create() [3/4]

static Dtk_FCFFeatureIndicatorPtr Dtk_FCFFeatureIndicator::Create ( Dtk_FCFFeatureIndicator &&  in)
static

Calls move constructor to allocate a new object.

Parameters
inObject to move from.

◆ Create() [4/4]

static Dtk_FCFFeatureIndicatorPtr Dtk_FCFFeatureIndicator::Create ( Dtk_FCFFeatureIndicatorType  inFeatureIndicatorType,
Dtk_Text  inSymbol,
Dtk_Text  inDatumFeatureIdentifier 
)
static

Calls full featured constructor to allocate a new object.

Parameters
inFeatureIndicatorTypeThe FeatureIndicator Type.
inSymbolThe FeatureIndicator symbol.
inDatumFeatureIdentifierThe FeatureIndicator Datum feature identifier.
Returns
the created Dtk_FCFFeatureIndicatorPtr

◆ DtkDynamicCast()

static Dtk_FCFFeatureIndicator* Dtk_FCFFeatureIndicator::DtkDynamicCast ( Dtk_Object s)
static

Performs a dynamic cast - doesn't need RTTI -.

◆ DtkDynamicType() [1/2]

Dtk_Int32 Dtk_FCFFeatureIndicator::DtkDynamicType ( const Dtk_Int32 inId)

Retrieves the dynamic entity type.

◆ DtkDynamicType() [2/2]

◆ dump()

virtual void Dtk_Object::dump ( FILE *  file = stdout)
virtualinherited

◆ Explode()

Dtk_ErrorStatus Dtk_FCFFeatureIndicator::Explode ( Dtk_CompositeText outText,
Dtk_tab< Dtk_CurvePtr > &  outGeomsArray 
) const

Explodes the Dtk_FCFFeatureIndicator into Dtk_CompositeText and geometrical elements - used for Dtk_Symbol conversion only -.

Parameters
outTextResulting composite text
outGeomsArrayResulting geometrical elements
Returns
DtkNoError if OK

◆ GetAnchorPoints()

Dtk_ErrorStatus Dtk_FCFFeatureIndicator::GetAnchorPoints ( Dtk_pnt(&)  outTabPnts[DTK_NB_ANCHOR_TYPES]) const

Processes all the Dtk_FCFFeatureIndicator anchor points.

Parameters
outTabPntsThe resulting anchor point array.
inOffSet- internal use only -.
Returns
DtkNoError if OK

◆ GetDatumFeatureIdentifier()

const Dtk_Text& Dtk_FCFFeatureIndicator::GetDatumFeatureIdentifier ( ) const

Retrieves the DatumFeature Identifier of the Dtk_FCFFeatureIndicator - Read Only -.

Returns
The Dtk_FCFFeatureIndicator DatumFeature Identifier.

◆ GetFeatureIndicatorType()

const Dtk_FCFFeatureIndicatorType& Dtk_FCFFeatureIndicator::GetFeatureIndicatorType ( ) const

Retrieves the Full Type of the Dtk_FCFFeatureIndicator - Read Only -.

Returns
The Dtk_FCFFeatureIndicator Dtk_FCFFeatureIndicatorType.

◆ GetOuterBoundingBox()

Dtk_Oriented2dBBox Dtk_FCFFeatureIndicator::GetOuterBoundingBox ( ) const

Retrieves the Dtk_FCFFeatureIndicator Outer Bounding Box.

Returns
The Dtk_FCFFeatureIndicator Outer Bounding Box.

◆ GetSize()

◆ GetSymbol()

const Dtk_Text& Dtk_FCFFeatureIndicator::GetSymbol ( ) const

Retrieves the Symbol of the Dtk_FCFFeatureIndicator - Read Only -.

Returns
The Dtk_FCFFeatureIndicator Symbol.

◆ operator=() [1/2]

Dtk_FCFFeatureIndicator& Dtk_FCFFeatureIndicator::operator= ( const Dtk_FCFFeatureIndicator in)

Copy assignment operator.

Parameters
inObject to copy from.

◆ operator=() [2/2]

Dtk_FCFFeatureIndicator& Dtk_FCFFeatureIndicator::operator= ( Dtk_FCFFeatureIndicator &&  in)

Move assignment operator.

Parameters
inObject to move from.

◆ SetAnchorPoint()

Dtk_ErrorStatus Dtk_FCFFeatureIndicator::SetAnchorPoint ( const Dtk_pnt inNewLocation,
const Dtk_anchor_type inLocationAnchorType 
)

Sets the Dtk_FCFFeatureIndicator anchor point.

Parameters
inNewLocationThe new location point.
inLocationAnchorTypeThe anchor type related to the new location.
Returns
DtkNoError if OK

◆ Transform()

Dtk_ErrorStatus Dtk_FCFFeatureIndicator::Transform ( const Dtk_transfo inTransfo)

Transforms the Dtk_FCFFeatureIndicator giving a transformation matrix.

Parameters
inTranslationDirThe transformation matrix.
Returns
DtkNoError if OK

◆ Translate()

Dtk_ErrorStatus Dtk_FCFFeatureIndicator::Translate ( const Dtk_dir inTranslationDir)

Translates the Dtk_FCFFeatureIndicator giving a translation vector.

Parameters
inTranslationDirThe translation vector.
Returns
DtkNoError if OK

Field Documentation

◆ count_

unsigned long Dtk_Object::count_
protectedinherited

◆ m_Private

Dtk_Handle* Dtk_FCFFeatureIndicator::m_Private
protected