psw.hpp

Go to the documentation of this file.

/**********************************************************
    PSW.HPP : DATAKIT PARASOLID WRITE
***********************************************************/
//! \defgroup ps_write Parasolid Write Functions
//! \brief .
 
 
//! \ingroup ps_write
//! \brief Initialise a file to be written
//! \param [in] inFileOut : Parasolid (x_t or x_b) File to write
//! \param [in] muteMode : no log file used  
//! \param [in] inVersion : vesion to write, default = 100 (= 10.0)
//! \return 0 if OK , -4 if licence checking has failed
DtkErrorStatus  psw_InitFile( const Dtk_string& inFileOut, Dtk_bool muteMode, Dtk_Int32 inVersion = 180 );
DtkErrorStatus  psw_InitFile( Dtk_tab<char>& outParasolidStream, Dtk_bool muteMode, Dtk_Int32 inVersion = 180 );
 
//! \ingroup ps_write
//! \brief Ends the writing of the Parasolid (x_t or x_b) file
//! \param [in] inTabIds : the tab of body/assembly-entry written at level 0  if size > 1, a start list is created
//! \param [in] binForceListOfBody : if true, no assembly created  default = false
//! \return 0 if OK
DtkErrorStatus  psw_EndFile( Dtk_tab<Dtk_ID>& inTabIds, Dtk_bool binForceListOfBody = DTK_FALSE );
 
//! \ingroup ps_write
//! \brief Writes a Body of a 3D part (3D content of a product), of any kind (solid, shell / faces, wireframe / points)
//! \param [in] inBody : the Body to be written
//! \return 0 if done, -1 if body is null or conversion failed
Dtk_ErrorStatus  psw_WriteBody( Dtk_BodyPtr& inBody );
 
//! \ingroup ps_write
//! \brief Writes a Body of a 3D part (3D content of a product), of any kind (solid, shell / faces, wireframe / points)
//! \param [in] inBody : the Body to be written
//! \param [in] writeMode : [0] = one body per closed shell and one body per open shell, [1] = separate all faces, [2] one body per closed shell and only one body for all the open shells (combined values possible)
//! \param [out] outTabIds : the tab of body-entry written
//! \return 0 if done, -1 if body is null or conversion failed
Dtk_ErrorStatus  psw_WriteBody( Dtk_BodyPtr& inBody, Dtk_tab<Dtk_ID>& outTabIds, Dtk_Int32 writeMode = 0 );
 
//! \ingroup ps_write
//! \brief Writes a Mesh of a 3D part
//! \param [in] inMesh : the Mesh to be written
//! \param [in] bExplode : if true 1 body written per face
//! \param [out] outTabIds : the tab of body-entry written
//! \return 0 if done, -1 if body is null or conversion failed
Dtk_ErrorStatus  psw_WriteMesh( Dtk_MeshPtr& inMesh, Dtk_tab<Dtk_ID>& outTabIds, Dtk_bool bExplode = DTK_FALSE );
 
 
//! \ingroup ps_write
//! \brief Writes a list of Bodies of a 3D part (3D content of a product), of any kind (solid, shell / faces, wireframe / points) with sewing or not
//! \param [in] bodies : the list of Bodies to be written
//! \param [in] bSewing : a sewing action of the bodies is performed or not
//! \param [in] tolmin : the start tolerance used for the sewing process
//! \param [in] tolmax : the last tolerance used for the sewing process
//! \param [in] iterationNumber : the number of iteration between start and last tolerance for the sewing process
//! \param [out] outTabIds : the tab of body-entry written
//! \return 0 if done, -1 if body is null or conversion failed
DtkErrorStatus  psw_WriteBody( Dtk_tab<Dtk_ID>& outTabIds, Dtk_tab<Dtk_BodyPtr>& bodies, Dtk_bool bSewing = DTK_TRUE, Dtk_Double64 tolmin = 0.01, Dtk_Double64 tolmax = 0.05, int iterationNumber = 3 );
 
//! \ingroup ps_write
//! \brief Create the entry item of an assembly 
//! \param [out] outAssemblyId : the assembly item - entry  written
//! \return dtkNoError if OK, dtkErrorUserBreak in case of calling sequence error
DtkErrorStatus psw_CreateEmptyAssembly( Dtk_ID& outAssemblyId );
 
//! \ingroup ps_write
//! \brief Create an Instance item of a part referenced by inIdPart 
//! \param [in] inAssemblyId: id of the father assembly's item
//! \param [in] inIdPart: id of the part (body or assembly) referenced
//! \param [in] Matrix:  matrix used to position the instance on the assembly
//! \param [out] outIdInst : the instance item - entry  written
//! \return dtkNoError if OK, dtkErrorUserBreak in case of calling sequence error
DtkErrorStatus psw_CreateInstance( Dtk_ID inAssemblyId, Dtk_ID inIdPart, Dtk_transfoPtr& Matrix, Dtk_ID& outIdInst );
 
//! \ingroup ps_write
//! \brief Create all attribut attached to a component (body, assembly, instance) 
//! \param [in] inIdCompo: id of the component item
//! \param [in] info: attributs defined on the Dtk_InfoPtr object
//! \return dtkNoError if OK, dtkErrorUserBreak in case of calling sequence error
DtkErrorStatus  psw_CreateAttribut( Dtk_ID inIdCompo, Dtk_InfoPtr& info );
 
//! \ingroup ps_write
//! \brief Update name attribute only (body, assembly, instance) 
//! \param [in] inIdCompo: id of the component item
//! \param [in] info: attributes defined on the Dtk_InfoPtr object
//! \return dtkNoError if OK, dtkErrorUserBreak in case of calling sequence error
DtkErrorStatus  psw_UpdateNameAttribut( Dtk_ID inIdCompo, Dtk_InfoPtr& info );
 
//! \ingroup ps_write
//! \brief set name attribute if not defined only (body, assembly, instance) 
//! \param [in] inIdCompo: id of the component item
//! \param [in] info: attributes defined on the Dtk_InfoPtr object
//! \return dtkNoError if OK, dtkErrorUserBreak in case of calling sequence error
DtkErrorStatus  psw_SetNoNamedAttribut( Dtk_ID inIdCompo, Dtk_InfoPtr& info );
 
 
//! \ingroup ps_write
//! \brief link all attributes attached to an assembly 
//! \param [in] inAssemblyId : id of the assembly item
//! \return dtkNoError if OK, dtkErrorUserBreak in case of calling sequence error
DtkErrorStatus  psw_LinkAttribut( Dtk_ID inAssemblyId );
 
//! \ingroup ps_write
//! \brief Create Coordinate System attribute attached to a point body (body with 1 point only) 
//! \param [in] inIdCompo: id of the component item
//! \param [in] transfo: matrix used to define the 3 axis
//! \param [in] bCurrent: define if this axis is current or not
//! \return dtkNoError if OK, dtkErrorUserBreak in case of calling sequence error
DtkErrorStatus  psw_CreateCSysAttribut( Dtk_ID inIdCompo, const Dtk_transfo& transfo, Dtk_bool bCurrent );
 
//! \ingroup ps_write
//! \brief Writes a Body defined by one point only 
//! \param [in] point : the point
//! \param [out] outTabIds : the tab of body-entry written
//! \return 0 if done, -1 if body is null or conversion failed
Dtk_ErrorStatus psw_WritePointBody( const Dtk_AxisSystemPtr& inObject, Dtk_tab<Dtk_ID>& outTabIds );
 
//! \ingroup ps_write
//! \brief set the current reader used on the writer activated 
//! \param [in] readertype : the reader
//! \return 0 if done, -1 if no writer activated
Dtk_ErrorStatus psw_SetReaderType( DtkReaderType readertype );
 
 
 
//! \ingroup ps_write
//! \brief Create all publication attributes attached to a component (body) 
//! \param [in] inIdCompo: id of the component item
//! \param [in] publication: Dtk_string defined the name of publication
//! \return dtkNoError if OK, dtkErrorUserBreak in case of calling sequence error
Dtk_ErrorStatus psw_SetPublicationAttribut( Dtk_ID inIdCompo, const Dtk_string& publication );
 
// How should we write faces ? combined status possible
// 0 No change
// 1 No topology saved, faces unsewed
// 2 all open shell saved in one body
void psw_SetWritingFacesMode( Dtk_Int32 inPreference );
 
// How should we write mesh ? 
// 0 No topology (default value)
// 1 with topology if exist
void psw_SetWritingMeshMode( Dtk_Int32 inPreference );
 
// How should we write nonmanifold topology ? 
// 0 manifold translation (default value)
// 1 conserve nonmanifold if exist
void psw_SetWritingNonmanifoldTopolgyMode( Dtk_Int32 inPreference );
 
// should we write read custom attributes ?  (default TRUE)  available only in case of Keep Kernel Data reading mode
void psw_SetWritingCustomAttributMode( Dtk_bool bWriteCustomAttribut );