Dtk_FCFFeatureIndicator Class Reference

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_Text &	GetDatumFeatureIdentifier () const
	Retrieves the DatumFeature Identifier of the Dtk_FCFFeatureIndicator - Read Only -. More...
const Dtk_FCFFeatureIndicatorType &	GetFeatureIndicatorType () 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_Text &	GetSymbol () const
	Retrieves the Symbol of the Dtk_FCFFeatureIndicator - Read Only -. More...
Dtk_FCFFeatureIndicator &	operator= (const Dtk_FCFFeatureIndicator &in)
	Copy assignment operator. More...
Dtk_FCFFeatureIndicator &	operator= (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_FCFFeatureIndicator *	DtkDynamicCast (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_Object *	Clone ()
	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

{ _typeID = DTK_TYPE_OBJECT }; 

anonymous enum

anonymous enum

protected

Enumerator
_typeID

     {
          _typeID = DTK_TYPE_SPECIFICATION_INDICATOR
     };

Constructor & Destructor Documentation

Dtk_FCFFeatureIndicator() [1/4]

Dtk_FCFFeatureIndicator::Dtk_FCFFeatureIndicator ( )

protected

See also

Create()

     {
          _Init();
     }

Dtk_FCFFeatureIndicator() [2/4]

Dtk_FCFFeatureIndicator::Dtk_FCFFeatureIndicator ( const Dtk_FCFFeatureIndicator &  in )

protected

See also

Create(const Dtk_FCFFeatureIndicator &)

                                                                  : Dtk_Object ( in )
     {
          _Init();
          _Copy( in );
     }

Dtk_FCFFeatureIndicator() [3/4]

Dtk_FCFFeatureIndicator::Dtk_FCFFeatureIndicator ( Dtk_FCFFeatureIndicator &&  in )

protected

See also

Create( Dtk_FCFFeatureIndicator&& )

                                                                          : Dtk_Object( std::move( in ) ), m_Private( in.m_Private )
     {
          in.m_Private = nullptr;
     }

Dtk_FCFFeatureIndicator() [4/4]

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

protected

See also

Create( Dtk_FCFFeatureIndicatorType, Dtk_Text, Dtk_Text )

~Dtk_FCFFeatureIndicator()

Dtk_FCFFeatureIndicator::~Dtk_FCFFeatureIndicator ( )

protected

Destructor.

     {
          _Reset();
     }

Member Function Documentation

Clear()

void Dtk_FCFFeatureIndicator::Clear

(

)

     {
          _Reset();
          _Init();
     }

Clone()

virtual Dtk_Object* Dtk_FCFFeatureIndicator::Clone ( )

protectedvirtual

     {
          return new Dtk_FCFFeatureIndicator( *this );
     }

Create() [1/4]

static Dtk_FCFFeatureIndicatorPtr Dtk_FCFFeatureIndicator::Create ( )

static

Calls default constructor to allocate a new object.

     {
          return new Dtk_FCFFeatureIndicator();
     }

Create() [2/4]

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

static

Calls copy constructor to allocate a new object.

Parameters

in	Object to copy from.

     {
          return new Dtk_FCFFeatureIndicator( in );
     }

Create() [3/4]

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

static

Calls move constructor to allocate a new object.

Parameters

in	Object to move from.

     {
          return new Dtk_FCFFeatureIndicator( std::move( in ) );
     }

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

inFeatureIndicatorType	The FeatureIndicator Type.
inSymbol	The FeatureIndicator symbol.
inDatumFeatureIdentifier	The FeatureIndicator Datum feature identifier.

Returns

the created Dtk_FCFFeatureIndicatorPtr

     {
          return new Dtk_FCFFeatureIndicator( std::move( inFeatureIndicatorType ), std::move( inSymbol ), std::move( inDatumFeatureIdentifier ) );
     }

DtkDynamicCast()

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

static

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

     {
          if( s->DtkDynamicType( _typeID ) )
               return static_cast< Dtk_FCFFeatureIndicator* >( s );
          return NULL;
     }

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_FCFFeatureIndicator::DtkDynamicType

(

const Dtk_Int32 &

inId

)

Retrieves the dynamic entity type.

     {
          if( inId == _typeID )
               return 1;
          return Dtk_Object::DtkDynamicType( inId );
     }

DtkDynamicType() [2/2]

virtual int Dtk_Object::DtkDynamicType ( const int &  inId )

pure virtualinherited

Implemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TopologicalEntity, Dtk_MeshPolyline, Dtk_MeshSurface, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Constraint, Dtk_ConstraintReference, Dtk_AxisSystem, Dtk_Preview, Dtk_Entity, Dtk_picture, Dtk_OverrideSet, Dtk_OverrideInfo, Dtk_MainDoc, Dtk_Component, Dtk_Node, Dtk_DocElement, Dtk_Log, and Dtk_Properties.

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

outText	Resulting composite text
outGeomsArray	Resulting 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

outTabPnts	The 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()

virtual Dtk_Size_t Dtk_Object::GetSize ( ) const

virtualinherited

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_mesh_face, Dtk_mesh, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Entity, and Dtk_Info.

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

in	Object to copy from.

operator=() [2/2]

Dtk_FCFFeatureIndicator& Dtk_FCFFeatureIndicator::operator=

(

Dtk_FCFFeatureIndicator &&

in

)

Move assignment operator.

Parameters

in	Object 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

inNewLocation	The new location point.
inLocationAnchorType	The 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

inTranslationDir

The 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

inTranslationDir

The translation vector.

Returns

DtkNoError if OK

Field Documentation

count_

unsigned long Dtk_Object::count_

protectedinherited

m_Private

Dtk_Handle* Dtk_FCFFeatureIndicator::m_Private

protected