DATAKIT API  V2025.1
Dtk_OverrideInfo Class Reference

This is the Override Information Class.
The Dtk_OverridePtr object is used as override information into an assembly tree.
. More...

+ Inheritance diagram for Dtk_OverrideInfo:

Public Member Functions

 Dtk_OverrideInfo (const Dtk_OverrideInfo &inToBeCopied)
 
Dtk_Int32 DtkDynamicType (const int &inId)
 Retrieves the dynamic entity type. More...
 
virtual void dump (FILE *file=stdout)
 
const Dtk_FeaturePtrGetAssemblyFeature () const
 Retrieves the Dtk_FeaturePtr. More...
 
Dtk_tab< Dtk_NodeConnectorPtr > const & GetConnectors () const
 Retrieves the connectors to the component or entities affected by override. More...
 
const Dtk_InfoPtrGetInfos () const
 Retrieves the Dtk_InfoPtr. More...
 
const Dtk_stringGetName () const
 Retrieves the name. More...
 
const Dtk_transfoPtrGetPosition () const
 Retrieves the position. More...
 
virtual Dtk_Size_t GetSize () const
 
Dtk_ErrorStatus SetConnectors (Dtk_tab< Dtk_NodeConnectorPtr > inConnectedEntities)
 Set the connectors to the component or entities affected by override. More...
 

Static Public Member Functions

static Dtk_OverrideInfoPtr Create (Dtk_string inName, Dtk_InfoPtr inNewAttributes, Dtk_transfoPtr inNewTransformationMatrix, Dtk_FeaturePtr inAssemblyFeature)
 
static Dtk_OverrideInfoDtkDynamicCast (Dtk_Object *s)
 Performs a dynamic cast - doesn't need RTTI -. More...
 

Protected Types

enum  { _typeID = DTK_TYPE_OVERRIDE }
 

Protected Member Functions

void _copy (const Dtk_Object &s)
 
void _init ()
 
void _reset ()
 

Protected Attributes

Dtk_Handle * _Private
 
unsigned long count_
 

Friends

class Dtk_SmartPtr< Dtk_OverrideInfo >
 

Detailed Description

This is the Override Information Class.
The Dtk_OverridePtr object is used as override information into an assembly tree.
.

See also
Please use the Dtk_OverrideInfo class to handle it.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
_typeID 

Constructor & Destructor Documentation

◆ Dtk_OverrideInfo()

Dtk_OverrideInfo::Dtk_OverrideInfo ( const Dtk_OverrideInfo inToBeCopied)

Member Function Documentation

◆ _copy()

void Dtk_Object::_copy ( const Dtk_Object s)
protectedinherited

◆ _init()

void Dtk_Object::_init ( )
protectedinherited

◆ _reset()

void Dtk_Object::_reset ( )
protectedinherited

◆ Create()

static Dtk_OverrideInfoPtr Dtk_OverrideInfo::Create ( Dtk_string  inName,
Dtk_InfoPtr  inNewAttributes,
Dtk_transfoPtr  inNewTransformationMatrix,
Dtk_FeaturePtr  inAssemblyFeature 
)
static

◆ DtkDynamicCast()

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

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

◆ DtkDynamicType()

Dtk_Int32 Dtk_OverrideInfo::DtkDynamicType ( const int &  inId)
virtual

Retrieves the dynamic entity type.

Implements Dtk_Object.

◆ dump()

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

◆ GetAssemblyFeature()

const Dtk_FeaturePtr& Dtk_OverrideInfo::GetAssemblyFeature ( ) const

Retrieves the Dtk_FeaturePtr.

Returns
the Dtk_FeaturePtr if succeeds, nullptr otherwise.

◆ GetConnectors()

Dtk_tab<Dtk_NodeConnectorPtr> const& Dtk_OverrideInfo::GetConnectors ( ) const

Retrieves the connectors to the component or entities affected by override.

Returns
the connectors.

◆ GetInfos()

const Dtk_InfoPtr& Dtk_OverrideInfo::GetInfos ( ) const

Retrieves the Dtk_InfoPtr.

Returns
the Dtk_InfoPtr if succeeds, nullptr otherwise.

◆ GetName()

const Dtk_string& Dtk_OverrideInfo::GetName ( ) const

Retrieves the name.

Returns
the name if succeeds, empty string otherwise.

◆ GetPosition()

const Dtk_transfoPtr& Dtk_OverrideInfo::GetPosition ( ) const

Retrieves the position.

Returns
the position if succeeds, nullptr otherwise.

◆ GetSize()

◆ SetConnectors()

Dtk_ErrorStatus Dtk_OverrideInfo::SetConnectors ( Dtk_tab< Dtk_NodeConnectorPtr inConnectedEntities)

Set the connectors to the component or entities affected by override.

Returns
dtkNoError if ok.

Friends And Related Function Documentation

◆ Dtk_SmartPtr< Dtk_OverrideInfo >

friend class Dtk_SmartPtr< Dtk_OverrideInfo >
friend

Field Documentation

◆ _Private

Dtk_Handle* Dtk_OverrideInfo::_Private
protected

◆ count_

unsigned long Dtk_Object::count_
protectedinherited
Dtk_OverrideInfo::_typeID
@ _typeID
Definition: dtk_override.hpp:23
DTK_TYPE_OVERRIDE
@ DTK_TYPE_OVERRIDE
Definition: define.h:521