SeReader Class Reference

Inheritance diagram for SeReader:

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 ()
Dtk_Reader *	GetSubReader ()
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
	SetAsDeprecated ("2020.3", "Use SolidEdgeReader instead") static Dtk_bool Enable()
	~SeReader ()

Static Public Member Functions
static void	AddSplitFeatureName (type_detk inType)
	split the name for this entity type More...
static void	ClearSplitFeatureName ()
static Dtk_bool	Enable ()
static void	RemoveDefaultName (Dtk_bool inRemoveDefaultName)
	remove default name for entity as point , line , arc ... More...
static void	RemoveFeatureName (Dtk_bool inRemoveFeatureName)
	keep geometry name instead feature name More...
static void	RemoveFeatureTree (Dtk_bool inRemoveFeatureTree)
	remove the feature tree More...
static void	RemoveZoomFitCamera (Dtk_bool inRemoveZoomfit)
	remove zoomfit camera More...
static void	SetManageAssemblyAsPart (Dtk_bool inManageAsPart)
	Use to manage an assembly file as a part. More...
static void	UseCdfFilename (const Dtk_string &inCdfFilename)
	use this cdf file More...

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

Protected Attributes
Dtk_string	_InputFile
FILE *	_InputFilePtr

Constructor & Destructor Documentation

SeReader()

SeReader::SeReader ( )

protected

~SeReader()

SeReader::~SeReader

(

)

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()

virtual Dtk_ErrorStatus Dtk_Reader::ActivateReader ( )

pure virtualinherited

Implemented in XmlReader, VdaReader, U3dReader, StlReader, StepReader, SolidEdgeReader, SatReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, JtReader, IgesReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

AddSplitFeatureName()

static void UgReader::AddSplitFeatureName ( type_detk  inType )

staticinherited

split the name for this entity type

Parameters

inType

type_detk to split name

ClearSplitFeatureName()

static void UgReader::ClearSplitFeatureName ( )

staticinherited

CreateDocument()

virtual Dtk_ErrorStatus Dtk_Reader::CreateDocument ( const Dtk_string &  inInputFile, Dtk_MainDocPtr &  outDocument  )

pure virtualinherited

Implemented in XmlReader, VdaReader, U3dReader, StlReader, StepReader, SolidEdgeReader, SatReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, JtReader, IgesReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

CreateDocumentGraphical()

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

virtualinherited

Reimplemented in ProeReader, and GltfReader.

DesactivateReader()

virtual Dtk_ErrorStatus Dtk_Reader::DesactivateReader ( )

pure virtualinherited

Implemented in XmlReader, VdaReader, U3dReader, StlReader, StepReader, SolidEdgeReader, SatReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, JtReader, IgesReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

Enable()

static Dtk_bool UgReader::Enable ( )

staticinherited

EndComponent()

virtual Dtk_ErrorStatus Dtk_Reader::EndComponent ( Dtk_ComponentPtr &  inComponent )

pure virtualinherited

Implemented in XmlReader, VdaReader, U3dReader, StlReader, StepReader, SolidEdgeReader, SatReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, JtReader, IgesReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

EndPopulateComponentsTree()

virtual Dtk_ErrorStatus Dtk_Reader::EndPopulateComponentsTree ( )

pure virtualinherited

Implemented in XmlReader, VdaReader, U3dReader, StlReader, StepReader, SolidEdgeReader, SatReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, JtReader, IgesReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

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.

                                                                                                                           { 
        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.

                                                                                                                                             { 
               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.

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

GetFileVersion()

virtual Dtk_ErrorStatus Dtk_Reader::GetFileVersion ( const Dtk_string &  inInputFile, Dtk_string &  outVersion  )

pure virtualinherited

Implemented in XmlReader, VdaReader, U3dReader, StlReader, StepReader, SolidEdgeReader, SatReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, JtReader, IgesReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

GetSearchEngine()

void* UgReader::GetSearchEngine ( )

inherited

GetSubReader()

Dtk_Reader* UgReader::GetSubReader ( )

inherited

GetVersion()

virtual Dtk_Int32 Dtk_Reader::GetVersion ( )

pure virtualinherited

Implemented in XmlReader, VdaReader, StlReader, StepReader, SolidEdgeReader, SatReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, ObjReader, LavaReader, JtReader, IgesReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

PopulateComponentsTree() [1/2]

virtual Dtk_ErrorStatus Dtk_Reader::PopulateComponentsTree ( const Dtk_string &  inInputFile, Dtk_MainDocPtr &  inoutDocument, Dtk_ComponentPtr &  outRootComponent  )

pure virtualinherited

Implemented in XmlReader, VdaReader, U3dReader, StlReader, StepReader, SolidEdgeReader, SatReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, JtReader, IgesReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

PopulateComponentsTree() [2/2]

virtual Dtk_ErrorStatus Dtk_Reader::PopulateComponentsTree ( const Dtk_tab< Dtk_StreamPtr > &  inArrayStream, Dtk_MainDocPtr &  inoutDocument, Dtk_ComponentPtr &  outRootComponent  )

pure virtualinherited

Implemented in XmlReader, VdaReader, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, ObjReader, LavaReader, JtReader, IgesReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

ReadAdditionalInfos()

virtual Dtk_ErrorStatus Dtk_Reader::ReadAdditionalInfos ( Dtk_Node &  inNode, Dtk_ObjectPtr &  outEntity  )

pure virtualinherited

Implemented in XmlReader, VdaReader, U3dReader, StlReader, StepReader, SolidEdgeReader, SatReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, JtReader, IgesReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

ReadAdvancedFeature()

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

virtualinherited

ReadComponent()

virtual Dtk_ErrorStatus Dtk_Reader::ReadComponent ( const Dtk_ComponentPtr &  inComponent, Dtk_NodePtr &  outRootNode  )

pure virtualinherited

Implemented in XmlReader, VdaReader, U3dReader, StlReader, StepReader, SolidEdgeReader, SatReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, JtReader, IgesReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

ReadComponentGraphic()

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

virtualinherited

Reimplemented in StlReader, ProeReader, GltfReader, FbxReader, CreoviewReader, and JtReader.

ReadEntity()

virtual Dtk_ErrorStatus Dtk_Reader::ReadEntity ( Dtk_Node &  inNode, Dtk_EntityPtr &  outEntity  )

pure virtualinherited

Implemented in XmlReader, VdaReader, U3dReader, StlReader, StepReader, SolidEdgeReader, SatReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, JtReader, IgesReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

RemoveDefaultName()

static void UgReader::RemoveDefaultName ( Dtk_bool  inRemoveDefaultName )

staticinherited

remove default name for entity as point , line , arc ...

Parameters

inRemoveDefaultName

DTK_TRUE to remove the default name

Warning

call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.

RemoveFeatureName()

static void UgReader::RemoveFeatureName ( Dtk_bool  inRemoveFeatureName )

staticinherited

keep geometry name instead feature name

Parameters

inRemoveFeatureName

DTK_TRUE to remove the feature name

Warning

call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.

RemoveFeatureTree()

static void UgReader::RemoveFeatureTree ( Dtk_bool  inRemoveFeatureTree )

staticinherited

remove the feature tree

Parameters

inRemoveFeatureTree

DTK_TRUE to remove the feature tree

Warning

call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.

RemoveZoomFitCamera()

static void UgReader::RemoveZoomFitCamera ( Dtk_bool  inRemoveZoomfit )

staticinherited

remove zoomfit camera

Parameters

inRemoveZoomfit

DTK_TRUE to remove the zoomfit

Warning

call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.

SetAsDeprecated()

SeReader::SetAsDeprecated	(	"2020.3"	,
		"Use SolidEdgeReader instead"
	)

SetManageAssemblyAsPart()

static void UgReader::SetManageAssemblyAsPart ( Dtk_bool  inManageAsPart )

staticinherited

Use to manage an assembly file as a part.

Parameters

inManageAsPart

DTK_TRUE to manage an assembly as a part

Warning

call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.

UseCdfFilename()

static void UgReader::UseCdfFilename ( const Dtk_string &  inCdfFilename )

staticinherited

use this cdf file

Parameters

inCdfFilename

name of cdf file

Warning

call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.

Field Documentation

_InputFile

Dtk_string Dtk_Reader::_InputFile

protectedinherited

_InputFilePtr

FILE* Dtk_Reader::_InputFilePtr

protectedinherited