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

Public Member Functions

virtual Dtk_ErrorStatus _ReadConnectedEntity (const Dtk_NodeConnectorPtr &inConnector, Dtk_tab< Dtk_EntityPtr > &outEntity)
 
virtual Dtk_ErrorStatus ActivateReader ()=0
 
virtual Dtk_ErrorStatus CreateDocument (const Dtk_string &inInputFile, Dtk_MainDocPtr &outDocument)=0
 
virtual Dtk_ErrorStatus CreateDocumentGraphical (const Dtk_string &inInputFile, Dtk_MainDocPtr &outDocument)
 
virtual Dtk_ErrorStatus DesactivateReader ()=0
 
virtual Dtk_ErrorStatus EndComponent (Dtk_ComponentPtr &inComponent)=0
 
virtual Dtk_ErrorStatus EndPopulateComponentsTree ()=0
 
virtual Dtk_ErrorStatus GetAssociatedEntities (Dtk_Node &inNode, Dtk_tab< Dtk_NodeConnectorPtr > &outAssociatedEntities)
 
virtual Dtk_ErrorStatus GetConnectorsPointingToThisComponent (Dtk_Component &inCompo, Dtk_tab< Dtk_NodeConnectorPtr > &outConnectedEntities)
 
virtual Dtk_ErrorStatus GetFilePreview (const Dtk_string &inInputFile, Dtk_PreviewPtr &outPreview)
 
virtual Dtk_ErrorStatus GetFileVersion (const Dtk_string &inInputFile, Dtk_string &outVersion)=0
 
void * GetSearchEngine ()
 
virtual Dtk_Int32 GetVersion ()=0
 
virtual Dtk_ErrorStatus PopulateComponentsTree (const Dtk_string &inInputFile, Dtk_MainDocPtr &inoutDocument, Dtk_ComponentPtr &outRootComponent)=0
 
virtual Dtk_ErrorStatus PopulateComponentsTree (const Dtk_tab< Dtk_StreamPtr > &inArrayStream, Dtk_MainDocPtr &inoutDocument, Dtk_ComponentPtr &outRootComponent)=0
 
virtual Dtk_ErrorStatus ReadAdditionalInfos (Dtk_Node &inNode, Dtk_ObjectPtr &outEntity)=0
 
virtual Dtk_ErrorStatus ReadAdvancedFeature (Dtk_Node &inNode, Dtk_ObjectPtr &outEntity)
 
virtual Dtk_ErrorStatus ReadComponent (const Dtk_ComponentPtr &inComponent, Dtk_NodePtr &outRootNode)=0
 
virtual Dtk_ErrorStatus ReadComponentGraphic (const Dtk_ComponentPtr &inComponent, Dtk_GraphicalDataPtr &outGraphicalData)
 
virtual Dtk_ErrorStatus ReadEntity (Dtk_Node &inNode, Dtk_EntityPtr &outEntity)=0
 
virtual ~CatiaV5Reader ()=0
 

Static Public Member Functions

static Dtk_bool Enable ()
 
static void EnableReversedOrientationSurfacicFace ()
 reverse the orientation of the surfacic face. More...
 
static void SetConfigV52dFilterDetailSheets (Dtk_bool inFiltered)
 Lets handle 2d Detail Sheets filtering. More...
 
static void SetConfigV5ActivateNewFDTGeomLinks (Dtk_bool inActivateNewFDTGeomLinks)
 Activate the new FDT->Geom Link reading. More...
 
static void SetConfigV5ReadCGMPicturesAsCompositeEntities (Dtk_bool inProcessAsCompositeEntities)
 Lets Process CGM V5 pictures as Dtk_CompositeEntity whereas a Dtk_picture. More...
 

Protected Member Functions

void _Init ()
 
void _Reset ()
 
Dtk_ErrorStatus _WriteInventoryInLogFile (Dtk_ID inID, int inNum, int *inCount, char **inEntitiesName)
 

Protected Attributes

Dtk_string _InputFile
 
FILE * _InputFilePtr
 

Constructor & Destructor Documentation

◆ ~CatiaV5Reader()

virtual CatiaV5Reader::~CatiaV5Reader ( )
pure virtual

Member Function Documentation

◆ _Init()

void Dtk_Reader::_Init ( )
protectedinherited

◆ _ReadConnectedEntity()

virtual Dtk_ErrorStatus Dtk_Reader::_ReadConnectedEntity ( const Dtk_NodeConnectorPtr inConnector,
Dtk_tab< Dtk_EntityPtr > &  outEntity 
)
virtualinherited

Reimplemented in GltfReader.

◆ _Reset()

void Dtk_Reader::_Reset ( )
protectedinherited

◆ _WriteInventoryInLogFile()

Dtk_ErrorStatus Dtk_Reader::_WriteInventoryInLogFile ( Dtk_ID  inID,
int  inNum,
int *  inCount,
char **  inEntitiesName 
)
protectedinherited

◆ ActivateReader()

◆ CreateDocument()

◆ CreateDocumentGraphical()

virtual Dtk_ErrorStatus Dtk_Reader::CreateDocumentGraphical ( const Dtk_string inInputFile,
Dtk_MainDocPtr outDocument 
)
virtualinherited

Reimplemented in ProeReader, and GltfReader.

◆ DesactivateReader()

◆ Enable()

static Dtk_bool CatiaV5Reader::Enable ( )
static

◆ EnableReversedOrientationSurfacicFace()

static void CatiaV5Reader::EnableReversedOrientationSurfacicFace ( )
static

reverse the orientation of the surfacic face.

◆ EndComponent()

◆ EndPopulateComponentsTree()

◆ GetAssociatedEntities()

virtual Dtk_ErrorStatus Dtk_Reader::GetAssociatedEntities ( Dtk_Node inNode,
Dtk_tab< Dtk_NodeConnectorPtr > &  outAssociatedEntities 
)
virtualinherited

Reimplemented in StepReader, SolidEdgeReader, ProeReader, JtReader, GltfReader, CreoviewReader, and BRepOccReader.

51  {
52  outAssociatedEntities.clear(); inNode.GetID(); return dtkErrorNotYetImplemented;};

◆ GetConnectorsPointingToThisComponent()

virtual Dtk_ErrorStatus Dtk_Reader::GetConnectorsPointingToThisComponent ( Dtk_Component inCompo,
Dtk_tab< Dtk_NodeConnectorPtr > &  outConnectedEntities 
)
virtualinherited

Reimplemented in StepReader, SolidEdgeReader, ProeReader, JtReader, GltfReader, CreoviewReader, and BRepOccReader.

53  {
54  outConnectedEntities.clear(); inCompo.GetID(); return dtkErrorNotYetImplemented;};

◆ GetFilePreview()

virtual Dtk_ErrorStatus Dtk_Reader::GetFilePreview ( const Dtk_string inInputFile,
Dtk_PreviewPtr outPreview 
)
virtualinherited

Reimplemented in SolidEdgeReader, ProeReader, and _3dmReader.

34  {DTK_UNUSED(inInputFile); outPreview = NULL; return dtkErrorNotYetImplemented;}

◆ GetFileVersion()

◆ GetSearchEngine()

void* CatiaV5Reader::GetSearchEngine ( )

◆ GetVersion()

◆ PopulateComponentsTree() [1/2]

◆ PopulateComponentsTree() [2/2]

◆ ReadAdditionalInfos()

◆ ReadAdvancedFeature()

virtual Dtk_ErrorStatus Dtk_Reader::ReadAdvancedFeature ( Dtk_Node inNode,
Dtk_ObjectPtr outEntity 
)
virtualinherited

◆ ReadComponent()

◆ ReadComponentGraphic()

virtual Dtk_ErrorStatus Dtk_Reader::ReadComponentGraphic ( const Dtk_ComponentPtr inComponent,
Dtk_GraphicalDataPtr outGraphicalData 
)
virtualinherited

◆ ReadEntity()

◆ SetConfigV52dFilterDetailSheets()

static void CatiaV5Reader::SetConfigV52dFilterDetailSheets ( Dtk_bool  inFiltered)
static

Lets handle 2d Detail Sheets filtering.

Parameters
inFilteredDTK_TRUE to filter or DTK_FALSE otherwise.
Warning
please call it before the Dtk_API::ReadComponent call.

◆ SetConfigV5ActivateNewFDTGeomLinks()

static void CatiaV5Reader::SetConfigV5ActivateNewFDTGeomLinks ( Dtk_bool  inActivateNewFDTGeomLinks)
static

Activate the new FDT->Geom Link reading.

Parameters
inActivateNewFDTGeomLinksDTK_TRUE to activate the new reading. DTK_FALSE otherwise.
Warning
beta feature. Use it at your own risk.

◆ SetConfigV5ReadCGMPicturesAsCompositeEntities()

static void CatiaV5Reader::SetConfigV5ReadCGMPicturesAsCompositeEntities ( Dtk_bool  inProcessAsCompositeEntities)
static

Lets Process CGM V5 pictures as Dtk_CompositeEntity whereas a Dtk_picture.

Parameters
inProcessAsCompositeEntitiesDTK_TRUE to process as Dtk_CompositeEntity. DTK_FALSE as a Dtk_picture.
Warning
please call it before the Dtk_API::ReadComponent call.

Field Documentation

◆ _InputFile

Dtk_string Dtk_Reader::_InputFile
protectedinherited

◆ _InputFilePtr

FILE* Dtk_Reader::_InputFilePtr
protectedinherited
dtkErrorNotYetImplemented
@ dtkErrorNotYetImplemented
Definition: error_dtk.hpp:32
Dtk_DocElement::GetID
Dtk_ID GetID() const
Retrieves the Dtk_DocElement ID - read only -.
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