CatiaV4Reader Class Reference

Inheritance diagram for CatiaV4Reader:

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

Static Public Member Functions
static Dtk_bool	checkNewColorMethod ()
static Dtk_bool	Enable ()
static void	EnableNewColorMethod ()
	[Options] More...
static Dtk_ErrorStatus	ReadAnalyticDefinition (Dtk_ID inJele, Dtk_SurfacePtr &outSrf)
	: Read analytic surface ( if available ) used to create the surface of Dtk_FacePtr More...
static void	SetAllowCatiaV4ReadInvalidFiles (const Dtk_bool inValue)
	: Set Preference to change Allow Invalid Catiav4 Files More...
static void	SetConfigMockUpAsMesh (int inValue)
	: Enable or disable conversion from MockUp Solid into a mesh solid More...
static void	SetConfigOrderedSessionTree (Dtk_Int32 inValue)
	: Enable or disable to order session tree according to CATIA V4 structure More...
static void	SetConfigReadAnalyticSurface (int inValue)
	: Enable or disable conversion from nurbs surfaces to analytic surfaces if defined on the file 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

~CatiaV4Reader()

virtual CatiaV4Reader::~CatiaV4Reader ( )

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

virtual Dtk_ErrorStatus Dtk_Reader::ActivateReader ( )

pure virtualinherited

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

checkNewColorMethod()

static Dtk_bool CatiaV4Reader::checkNewColorMethod ( )

static

CreateDocument()

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

pure virtualinherited

Implemented in XmlReader, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, 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, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

Enable()

static Dtk_bool CatiaV4Reader::Enable ( )

static

EnableNewColorMethod()

static void CatiaV4Reader::EnableNewColorMethod ( )

static

[Options]

: Internal use only - Enable or disable new color read method

EndComponent()

virtual Dtk_ErrorStatus Dtk_Reader::EndComponent ( Dtk_ComponentPtr &  inComponent )

pure virtualinherited

Implemented in XmlReader, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, 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, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, 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, 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, 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, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

GetVersion()

virtual Dtk_Int32 Dtk_Reader::GetVersion ( )

pure virtualinherited

Implemented in XmlReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, ObjReader, LavaReader, 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, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, 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, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, ObjReader, LavaReader, 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, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, 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

ReadAnalyticDefinition()

static Dtk_ErrorStatus CatiaV4Reader::ReadAnalyticDefinition ( Dtk_ID  inJele, Dtk_SurfacePtr &  outSrf  )

static

: Read analytic surface ( if available ) used to create the surface of Dtk_FacePtr

Parameters

[in]

inJele

: ID of surface entity , obtain by infos->get_ID() of the Dtk_SurfacePtr of Dtk_FacePtr [out] outSrf : Description of analytic surface found

Returns

status Error dtkErrorAPINotStarted : DtkAPI not started dtkErrorUnavailableReader : CatiaV4 reader not enable dtkCatiaV4_3dReadBadEntityNumber : Bad input parameter : inJele not a surface entity dtkErrorAttributeNotFound : No analytic description available dtkErrorNotProcessed : unknown analytic description

Remarks

: surfaces analytics read are : -Plane (Dtk_PlaneSurface) -Sphere (Dtk_SphericalSurface) -Torus (Dtk_ToroidalSurface) -Cylindrical (Dtk_CylindricalSurface) -Conical (Dtk_ConicalSurface)

Sample:

ReadComponent()

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

pure virtualinherited

Implemented in XmlReader, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, 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, and CreoviewReader.

ReadEntity()

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

pure virtualinherited

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

SetAllowCatiaV4ReadInvalidFiles()

static void CatiaV4Reader::SetAllowCatiaV4ReadInvalidFiles ( const Dtk_bool  inValue )

static

: Set Preference to change Allow Invalid Catiav4 Files

Parameters

[in]

inValue

: 0 Do not read invalid (default) 1 Allow read

SetConfigMockUpAsMesh()

static void CatiaV4Reader::SetConfigMockUpAsMesh ( int  inValue )

static

: Enable or disable conversion from MockUp Solid into a mesh solid

[Options]

Parameters

[in]

inValue

: 0 disable (default) ( MockUp Solid are a Dtk_Body ) 1 enable ( MockUp SOlid are a Dtk_mesh )

SetConfigOrderedSessionTree()

static void CatiaV4Reader::SetConfigOrderedSessionTree ( Dtk_Int32  inValue )

static

: Enable or disable to order session tree according to CATIA V4 structure

Parameters

[in]

inValue

: 0 disable (default) 1 enable

SetConfigReadAnalyticSurface()

static void CatiaV4Reader::SetConfigReadAnalyticSurface ( int  inValue )

static

: Enable or disable conversion from nurbs surfaces to analytic surfaces if defined on the file

Parameters

[in]

inValue

: 0 disable (default) ( keep basic nurbs definition ) 1 enable ( try to replace by analytic surface if stored on the file )

Field Documentation

_InputFile

Dtk_string Dtk_Reader::_InputFile

protectedinherited

_InputFilePtr

FILE* Dtk_Reader::_InputFilePtr

protectedinherited