How To Use Solidworks Writer APIs for Solidworks writing of part or assembly

Table Of Contents:

• Overview
• How to create a Part file (sldprt) step-by-step.
• How to create a Assembly file (sldasm) step-by-step.
• Full Sample.

Overview

The Solidworks Writer APIs support the version 2006 , you can create Part file (sldprt) or Assembly file (sldasm). Add the metadata for each file and set the unit DTK_UNIT_MM or DTK_UNIT_INCH of the file .

All functions are used from the namespace solidworksw .

So you need to initialize the writer as :

Dtk_ErrorStatus solidworksw::InitWriter(const Dtk_string& inLogFile,Licence_dtk inLicFct ,solidworksw::language inLanguage=solidworksw::english);

and delete the writer as :

Dtk_ErrorStatus solidworksw::EndWriter();

How to create a Part file (sldprt) step-by-step.

- You initialize part with its name , the metadata list and the unit , by default it is DTK_UNIT_MM  

Dtk_string inFilename = "../SampleFiles/dtk/essai.sldprt";
DtkErrorStatus dtkerror=dtkNoError;
solidworksw::FileDescription FileDescription;
dtkerror = solidworksw::OpenPart(inFilename,FileDescription,DTK_UNIT_MM);

- You add all bodies by Dtk_Body or a parasolid file (only if you use PSKERNEL)

    DtkErrorStatus dtkerror=dtkNoError;
    Dtk_Body MyCube ;
    dtkerror = solidworksw::AddEntity(Dtk_EntityPtr::DtkDynamicCast(MyCube));
    dtkerror = solidworksw::AddEntity(Dtk_EntityPtr::DtkDynamicCast(MyCube));
    
    Dtk_mesh MyMesh ;
    dtkerror = solidworksw::AddEntity(Dtk_EntityPtr::DtkDynamicCast(MyMesh));
 
     //add curves
     Dtk_Body body_curve = sampleWriter::CreateCurves();
     dtkerror = solidworksw::AddEntity( Dtk_EntityPtr::DtkDynamicCast( body_curve ) );
 
     //add point
     Dtk_Body body_point = sampleWriter::CreatePoint();
     dtkerror = solidworksw::AddEntity( Dtk_EntityPtr::DtkDynamicCast( body_point ) );
 
 
     //add plan
     Dtk_Body body_plan = sampleWriter::CreatePlane();
     dtkerror = solidworksw::AddEntity( Dtk_EntityPtr::DtkDynamicCast( body_plan ) );
 
     //add axis system
     Dtk_AxisSystem myaxissystem = sampleWriter::CreateAxisSystem();
     dtkerror = solidworksw::AddEntity( Dtk_EntityPtr::DtkDynamicCast( myaxissystem ) );
 
     //add fdt
     Dtk_Fdt myfdt_dim = CreateFdtDimAssy();
     dtkerror = solidworksw::AddEntity( Dtk_EntityPtr::DtkDynamicCast( myfdt_dim ) );
     Dtk_Fdt myfdt_datum = CreateFdtDatum();
     dtkerror = solidworksw::AddEntity( Dtk_EntityPtr::DtkDynamicCast( myfdt_datum ) );
 
     //add axis
     Dtk_Body myaxis = sampleWriter::CreateAxis();
     dtkerror = solidworksw::AddEntity( Dtk_EntityPtr::DtkDynamicCast( myaxis ) );
 
 
     //add esquisse3d
     Dtk_Body esquisse3d = sampleWriter::CreateEsquisse3D();
     dtkerror = solidworksw::AddEntity( Dtk_EntityPtr::DtkDynamicCast( esquisse3d ) );
 
     //add esquisse2d
     Dtk_Body esquisse2d = sampleWriter::CreateEsquisse2D();
     dtkerror = solidworksw::AddEntity( Dtk_EntityPtr::DtkDynamicCast( esquisse2d ) );
 
     Dtk_MetaData metadata0 = Dtk_MetaData::CreateMetaDataWithUnits( Dtk_MetaData::TypeProperty, L"Title0 ", L"Value0", L"myunit0" );
     Dtk_MetaData metadata1 = Dtk_MetaData::CreateMetaDataWithUnits( Dtk_MetaData::TypeProperty, L"Title1 ", L"Value1", L"myunit1" );
     dtkerror = solidworksw::AddMetaData( metadata0 );
     dtkerror = solidworksw::AddMetaData( metadata1 );
 
 
    .....    
#ifdef PSKERNEL_USER        
    Dtk_string ParasolidFile = L"../SampleFiles/dtk/Part5.x_t";
    dtkerror = solidworksw::AddParasolidFile(ParasolidFile);
    dtkerror = solidworksw::AddParasolidFile(ParasolidFile);
#endif    
    ....   

- You finalize the part 

DtkErrorStatus dtkerror=dtkNoError;
dtkerror = solidworksw::ClosePart();

How to create a Assembly file (sldasm) step-by-step.

- You initialize assembly with its name , the metadata list and the unit , by default it is DTK_UNIT_MM  

Dtk_string inFilename = "../SampleFiles/dtk/essai.sldasm";
DtkErrorStatus dtkerror=dtkNoError;
solidworksw::FileDescription FileDescription;
dtkerror = solidworksw::OpenAssembly(inFilename,FileDescription,DTK_UNIT_MM);

- You add all instances with full path name , instance name and position

Dtk_string disk_name = "../SampleFiles/dtk/child.sldprt";
 
Dtk_string instance_name = L"MyPart1";
Dtk_transfo position = Dtk_transfo(Dtk_dir(1,0,0),Dtk_dir(0,1,0),Dtk_dir(0,0,1),Dtk_pnt(0,0,0));
 
solidworksw::Instance instance1(disk_name,instance_name,position);
dtkerror = solidworksw::AddInstanceComponent(instance1);
 
disk_name = "../SampleFiles/dtk/child.sldasm";
instance_name = L"MyAssembly2";
position.setOrigin(Dtk_pnt(100,150,0));
solidworksw::Instance instance2(disk_name,instance_name,position);
dtkerror = solidworksw::AddInstanceComponent(instance2);
 
 
//you can add the color and status hidden to the instance
/*//instance color
instance_name = L"MyColorPart2";
position.setOrigin(Dtk_pnt(200,250,0));
solidworksw::Instance instance3(disk_name,instance_name,position,Dtk_RGB(255,0,0,255));
dtkerror = solidworksw::AddInstanceComponent(instance3);
 
//instance visibility
instance_name = L"MyInvisiblePart2";
position.setOrigin(Dtk_pnt(300,350,0));
solidworksw::Instance instance4(disk_name,instance_name,position,Dtk_RGB(-1,-1,-1,-1),DTK_TRUE);
dtkerror = solidworksw::AddInstanceComponent(instance4);
 
//instance color + visibility
instance_name = L"MyColorInvisiblePart2";
position.setOrigin(Dtk_pnt(400,450,0));
solidworksw::Instance instance5(disk_name,instance_name,position,Dtk_RGB(0,255,0,255),DTK_TRUE);
dtkerror = solidworksw::AddInstanceComponent(instance5);*/
 
....

- You finalize the assembly 

DtkErrorStatus dtkerror=dtkNoError;
dtkerror = solidworksw::CloseAssembly();

Full Sample.

//standard header - needed for printf -
#include <stdio.h>
 
//DATAKIT headers needed
#include "datakit.h"
#include "testcreatecube.hpp"
#include "testcreatemesh.hpp"
 
extern Dtk_Fdt CreateFdtDimAssy();
extern Dtk_Fdt  CreateFdtDatum();
 
//start_of_mainswwrite
//This sample show you how to add a body into solidworks part file and create an assembly.
#include "util/utilwriter.h"
#include "swwrite/solidworksw.hpp"
 
 
#ifdef PSKERNEL_USER
void StartParasolid();
void StopParasolid();
#endif
 
 
void
    AddColortoFace(const Dtk_BodyPtr& inBody)
{
    Dtk_Int32 cpt=1;
    //add color to face
    Dtk_Int32 i,sizei = (Dtk_Int32)inBody->GetNumTopologicalEntities(DTK_TYPE_UNKNOWN);
    for (i=0;i<sizei;i++)
    {
        Dtk_TopologicalEntity topo = inBody->GetPtr((Dtk_ID)i);
        if (topo.IsNotNULL())
        {
            Dtk_Face face = Dtk_FacePtr::DtkDynamicCast(topo);
            if (face.IsNotNULL())
            {
                Dtk_Info info = face->get_info();
                if (info.IsNULL())
                {
                    face->info() = Dtk_Info::create();
                    info = face->get_info();
                }
                info->SetColor(Dtk_RGB((cpt*42),192,192,255));
                cpt++;
 
                Dtk_string face_name = inBody->get_info()->GetName() + L"Face_";
                face_name.add_int(i);
                info->SetName(face_name);
            }
        }
    }
}
 
void
    create_part(const Dtk_string& inFilename , const Dtk_string& inParasolidFile)
{
    DtkErrorStatus dtkerror=dtkNoError;
 
    Dtk_tab<Dtk_MetaDataPtr> ArrayMetadata;
    Dtk_MetaData metadata ;
 
    metadata = Dtk_MetaData::CreateMetaData(Dtk_MetaData::TypeProperty,L"Title",L"Value");
    ArrayMetadata.push_back(metadata);
 
 
    solidworksw::FileDescription FileDescription(ArrayMetadata);
    dtkerror = solidworksw::OpenPart(inFilename,FileDescription,DTK_UNIT_MM);
 
 
    Dtk_Body MyCube1 = sampleWriter::CreateCube();
    MyCube1->info() = Dtk_Info::create();
    MyCube1->get_info()->SetName(L"Cube1");    
    AddColortoFace(MyCube1);
    dtkerror = solidworksw::AddEntity(Dtk_EntityPtr::DtkDynamicCast(MyCube1));
 
 
    Dtk_Body MyCube2 = sampleWriter::CreateCube();
    MyCube2->info() = Dtk_Info::create();
    MyCube2->get_info()->SetName(L"Cube2");
    AddColortoFace(MyCube2);
 
    Dtk_transfo transfo ;
    transfo.setOrigin(200,0,0);
    MyCube2->Transform(transfo);
 
    dtkerror = solidworksw::AddEntity(Dtk_EntityPtr::DtkDynamicCast(MyCube2));
 
    //only with pskernel 
    dtkerror = solidworksw::AddParasolidFile(inParasolidFile);
    //without pskernel you will get an error dtkErrorTypeNotsupported
    
    // Cylinder Sample
     Dtk_mesh CylinderMesh = sampleWriter::CreateMeshCylinder( 30 );
     dtkerror = solidworksw::AddEntity( Dtk_EntityPtr::DtkDynamicCast( CylinderMesh ) );
 
     //add curves
     Dtk_Body body_curve = sampleWriter::CreateCurves();
     dtkerror = solidworksw::AddEntity( Dtk_EntityPtr::DtkDynamicCast( body_curve ) );
 
     //add point
     Dtk_Body body_point = sampleWriter::CreatePoint();
     dtkerror = solidworksw::AddEntity( Dtk_EntityPtr::DtkDynamicCast( body_point ) );
 
 
     //add plan
     Dtk_Body body_plan = sampleWriter::CreatePlane();
     dtkerror = solidworksw::AddEntity( Dtk_EntityPtr::DtkDynamicCast( body_plan ) );
 
     //add axis system
     Dtk_AxisSystem myaxissystem = sampleWriter::CreateAxisSystem();
     dtkerror = solidworksw::AddEntity( Dtk_EntityPtr::DtkDynamicCast( myaxissystem ) );
 
     //add fdt
     Dtk_Fdt myfdt_dim = CreateFdtDimAssy();
     dtkerror = solidworksw::AddEntity( Dtk_EntityPtr::DtkDynamicCast( myfdt_dim ) );
     Dtk_Fdt myfdt_datum = CreateFdtDatum();
     dtkerror = solidworksw::AddEntity( Dtk_EntityPtr::DtkDynamicCast( myfdt_datum ) );
 
     //add axis
     Dtk_Body myaxis = sampleWriter::CreateAxis();
     dtkerror = solidworksw::AddEntity( Dtk_EntityPtr::DtkDynamicCast( myaxis ) );
 
 
    dtkerror = solidworksw::ClosePart();
}
 
 
 
void
    create_assembly(const Dtk_string& inFilename,const Dtk_string& inFilenamePart)
{
    DtkErrorStatus dtkerror=dtkNoError;
 
 
    Dtk_tab<Dtk_MetaDataPtr> ArrayMetadata;
    Dtk_MetaData metadata ;
 
    metadata = Dtk_MetaData::CreateMetaData(Dtk_MetaData::TypeProperty,L"Title",L"Value");
    ArrayMetadata.push_back(metadata);
 
 
 
    solidworksw::FileDescription FileDescription(ArrayMetadata);
    dtkerror = solidworksw::OpenAssembly(inFilename,FileDescription,DTK_UNIT_MM);
 
    Dtk_string disk_name = inFilenamePart;
 
 
    Dtk_string instance_name = L"MyPart1";
    Dtk_transfo position = Dtk_transfo(Dtk_dir(1,0,0),Dtk_dir(0,1,0),Dtk_dir(0,0,1),Dtk_pnt(0,0,0));
 
    solidworksw::Instance instance1(disk_name,instance_name,position);
    dtkerror = solidworksw::AddInstanceComponent(instance1);
 
 
    instance_name = L"MyPart2";
    position.setOrigin(Dtk_pnt(100,150,0));
    solidworksw::Instance instance2(disk_name,instance_name,position);
    dtkerror = solidworksw::AddInstanceComponent(instance2);
 
    //you can add the color and status hidden to the instance
    /*//instance color
    instance_name = L"MyColorPart2";
    position.setOrigin(Dtk_pnt(200,250,0));
    solidworksw::Instance instance3(disk_name,instance_name,position,Dtk_RGB(255,0,0,255));
    dtkerror = solidworksw::AddInstanceComponent(instance3);
 
    //instance visibility
    instance_name = L"MyInvisiblePart2";
    position.setOrigin(Dtk_pnt(300,350,0));
    solidworksw::Instance instance4(disk_name,instance_name,position,Dtk_RGB(-1,-1,-1,-1),DTK_TRUE);
    dtkerror = solidworksw::AddInstanceComponent(instance4);
 
    //instance color + visibility
    instance_name = L"MyColorInvisiblePart2";
    position.setOrigin(Dtk_pnt(400,450,0));
    solidworksw::Instance instance5(disk_name,instance_name,position,Dtk_RGB(0,255,0,255),DTK_TRUE);
    dtkerror = solidworksw::AddInstanceComponent(instance5);*/
 
    dtkerror = solidworksw::CloseAssembly();
}
 
int main(int argc, char* argv[])
{
    {
        //remove old file
        Dtk_string temp ;
        temp = L"../../SampleFiles/dtk/my_test_part.sldprt";
        temp.unlink();
        temp = L"../../SampleFiles/dtk/my_test_part2.sldprt";
        temp.unlink();
        temp = L"../../SampleFiles/dtk/my_test_assembly.sldasm";
        temp.unlink();
        temp = L"../../SampleFiles/dtk/logwrite.txt";
        temp.unlink();
    }
 
    Dtk_ErrorStatus dtkerror;   
 
    Dtk_string StrSchemaPath = "../bin/Schema/";
 
    _putenv("FLEXLM_BATCH=0");
#ifdef _X64
    _wchdir(L"../../bin_x64");
    StrSchemaPath = "../bin_x64/Schema/";
#else
    _wchdir(L"../../bin");
    StrSchemaPath = "../bin/Schema/";
#endif
 
#ifdef PSKERNEL_USER
    //First if you haven't done yet, start the parasolid session
    StartParasolid();
    //And informs that the session is started
    solidworksw::SetIsAlreadyStart(-1);
 
    //Set the schema path
    wchar_t *schPath;
    schPath = (wchar_t*)malloc(sizeof(wchar_t) * (StrSchemaPath.len() + 10));
    swprintf(schPath, 255, L"P_SCHEMA=%s", StrSchemaPath.w_str());
    _wputenv(schPath);
 
    free(schPath);
    schPath=NULL;
#endif
 
    Dtk_string workingdir= L"../SampleFiles/dtk/";
 
    //Then You have to Start DATAKIT API with a temporary directory
    Dtk_ErrorStatus errorStatus = dtkNoError; 
    Dtk_API * MyAPI = Dtk_API::StartAPI(workingdir, errorStatus);
    if(MyAPI == NULL)
    {
        printf("Can't Start DATAKIT API %d\n",errorStatus);
        return dtkErrorAPINotStarted;
    }        
 
 
    MyAPI->SetSchemaDir(StrSchemaPath);
 
    Dtk_string logwrite=MyAPI->GetWorkingDir() + L"logwrite.txt";
    dtkerror = solidworksw::InitWriter(logwrite,NULL,solidworksw::english);
 
 
    Dtk_string xmtfile = L"../SampleFiles/xmt/CS_WHEEL_CAP.X_T";
 
 
    //how to create part file
    Dtk_string FilenamePart = L"../SampleFiles/dtk/my_test_part.sldprt";
    create_part(FilenamePart,xmtfile);
 
 
    FilenamePart = L"../SampleFiles/dtk/my_test_part2.sldprt";
    create_part(FilenamePart,xmtfile);
 
 
    //how to create assembly file
    Dtk_string FilenameAssm = L"../SampleFiles/dtk/my_test_assembly.sldasm";
    create_assembly(FilenameAssm,FilenamePart);
 
    dtkerror = solidworksw::EndWriter();
 
#ifdef PSKERNEL_USER
    //Stop the parasolid session
    solidworksw::SetIsAlreadyStart(-2);
    StopParasolid();
#endif
    Dtk_API::StopAPI(MyAPI);   
 
    return 0;
}
 
 
//end_of_mainswwrite