util_xml_dtk.hpp

Go to the documentation of this file.

#ifndef _UTIL_XML_DTK_
#define _UTIL_XML_DTK_
#include "util/BaseTypes/dtk_dir.hpp"
#include "util/BaseTypes/dtk_metadata.hpp"
#include "util/BaseTypes/dtk_pnt.hpp"
#include "util/BaseTypes/dtk_string.hpp"
#include "util/BaseTypes/dtk_transfo.hpp"
#include "util/dtk_global_data_set_ptr.hpp"
#include "util/dtk_graphical.hpp"
#include "util/dtk_maindoc.hpp"
#include "util/dtk_maindoc_ptr.hpp"
#include "util/error_dtk.hpp"
#include "util/util_draw_dtk.hpp"
#include "util/util_draw_ptr_dtk.hpp"
#include "util/util_ent_dtk.hpp"
#include "util/util_geom_ptr_dtk.hpp"
#include "util/util_kinematics_dtk.hpp"
#include "util/util_mesh_dtk.hpp"
#include "util/util_ptr_dtk.hpp"
#include "util/util_topology_ptr_dtk.hpp"
#include <cstdio>
#include "def/define.h"
#include <iosfwd>
#include <sstream>
#include "struct/str_feat_dtk.hpp"
 
#ifdef __DTK_SAMPLE_PROJECT__
//#  pragma message("Dtk_DumpXml methods into SampleProjectNamespace namespace" )
#   define Dtk_DumpXMLNamespace SampleProjectNamespace
namespace Dtk_DumpXMLNamespace
{
#else
//#  pragma message("Dtk_DumpXml methods into global namespace" )
#   define Dtk_DumpXMLNamespace 
#endif
 
//enums///////////////////////////////////////////////////////////////////
Dtk_string DtkReaderTypeEnumToString( const DtkReaderType& inReaderTypeEnum );
void Dtk_DumpXml_ComponentTypeEnum(FILE * F,
                                   const Dtk_Component::ComponentTypeEnum& inEnum,
                                   const Dtk_string& inPropertyName);
 
//FDT/////////////////////////////////////////////////////////////////////
Dtk_ErrorStatus Dtk_DumpXml_DTK_FDT_MODIFIER(FILE* F,const DTK_FDT_MODIFIER& D);
Dtk_ErrorStatus Dtk_DumpXml_DTK_DATUM_COMPOSING_RULE(FILE* F,const DTK_DATUM_COMPOSING_RULE& D);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_anchor_type(FILE* F,const Dtk_anchor_type & D);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_FdtPtr(FILE* F,const Dtk_FdtPtr& D,const int& compact = 1);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_CameraPtr(FILE*F, const Dtk_CameraPtr& inVal);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_ConstraintPtr(FILE*F, const Dtk_ConstraintPtr& inVal);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_FeaturePtr(FILE*F, const Dtk_FeaturePtr& inVal);
Dtk_ErrorStatus Dtk_DumpXml_Fdt(const Dtk_FdtPtr& D);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_ModelDisplayPtr(FILE*F, const Dtk_ModelDisplayPtr& inVal);
 
//2D//////////////////////////////////////////////////////////////////////
Dtk_ErrorStatus Dtk_DumpXml_Dtk_DrawingPtr(FILE*,const Dtk_DrawingPtr&,const int& compact=1);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_2dEntityPtr(FILE* F,const Dtk_2dEntityPtr& D,const int& compact=1);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_ViewPtr(FILE* F,const Dtk_ViewPtr& V);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_LeaderPtr(FILE* F,const Dtk_LeaderPtr& L);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_ReferenceBlockPtr(FILE* F,const Dtk_ReferenceBlockPtr& D);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_ReferenceFramePtr(FILE* F,const Dtk_ReferenceFramePtr& D);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_GeometricalTolerancePtr(FILE* F,const Dtk_GeometricalTolerancePtr& D);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_ToleranceSpecificationContainerPtr(FILE* F,const Dtk_ToleranceSpecificationContainerPtr& D);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_DatumTargetPtr(FILE* F,const Dtk_DatumTargetPtr& D);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_TablePtr(FILE* F,const Dtk_TablePtr& D);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_GridPtr(FILE* F, const Dtk_GridPtr& D);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_OneCell(FILE* F, Dtk_OneCell& D);
void Dtk_DumpXml_Drawing(FILE *inDump, const Dtk_DrawingPtr &D);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_ToleranceSpecificationPtr(FILE* F,const Dtk_ToleranceSpecificationPtr& D);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_RoughnessPtr(FILE* F,const Dtk_RoughnessPtr& D);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_WeldingPtr(FILE* F,const Dtk_WeldingPtr& D);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_roughness_rough_mode(FILE* F,const Dtk_Roughness::RoughModeEnum & D);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_roughness_roughness_applyto(FILE* F,const Dtk_Roughness::ApplyToEnum & D);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_roughness_obtention_type(FILE* F,const Dtk_Roughness::ObtentionTypeEnum & D);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_ToleranceSpecificationContainerPtrType(FILE* F,const Dtk_ToleranceSpecificationContainer::TypeEnum& D);
Dtk_ErrorStatus Dtk_DumpXml_Drawing(const Dtk_DrawingPtr&);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_Text(FILE* F,const Dtk_Text& T);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_OLEObjectPtr( FILE* F, const Dtk_OLEObjectPtr& O );
 
//Geom/Topo///////////////////////////////////////////////////////////////
void Dtk_DumpXml_Body(FILE *inDump, const Dtk_BodyPtr &inBody);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_BodyPtr(FILE* F,const Dtk_BodyPtr& inBody);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_PlaneSurfacePtr(FILE* F, const Dtk_PlaneSurfacePtr &inSurf);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_CurvePtr(FILE* F, const Dtk_CurvePtr &inCurve);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_MeshPtr( FILE* F, const Dtk_MeshPtr& inMesh );
 
//Utils///////////////////////////////////////////////////////////////////
enum XML_StringType
{
     XMLElement = 0,
     XMLAttribute,
     XMLGenericString
};
Dtk_string Dtk_DumpXml_FormatDtk_string( const Dtk_string& inString, const XML_StringType inXmlStringType = XMLGenericString );
 
template< typename ValueType >
Dtk_ErrorStatus Dtk_DumpXml_Value( FILE* inFile, const Dtk_string& inLabel, const ValueType& inValue )
{
     //we check if the label is present - label overload -
     Dtk_string Title = ( inLabel.len() > 0 ) ? Dtk_DumpXml_FormatDtk_string( inLabel, XMLElement ) : L"Value";
     std::wstringstream sstream; sstream << inValue;
     Dtk_string Value = ( sstream.str().length() > 0 ) ? Dtk_DumpXml_FormatDtk_string( sstream.str().c_str(), XMLGenericString ) : L"Undefined.";
 
     const char *titleStr = Title.c_str();
     fprintf( inFile, "<%s>%s</%s>\n",
                titleStr,
                Value.c_str(),
                titleStr );
 
     return dtkNoError;
}
Dtk_ErrorStatus Dtk_DumpXml_Value( FILE* inFile, const Dtk_string& inLabel, const Dtk_Double64& inValue, const char * inFormat = "%lf" );
Dtk_ErrorStatus Dtk_DumpXml_Value( FILE* inFile, const Dtk_string& inLabel, const Dtk_bool& inValue );
Dtk_ErrorStatus Dtk_DumpXml_Value( FILE* inFile, const Dtk_string& inLabel, const Dtk_Int64& inValue );
Dtk_ErrorStatus Dtk_DumpXml_Value( FILE* inFile, const Dtk_string& inLabel, const Dtk_UInt64& inValue );
Dtk_ErrorStatus Dtk_DumpXml_Value( FILE* inFile, const Dtk_string& inLabel, const Dtk_string& inValue );
Dtk_ErrorStatus Dtk_DumpXml_Value( FILE* inFile, const Dtk_string& inLabel, const char* inFormat, ... );
Dtk_ErrorStatus Dtk_DumpXml_Dtk_pnt(FILE* F,const Dtk_pnt& P,const char* b = "Pnt");
Dtk_ErrorStatus Dtk_DumpXml_Dtk_dir(FILE* F,const Dtk_dir& D,const char* b = "Dir");
Dtk_ErrorStatus Dtk_DumpXml_Dtk_transfo(FILE* F,const Dtk_transfo& V);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_bool(FILE* F,const Dtk_bool& B);
Dtk_ErrorStatus Dtk_DumpXml_Init(const Dtk_string &xml_file);
Dtk_ErrorStatus Dtk_DumpXml_End( FILE * F );
Dtk_ErrorStatus Dtk_DumpXml_End();
FILE * Dtk_DumpXml_GetFile();
Dtk_ErrorStatus Dtk_DumpXml_Dtk_info(FILE* F,const Dtk_InfoPtr& I);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_MainDocPtr( FILE * F, const Dtk_MainDocPtr& inObject);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_NodePtr( FILE * F, const Dtk_NodePtr& inObject);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_ComponentPtr( FILE * F, const Dtk_ComponentPtr& inObject);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_MetadataPtr( FILE * F, const Dtk_MetaDataPtr& inObject);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_MetadataGroupPtr(FILE * F, const Dtk_MetaDataGroupPtr& inObject);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_ComponentPtr_Init( FILE * F, const Dtk_ComponentPtr& inObject); 
Dtk_ErrorStatus Dtk_DumpXml_Dtk_ComponentPtr_End( FILE * F); 
Dtk_ErrorStatus Dtk_DumpXml_Dtk_NodePtr_Init( FILE * F, const Dtk_NodePtr& inObject); 
Dtk_ErrorStatus Dtk_DumpXml_Dtk_NodePtr_End( FILE * F);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_NodeConnector (FILE* inFile,const Dtk_NodeConnectorPtr & inNodeConnector);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_SelectionDataSet (FILE* F, const Dtk_GlobalDataSetPtr & ptrGlobalDataSet); 
Dtk_ErrorStatus Dtk_DumpXml_Dtk_FdtDataSet (FILE* F,const Dtk_ComponentPtr & inObject);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_LayerInfosSetPtr(FILE*F, const Dtk_LayerInfosSetPtr& inVal);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_ColorInfosSetPtr(FILE*F, const Dtk_ColorInfosSetPtr& inVal);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_AxisSystemPtr( FILE*F, const Dtk_AxisSystemPtr& inVal );
 
Dtk_ErrorStatus Dtk_Init_Dump_Files (const Dtk_string& inDumpFileName, Dtk_bool dumpFeatures = 0); 
Dtk_ErrorStatus Dtk_End_Dump_Files (const Dtk_string& inComponentFullName); 
 
 
FILE * Dtk_DumpXml_GetParametersDumpFile();
FILE * Dtk_DumpXml_GetFeaturesDumpFile();
 
//Kinematics///////////////////////////////////////////////////////////////////
Dtk_ErrorStatus Dtk_DumpXml_Dtk_KinematicsPtr (FILE * inFile, const Dtk_KinematicPtr & inKinematic);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_KinematicsMechanism(FILE * inFile, const Dtk_KinMechanismPtr &inKinMechanism );
Dtk_ErrorStatus Dtk_DumpXml_Dtk_KinematicsProduct (FILE * inFile, const Dtk_KinProductPtr &inKinProduct, int & inKinProductIndex);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_KinematicsFixPart (FILE * inFile, const Dtk_KinFixPartPtr &inFixPart);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_KinematicsCommand (FILE * inFile, const Dtk_KinCommandPtr &inCommand, Dtk_bool simplified);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_KinematicsJoint (FILE * inFile, const Dtk_KinJointPtr &inJoint, Dtk_bool simplified);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_KinematicsConstraint (FILE * inFile, const Dtk_KinConstraintPtr &inConstraint, Dtk_bool simplified);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_KinematicsLaw (FILE * inFile, const Dtk_KinLawPtr& inLaw);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_KinematicsFormula (FILE * inFile, const Dtk_KinFormulaPtr & inFormula);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_KinematicsCurve(FILE * inFile, const Dtk_KinCurvePtr &inCurve);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_KinematicsSpeedAcceleration (FILE * inFile, const Dtk_KinSpeedAccelerationPtr & inSpeedAcceleration);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_KinematicsParameter (FILE * inFile, const Dtk_KinParameterPtr &inParameter, Dtk_bool simplified = DTK_FALSE);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_KinematicsNamedValue (FILE * inFile, const Dtk_KinNamedValuePtr& inNamedValue);
 
Dtk_ErrorStatus Dtk_DumpXml_RenderInfosTable(FILE* F);
Dtk_ErrorStatus Dtk_DumpXml_PhysicalMaterialInfosTable(FILE* F);
Dtk_ErrorStatus Dtk_DumpXml_LineTypeDefinitionTable(FILE* F);
 
Dtk_ErrorStatus Dtk_DumpXml_Dtk_NodeConnector (FILE* inFile,const Dtk_NodeConnectorPtr & inNodeConnector);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_GraphicalDataPtr(FILE *F, const Dtk_GraphicalDataPtr& inVal);
Dtk_ErrorStatus Dtk_DumpXml_Dtk_StreamPtr(FILE *F, const Dtk_StreamPtr& inVal);
 
 
#ifdef __DTK_SAMPLE_PROJECT__
} //namespace Dtk_DumpXMLNamespace
#endif
 
#endif