DATAKIT API  V2025.1
Dtk_OverrideSet Class Reference

This is the Override Set Class.
The Dtk_OverrideSetPtr object is used as override set into an assembly tree.
. More...

+ Inheritance diagram for Dtk_OverrideSet:

Public Member Functions

Dtk_ErrorStatus AddOverrideInfoOnComponent (Dtk_OverrideInfoPtr inOverrideInfo)
 
Dtk_ErrorStatus AddOverrideInfoOnNode (Dtk_OverrideInfoPtr inOverrideInfo)
 
Dtk_ErrorStatus ClearVolatileInfos ()
 Clear Volatile Override Infos. More...
 
 Dtk_OverrideSet (const Dtk_OverrideSet &inToBeCopied)
 
Dtk_Int32 DtkDynamicType (const int &inId)
 Retrieves the dynamic entity type. More...
 
virtual void dump (FILE *file=stdout)
 
Dtk_tab< Dtk_NodeConnectorPtr > const & GetConnectors () const
 Retrieves the connectors to the component or entities affected by override. More...
 
const Dtk_stringGetName () const
 Retrieves the name . More...
 
Dtk_tab< Dtk_OverrideInfoPtr > const & GetOverrideInfoListOnComponent () const
 Retrieves the overrides. More...
 
Dtk_tab< Dtk_OverrideInfoPtr > const & GetOverrideInfoListOnNode () const
 
virtual Dtk_Size_t GetSize () const
 
const Dtk_stringGetTargetName () const
 Retrieves the target name. More...
 
Dtk_bool IsActivated ()
 Ge. More...
 
void SetActivated (Dtk_bool inActivationFlag)
 
Dtk_ErrorStatus SetConnectors (Dtk_tab< Dtk_NodeConnectorPtr > inConnectedEntities)
 Set the connectors to the component or entities affected by override. More...
 
Dtk_ErrorStatus SetOverrideInfoListOnComponent (Dtk_tab< Dtk_OverrideInfoPtr > inOverrideInfoList)
 Set the connectors to the component or entities affected by override. More...
 
Dtk_ErrorStatus SetOverrideInfoListOnNode (Dtk_tab< Dtk_OverrideInfoPtr > inOverrideInfoList)
 

Static Public Member Functions

static Dtk_OverrideSetPtr Create (Dtk_string inName, Dtk_string inTargetName=Dtk_string())
 
static Dtk_OverrideSetDtkDynamicCast (Dtk_Object *s)
 Performs a dynamic cast - doesn't need RTTI -. More...
 

Protected Types

enum  { _typeID = DTK_TYPE_OBJECT }
 
enum  { _typeID = DTK_TYPE_OVERRIDE_SET }
 

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_OverrideSet >
 

Detailed Description

This is the Override Set Class.
The Dtk_OverrideSetPtr object is used as override set into an assembly tree.
.

See also
Please use the Dtk_OverrideSet 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_OverrideSet()

Dtk_OverrideSet::Dtk_OverrideSet ( const Dtk_OverrideSet 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

◆ AddOverrideInfoOnComponent()

Dtk_ErrorStatus Dtk_OverrideSet::AddOverrideInfoOnComponent ( Dtk_OverrideInfoPtr  inOverrideInfo)

◆ AddOverrideInfoOnNode()

Dtk_ErrorStatus Dtk_OverrideSet::AddOverrideInfoOnNode ( Dtk_OverrideInfoPtr  inOverrideInfo)

◆ ClearVolatileInfos()

Dtk_ErrorStatus Dtk_OverrideSet::ClearVolatileInfos ( )

Clear Volatile Override Infos.

Returns
dtkNoError if ok.

◆ Create()

static Dtk_OverrideSetPtr Dtk_OverrideSet::Create ( Dtk_string  inName,
Dtk_string  inTargetName = Dtk_string() 
)
static

◆ DtkDynamicCast()

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

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

◆ DtkDynamicType()

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

Retrieves the dynamic entity type.

Implements Dtk_Object.

◆ dump()

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

◆ GetConnectors()

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

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

Returns
the connectors.

◆ GetName()

const Dtk_string& Dtk_OverrideSet::GetName ( ) const

Retrieves the name .

Returns
the name if succeeds, empty string otherwise.

◆ GetOverrideInfoListOnComponent()

Dtk_tab<Dtk_OverrideInfoPtr> const& Dtk_OverrideSet::GetOverrideInfoListOnComponent ( ) const

Retrieves the overrides.

Returns
the overrides.

◆ GetOverrideInfoListOnNode()

Dtk_tab<Dtk_OverrideInfoPtr> const& Dtk_OverrideSet::GetOverrideInfoListOnNode ( ) const

◆ GetSize()

◆ GetTargetName()

const Dtk_string& Dtk_OverrideSet::GetTargetName ( ) const

Retrieves the target name.

Returns
the target name if succeeds, empty string otherwise.

◆ IsActivated()

Dtk_bool Dtk_OverrideSet::IsActivated ( )

Ge.

Returns
DTK_TRUE if this override set is activated, DTK_FALSE otherwise.

◆ SetActivated()

void Dtk_OverrideSet::SetActivated ( Dtk_bool  inActivationFlag)

◆ SetConnectors()

Dtk_ErrorStatus Dtk_OverrideSet::SetConnectors ( Dtk_tab< Dtk_NodeConnectorPtr inConnectedEntities)

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

Returns
dtkNoError if ok.

◆ SetOverrideInfoListOnComponent()

Dtk_ErrorStatus Dtk_OverrideSet::SetOverrideInfoListOnComponent ( Dtk_tab< Dtk_OverrideInfoPtr inOverrideInfoList)

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

Returns
dtkNoError if ok.

◆ SetOverrideInfoListOnNode()

Dtk_ErrorStatus Dtk_OverrideSet::SetOverrideInfoListOnNode ( Dtk_tab< Dtk_OverrideInfoPtr inOverrideInfoList)

Friends And Related Function Documentation

◆ Dtk_SmartPtr< Dtk_OverrideSet >

friend class Dtk_SmartPtr< Dtk_OverrideSet >
friend

Field Documentation

◆ _Private

Dtk_Handle* Dtk_OverrideSet::_Private
protected

◆ count_

unsigned long Dtk_Object::count_
protectedinherited
DTK_TYPE_OBJECT
@ DTK_TYPE_OBJECT
Definition: define.h:464
DTK_TYPE_OVERRIDE_SET
@ DTK_TYPE_OVERRIDE_SET
Definition: define.h:522
Dtk_OverrideSet::_typeID
@ _typeID
Definition: dtk_override.hpp:74
Dtk_Object::_typeID
@ _typeID
Definition: dtk_object.hpp:13