Main workflow

Datakit API allows you to get data from CAD files, all covered by the same implementation.

Dtk_API is a singleton. That means only one session can be running at a time.

General process follow these steps :

Session Start

You have to enable the readers you want to use calling static method Enable().

This will trigger the need to link against corresponding libraries (please see Datakit Libraries and usage or individual reader pages)

Start the API by calling Dtk_API::StartAPI()

//First You have to Enable the readers you want to use 
//...
CatiaV5Reader::Enable();
StepReader::Enable();
 //...
 //Then You have to Start DATAKIT API
Dtk_ErrorStatus errorStatus = dtkNoError; 
Dtk_API * MyAPI = Dtk_API::StartAPI(TemporaryWorkingDirectory, errorStatus);

Document Context

When API is started you can use Dtk_API::OpenDocument() method to read a file. This method :

recognizes the input CAD file format
calls the corresponding reader
populates a global assembly tree (please see How to use Assembly Tree for details)

Assembly and Constructions Trees

From assembly tree root, you can browse components :

call Dtk_API::ReadComponent() method to get component Construction tree (please see How to use Construction Tree for details)
explore component children
close and free memory for current component with Dtk_API::EndComponent()

From this construction tree, you can browse tree nodes :

get the data type returned by Dtk_Node::GetNodeFullType()
call the corresponding method (Dtk_Node::GetDtk_BodyPtr(), Dtk_Node::GetDtk_MeshPtr()...) to get the full data information.

Session End

In order to properly free memory and re-initialize reader context :

close the document with Dtk_API::EndDocument() method to free data and memory used by the reader.
In the end, you need to stop the API by calling Dtk_API::StopAPI()

All classes except Dtk_API are handled via Smart Pointers.
They are deleted and freed automatically when they are out of scope.
See How to use Smart Pointers for details.

Step-by-step Sample Code

// First You have to Enable the readers you want to use 
CatiaV5Reader::Enable();   
// Then You have to Start DATAKIT API   
Dtk_API * MyAPI = Dtk_API::StartAPI(TemporaryWorkingDirectory, errorStatus);

Session Context (Dtk_API)
Datakit Libraries and usage

// You open the file and create Document with its assembly tree
Dtk_MainDocPtr inDocument;
err = MyAPI->OpenDocument(inInputFile, inDocument);

File Context (Dtk_MainDoc)

// First we get the root component in the document
Dtk_ComponentPtr RootComponent = inDocument->RootComponent();
// Deal with Dtk_Component tree then for each Prototype get the construction tree
Dtk_ErrorStatus err = MyAPI->ReadComponent(RootComponent, RootNode);

Assembly Tree Context (Dtk_Component)
How to use Assembly Tree

// Deal with Dtk_Node tree then for each Node get associated data

Dtk_BodyPtr TmpBody = RootNode->Get_DtkBodyPtr();

Construction Tree Context (Dtk_Node)
How to use Construction Tree

// We close the opened component

err = MyAPI->EndComponent(inComponent);

// We close the opened document

err = MyAPI->EndDocument(TmpDoc);

// At then end we stop datakit API

Dtk_API::StopAPI(MyAPI);