DATAKIT API  V2025.1
dtk_reader.hpp
Go to the documentation of this file.
1 #ifndef __UTIL_DTK_READER_HPP__
2 #define __UTIL_DTK_READER_HPP__
3 #include "def/define.h"
5 #include "util/dtk_graphical.hpp"
6 #include "util/dtk_maindoc.hpp"
8 #include "util/error_dtk.hpp"
9 #include "util/util_ent_dtk.hpp"
10 #include "util/util_ptr_dtk.hpp"
11 #include "util/util_stl_dtk.hpp"
12 #include <cstdio>
13 
15 {
16 protected:
19 
20  void _Init();
21  void _Reset();
22  Dtk_ErrorStatus _WriteInventoryInLogFile(Dtk_ID inID, int inNum, int *inCount, char **inEntitiesName);
23 
24 
25 public:
26  virtual ~Dtk_Reader();
28 
29  virtual Dtk_ErrorStatus CreateDocument(const Dtk_string &inInputFile,
30  Dtk_MainDocPtr& outDocument) = 0;
31  virtual Dtk_ErrorStatus GetFileVersion(const Dtk_string &inInputFile,
32  Dtk_string& outVersion) = 0;
33  virtual Dtk_ErrorStatus GetFilePreview(const Dtk_string &inInputFile,
34  Dtk_PreviewPtr& outPreview) {DTK_UNUSED(inInputFile); outPreview = NULL; return dtkErrorNotYetImplemented;}
36  const Dtk_string &inInputFile, Dtk_MainDocPtr &inoutDocument,
37  Dtk_ComponentPtr &outRootComponent) = 0;
39  const Dtk_tab< Dtk_StreamPtr >& inArrayStream, Dtk_MainDocPtr& inoutDocument,
40  Dtk_ComponentPtr& outRootComponent ) = 0;
41 
43  virtual Dtk_ErrorStatus ReadComponent( const Dtk_ComponentPtr &inComponent, Dtk_NodePtr& outRootNode ) = 0;
44  virtual Dtk_ErrorStatus ReadComponentGraphic( const Dtk_ComponentPtr &inComponent, Dtk_GraphicalDataPtr& outGraphicalData );
45  virtual Dtk_ErrorStatus ReadEntity(Dtk_Node & inNode, Dtk_EntityPtr &outEntity) = 0;
46  virtual Dtk_ErrorStatus ReadAdditionalInfos(Dtk_Node & inNode,Dtk_ObjectPtr &outEntity) = 0;
48  virtual Dtk_ErrorStatus EndComponent(Dtk_ComponentPtr &inComponent) = 0;
52  outAssociatedEntities.clear(); inNode.GetID(); return dtkErrorNotYetImplemented;};
54  outConnectedEntities.clear(); inCompo.GetID(); return dtkErrorNotYetImplemented;};
56  virtual Dtk_ErrorStatus CreateDocumentGraphical(const Dtk_string& inInputFile, Dtk_MainDocPtr& outDocument);
57  virtual Dtk_Int32 GetVersion() = 0;
58 };
59 #endif
60 
61 #include "util/dtk_AllReader.hpp"
Dtk_Reader::ReadAdditionalInfos
virtual Dtk_ErrorStatus ReadAdditionalInfos(Dtk_Node &inNode, Dtk_ObjectPtr &outEntity)=0
Dtk_ID
uint32_t Dtk_ID
Definition: define.h:689
Dtk_Reader::~Dtk_Reader
virtual ~Dtk_Reader()
Dtk_Reader::EndPopulateComponentsTree
virtual Dtk_ErrorStatus EndPopulateComponentsTree()=0
Dtk_Reader::GetVersion
virtual Dtk_Int32 GetVersion()=0
Dtk_Reader
Definition: dtk_reader.hpp:15
Dtk_Reader::PopulateComponentsTree
virtual Dtk_ErrorStatus PopulateComponentsTree(const Dtk_string &inInputFile, Dtk_MainDocPtr &inoutDocument, Dtk_ComponentPtr &outRootComponent)=0
Dtk_Reader::_InputFile
Dtk_string _InputFile
Definition: dtk_reader.hpp:17
Dtk_Reader::GetConnectorsPointingToThisComponent
virtual Dtk_ErrorStatus GetConnectorsPointingToThisComponent(Dtk_Component &inCompo, Dtk_tab< Dtk_NodeConnectorPtr > &outConnectedEntities)
Definition: dtk_reader.hpp:53
Dtk_string
This is a high level string class.
Definition: dtk_string.hpp:58
Dtk_Reader::PopulateComponentsTree
virtual Dtk_ErrorStatus PopulateComponentsTree(const Dtk_tab< Dtk_StreamPtr > &inArrayStream, Dtk_MainDocPtr &inoutDocument, Dtk_ComponentPtr &outRootComponent)=0
Dtk_Reader::_Reset
void _Reset()
Dtk_Reader::CreateDocument
virtual Dtk_ErrorStatus CreateDocument(const Dtk_string &inInputFile, Dtk_MainDocPtr &outDocument)=0
Dtk_Reader::ReadAdvancedFeature
virtual Dtk_ErrorStatus ReadAdvancedFeature(Dtk_Node &inNode, Dtk_ObjectPtr &outEntity)
Dtk_Reader::_ReadConnectedEntity
virtual Dtk_ErrorStatus _ReadConnectedEntity(const Dtk_NodeConnectorPtr &inConnector, Dtk_tab< Dtk_EntityPtr > &outEntity)
Dtk_Reader::ReadEntity
virtual Dtk_ErrorStatus ReadEntity(Dtk_Node &inNode, Dtk_EntityPtr &outEntity)=0
Dtk_Reader::GetFilePreview
virtual Dtk_ErrorStatus GetFilePreview(const Dtk_string &inInputFile, Dtk_PreviewPtr &outPreview)
Definition: dtk_reader.hpp:33
dtk_graphical.hpp
Dtk_Reader::GetFileVersion
virtual Dtk_ErrorStatus GetFileVersion(const Dtk_string &inInputFile, Dtk_string &outVersion)=0
Dtk_Reader::ReadComponentGraphic
virtual Dtk_ErrorStatus ReadComponentGraphic(const Dtk_ComponentPtr &inComponent, Dtk_GraphicalDataPtr &outGraphicalData)
Dtk_Reader::CreateDocumentGraphical
virtual Dtk_ErrorStatus CreateDocumentGraphical(const Dtk_string &inInputFile, Dtk_MainDocPtr &outDocument)
Dtk_Reader::_WriteInventoryInLogFile
Dtk_ErrorStatus _WriteInventoryInLogFile(Dtk_ID inID, int inNum, int *inCount, char **inEntitiesName)
util_ent_dtk.hpp
Dtk_Node
This is the Node Class The Dtk_Node object is used to retrieve informations in a Dtk_ComponentPtr obj...
Definition: dtk_maindoc.hpp:230
Dtk_Int32
int32_t Dtk_Int32
Definition: define.h:687
dtk_maindoc_ptr.hpp
error_dtk.hpp
Dtk_ErrorStatus
Dtk_ErrorStatus
Definition: error_dtk.hpp:6
dtkErrorNotYetImplemented
@ dtkErrorNotYetImplemented
Definition: error_dtk.hpp:32
Dtk_Reader::_Init
void _Init()
Dtk_SmartPtr
Definition: util_ptr_dtk.hpp:37
dtk_maindoc.hpp
Dtk_DocElement::GetID
Dtk_ID GetID() const
Retrieves the Dtk_DocElement ID - read only -.
Dtk_Reader::_InputFilePtr
FILE * _InputFilePtr
Definition: dtk_reader.hpp:18
util_stl_dtk.hpp
dtk_AllReader.hpp
util_ptr_dtk.hpp
define.h
Dtk_Reader::ReadComponent
virtual Dtk_ErrorStatus ReadComponent(const Dtk_ComponentPtr &inComponent, Dtk_NodePtr &outRootNode)=0
Dtk_tab
This is a high level array class.
Definition: util_stl_dtk.hpp:85
Dtk_Reader::Dtk_Reader
Dtk_Reader()
Dtk_Reader::ActivateReader
virtual Dtk_ErrorStatus ActivateReader()=0
Dtk_Component
This is the Component Class. The Dtk_ComponentPtr object is used as element into an assembly tree....
Definition: dtk_maindoc.hpp:563
dtk_string.hpp
Dtk_Reader::DesactivateReader
virtual Dtk_ErrorStatus DesactivateReader()=0
Dtk_Reader::GetAssociatedEntities
virtual Dtk_ErrorStatus GetAssociatedEntities(Dtk_Node &inNode, Dtk_tab< Dtk_NodeConnectorPtr > &outAssociatedEntities)
Definition: dtk_reader.hpp:51
Dtk_tab::clear
void clear(int no_delete=0)
Resets the Dtk_tab content.
Definition: util_stl_dtk.hpp:351
DTK_UNUSED
#define DTK_UNUSED(a)
Definition: define.h:730
Dtk_Reader::EndComponent
virtual Dtk_ErrorStatus EndComponent(Dtk_ComponentPtr &inComponent)=0