DATAKIT API  V2025.1
Dtk_MetaDataGroup Class Referenceabstract
+ Inheritance diagram for Dtk_MetaDataGroup:

Public Member Functions

void AddMetadata (Dtk_MetaDataPtr inChild)
 Add a metadata to this Group. More...
 
 Dtk_MetaDataGroup (Dtk_string inGroupName)
 \Create MetaDataGroup More...
 
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)
 
const Dtk_string GetGroupName ()
 Get the group name. More...
 
const Dtk_tab< Dtk_MetaDataPtr > & GetListOfMetadatas () const
 Get the list of metadata of the MetaDataGroup. More...
 
Dtk_MetaDataPtr GetMetaData (const Dtk_Size_t &inPos)
 Get the inPos'th metadata of the Group. More...
 
const Dtk_Size_t GetNumMetaData () const
 Get the number of metadatas in the Group. More...
 
virtual Dtk_Size_t GetSize () const
 
void SetName (Dtk_string inGroupName)
 Set the group name. More...
 
virtual ~Dtk_MetaDataGroup ()
 Destructor. More...
 

Static Public Member Functions

static Dtk_MetaDataGroupPtr CreateMetaDataGroup (Dtk_string inGroupName, Dtk_tab< Dtk_MetaDataPtr > inMetadataChildren=Dtk_tab< Dtk_MetaDataPtr >())
 
static Dtk_MetaDataGroupDtkDynamicCast (Dtk_Object *s)
 Performs a dynamic cast - doesn't need RTTI -. More...
 

Protected Types

enum  { _typeID = DTK_TYPE_OBJECT }
 
enum  { _typeID = DTK_TYPE_METADATA_GROUP }
 

Protected Member Functions

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

Protected Attributes

unsigned long count_
 

Friends

class Dtk_SmartPtr< Dtk_MetaDataGroup >
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
_typeID 

◆ anonymous enum

anonymous enum
protected
Enumerator
_typeID 

Constructor & Destructor Documentation

◆ Dtk_MetaDataGroup()

Dtk_MetaDataGroup::Dtk_MetaDataGroup ( Dtk_string  inGroupName)

\Create MetaDataGroup

◆ ~Dtk_MetaDataGroup()

virtual Dtk_MetaDataGroup::~Dtk_MetaDataGroup ( )
virtual

Destructor.

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

◆ AddMetadata()

void Dtk_MetaDataGroup::AddMetadata ( Dtk_MetaDataPtr  inChild)

Add a metadata to this Group.

◆ CreateMetaDataGroup()

static Dtk_MetaDataGroupPtr Dtk_MetaDataGroup::CreateMetaDataGroup ( Dtk_string  inGroupName,
Dtk_tab< Dtk_MetaDataPtr inMetadataChildren = Dtk_tabDtk_MetaDataPtr >() 
)
static

◆ DtkDynamicCast()

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

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

340  {
341  if( s->DtkDynamicType(_typeID) ) return static_cast<Dtk_MetaDataGroup*>( s );
342  return NULL;
343  }

◆ DtkDynamicType() [1/2]

Dtk_Int32 Dtk_MetaDataGroup::DtkDynamicType ( const Dtk_Int32 inId)

Retrieves the dynamic entity type.

333  {
334  if( inId == _typeID ) return 1;
336  }

◆ DtkDynamicType() [2/2]

◆ dump()

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

◆ GetGroupName()

const Dtk_string Dtk_MetaDataGroup::GetGroupName ( )

Get the group name.

◆ GetListOfMetadatas()

const Dtk_tab< Dtk_MetaDataPtr >& Dtk_MetaDataGroup::GetListOfMetadatas ( ) const

Get the list of metadata of the MetaDataGroup.

Returns
the list of metadata of this MetaDataGroup.

◆ GetMetaData()

Dtk_MetaDataPtr Dtk_MetaDataGroup::GetMetaData ( const Dtk_Size_t inPos)

Get the inPos'th metadata of the Group.

◆ GetNumMetaData()

const Dtk_Size_t Dtk_MetaDataGroup::GetNumMetaData ( ) const

Get the number of metadatas in the Group.

◆ GetSize()

◆ SetName()

void Dtk_MetaDataGroup::SetName ( Dtk_string  inGroupName)

Set the group name.

Friends And Related Function Documentation

◆ Dtk_SmartPtr< Dtk_MetaDataGroup >

friend class Dtk_SmartPtr< Dtk_MetaDataGroup >
friend

Field Documentation

◆ count_

unsigned long Dtk_Object::count_
protectedinherited
DTK_TYPE_OBJECT
@ DTK_TYPE_OBJECT
Definition: define.h:464
Dtk_MetaDataGroup::DtkDynamicType
Dtk_Int32 DtkDynamicType(const Dtk_Int32 &inId)
Retrieves the dynamic entity type.
Definition: dtk_metadata.hpp:332
Dtk_MetaDataGroup
Definition: dtk_metadata.hpp:308
Dtk_Object::_typeID
@ _typeID
Definition: dtk_object.hpp:13
Dtk_Object::DtkDynamicType
virtual int DtkDynamicType(const int &inId)=0
DTK_TYPE_METADATA_GROUP
@ DTK_TYPE_METADATA_GROUP
Definition: define.h:517
Dtk_MetaDataGroup::_typeID
@ _typeID
Definition: dtk_metadata.hpp:310