DATAKIT API  V2025.1
solidworksw.hpp
Go to the documentation of this file.
1 #ifndef __DTK_SOLIDWORKSW_H__
2 #define __DTK_SOLIDWORKSW_H__
3 // solidworksw.h //
6 
7 
8 
10 namespace solidworksw
11 {
12 
13  //language for writing part and assembly
14  enum language
15  {
16  french=0,
19  deutch=3,
20  chinese=4
21  };
22 
23 
24 
36  {
37  public:
38 
39  protected:
40 
42 
43  public:
44 
47 
50 
52  FileDescription( const Dtk_tab< Dtk_MetaDataPtr >& inArrayProperties ) :_AdditionalProperties ( inArrayProperties){};
53 
56 
58  void AddMetadata(Dtk_MetaDataPtr& inMetadata);// {if (inMetadata.IsNotNULL()) {_AdditionalProperties.push_back(inMetadata);}}
59 
61  void Clear(){return _AdditionalProperties.clear();}
62 
63  };
64 
65 
66 
67 
78  class Instance
79  {
80  public:
81 
82  protected:
83 
86  Dtk_string _ConfigurationName; // configuration index is always 0 because we only write one config per file
91  public:
92 
95  {
96  _Color = Dtk_RGB(-1,-1,-1,-1);
98  }
99 
102 
104  Instance(const Dtk_string& inSolidfileName,const Dtk_string& inInstanceName, const Dtk_transfo& inTransfo,const Dtk_RGB& inColorInstance=Dtk_RGB(-1,-1,-1,-1),const Dtk_Int32& inBlankedStatus=DTK_FALSE,const Dtk_string& inConfigurationName = Dtk_string()):
105  _Name (inSolidfileName),_InstanceName ( inInstanceName),_Matrix (inTransfo),_Color (inColorInstance),_BlankedStatus ( inBlankedStatus), _ConfigurationName( inConfigurationName )
106  {
107 
108  };
109 
110  const Dtk_string& GetName( )
111  {
112  return _Name;
113  };
114 
116  {
117  return _InstanceName;
118  };
119 
121  {
122  return _ConfigurationName;
123  };
124 
126  {
127  return _Matrix;
128  };
129 
130  const Dtk_RGB& GetColor( )
131  {
132  return _Color;
133  };
134 
136  {
137  return _BlankedStatus;
138  };
139 
140  void AddMetadata(const Dtk_tab<Dtk_MetaDataPtr>& inArrayMetadata )
141  {
142  m_ArrayMetadata = inArrayMetadata;
143  };
144 
146  {
147  return m_ArrayMetadata ;
148  };
149  };
150 
155  void SetIsAlreadyStart(const Dtk_Int32&inStop);
156 
164 
169 
173  void OptionStoreBodyColor(Dtk_Int32 inStoreBodyColor);
174 
178  void OptionRemoveComment(Dtk_Int32 inRemoveComment);
179 
187  const Dtk_string &inSolidworksFile,
189  Dtk_Unit inUnit=DTK_UNIT_MM,
190  const Dtk_string& inConfigurationName = Dtk_string());
191 
195  Dtk_ErrorStatus AddParasolidFile(const Dtk_string &inParasolidFile);
196 
197 
201  Dtk_ErrorStatus AddParasolidId(const Dtk_Int32 &inParasolidId);
202 
208 
210 
211 
216 
224  const Dtk_string &inFileName,
226  Dtk_Unit inUnit = DTK_UNIT_MM,
227  const Dtk_string& inConfigurationName = Dtk_string());
228 
233 
234 
238 
239 };
240 
241 
242 
243 
244 #endif
245 
solidworksw::Instance::Instance
Instance(const Dtk_string &inSolidfileName, const Dtk_string &inInstanceName, const Dtk_transfo &inTransfo, const Dtk_RGB &inColorInstance=Dtk_RGB(-1,-1,-1,-1), const Dtk_Int32 &inBlankedStatus=DTK_FALSE, const Dtk_string &inConfigurationName=Dtk_string())
Base constructor.
Definition: solidworksw.hpp:104
solidworksw::Instance::GetName
const Dtk_string & GetName()
Definition: solidworksw.hpp:110
Dtk_transfo
This is the Transformation dedicated class.
Definition: dtk_transfo.hpp:19
solidworksw::InitWriter
Dtk_ErrorStatus InitWriter(const Dtk_string &inLogFile, Licence_dtk inLicFct, solidworksw::language inLanguage=solidworksw::english)
Initialize the Solidworks Writer
solidworksw::OptionRemoveComment
void OptionRemoveComment(Dtk_Int32 inRemoveComment)
option to not store the comment
solidworksw::ClosePart
Dtk_ErrorStatus ClosePart()
Free data allocated by solidworksw::OpenPart
solidworksw::OpenPart
Dtk_ErrorStatus OpenPart(const Dtk_string &inSolidworksFile, const solidworksw::FileDescription &inFileDescription=solidworksw::FileDescription(), Dtk_Unit inUnit=DTK_UNIT_MM, const Dtk_string &inConfigurationName=Dtk_string())
Initialize the part
solidworksw::AddEntity
Dtk_ErrorStatus AddEntity(const Dtk_EntityPtr &inEntity)
Write the entity provided in parameter.
catiav5w::inTransfo
const Dtk_string const Dtk_transfo & inTransfo
Definition: catiav5w.hpp:619
solidworksw::FileDescription::_AdditionalProperties
Dtk_tab< Dtk_MetaDataPtr > _AdditionalProperties
Definition: solidworksw.hpp:41
solidworksw::Instance::_Name
Dtk_string _Name
Definition: solidworksw.hpp:84
Dtk_string
This is a high level string class.
Definition: dtk_string.hpp:58
solidworksw::CloseAssembly
Dtk_ErrorStatus CloseAssembly()
Write effectively the Assembly initialized by solidworksw::OpenAssembly.
solidworksw::Instance::m_ArrayMetadata
Dtk_tab< Dtk_MetaDataPtr > m_ArrayMetadata
Definition: solidworksw.hpp:90
solidworksw::Instance::GetMetadata
const Dtk_tab< Dtk_MetaDataPtr > & GetMetadata()
Definition: solidworksw.hpp:145
DTK_UNIT_MM
@ DTK_UNIT_MM
Definition: util_draw_dtk.hpp:85
DTK_FALSE
#define DTK_FALSE
Definition: define.h:728
solidworksw::Instance::_InstanceName
Dtk_string _InstanceName
Definition: solidworksw.hpp:85
catiav5w::inBlankedStatus
const Dtk_string const Dtk_transfo const Dtk_bool inBlankedStatus
Definition: catiav5w.hpp:620
solidworksw::SetIsAlreadyStart
void SetIsAlreadyStart(const Dtk_Int32 &inStop)
ONLY for PSKERNEL user.
Dtk_Unit
Dtk_Unit
Definition: util_draw_dtk.hpp:82
solidworksw::EndWriter
Dtk_ErrorStatus EndWriter()
Free the Solidworks Writer
solidworksw::Instance::_BlankedStatus
Dtk_Int32 _BlankedStatus
Definition: solidworksw.hpp:89
solidworksw::FileDescription
This class provides several informations about a Solidworks File. It can be used with solidworksw::Op...
Definition: solidworksw.hpp:36
solidworksw::Instance::GetColor
const Dtk_RGB & GetColor()
Definition: solidworksw.hpp:130
solidworksw
Exported APIs for solidworks Write Library.
Definition: solidworksw.hpp:11
solidworksw::Instance::GetInstanceName
const Dtk_string & GetInstanceName()
Definition: solidworksw.hpp:115
solidworksw::french
@ french
Definition: solidworksw.hpp:16
Dtk_Int32
int32_t Dtk_Int32
Definition: define.h:687
solidworksw::FileDescription::AddMetadata
void AddMetadata(Dtk_MetaDataPtr &inMetadata)
Add Metadata - read only -.
solidworksw::chinese
@ chinese
Definition: solidworksw.hpp:20
solidworksw::Instance::GetMatrix
const Dtk_transfo & GetMatrix()
Definition: solidworksw.hpp:125
solidworksw::OptionStoreBodyColor
void OptionStoreBodyColor(Dtk_Int32 inStoreBodyColor)
option to store the body color
solidworksw::english
@ english
Definition: solidworksw.hpp:17
solidworksw::FileDescription::FileDescription
FileDescription()
Base constructor.
Definition: solidworksw.hpp:46
Dtk_ErrorStatus
Dtk_ErrorStatus
Definition: error_dtk.hpp:6
solidworksw::deutch
@ deutch
Definition: solidworksw.hpp:19
solidworksw::Instance::GetConfigurationName
const Dtk_string & GetConfigurationName()
Definition: solidworksw.hpp:120
solidworksw::AddInstanceComponent
Dtk_ErrorStatus AddInstanceComponent(Instance &inInstance)
Add an instance into the Current Assembly (sldasm).
Dtk_SmartPtr
Definition: util_ptr_dtk.hpp:37
solidworksw::Instance::Instance
Instance()
Base constructor.
Definition: solidworksw.hpp:94
catiav5w::inFileDescription
const Dtk_string const catiav5w::FileDescription & inFileDescription
Definition: catiav5w.hpp:457
solidworksw::FileDescription::~FileDescription
~FileDescription()
Destructor.
Definition: solidworksw.hpp:49
solidworksw::language
language
Definition: solidworksw.hpp:15
solidworksw::Instance::_Color
Dtk_RGB _Color
Definition: solidworksw.hpp:88
Dtk_tab
This is a high level array class.
Definition: util_stl_dtk.hpp:85
solidworksw::FileDescription::GetAdditionalProperties
const Dtk_tab< Dtk_MetaDataPtr > & GetAdditionalProperties() const
Get Metadata Array - read only -.
Definition: solidworksw.hpp:55
solidworksw::AddParasolidId
Dtk_ErrorStatus AddParasolidId(const Dtk_Int32 &inParasolidId)
Add parasolid Id body.
solidworksw::AddMetaData
Dtk_ErrorStatus AddMetaData(const Dtk_MetaDataPtr &inEntity)
solidworksw::Instance::GetBlankedStatus
const Dtk_Int32 & GetBlankedStatus()
Definition: solidworksw.hpp:135
solidworksw::Instance::_Matrix
Dtk_transfo _Matrix
Definition: solidworksw.hpp:87
solidworksw::AddParasolidFile
Dtk_ErrorStatus AddParasolidFile(const Dtk_string &inParasolidFile)
Add parasolid file.
solidworksw::FileDescription::Clear
void Clear()
Clear Array - read only -.
Definition: solidworksw.hpp:61
solidworksw::Instance::_ConfigurationName
Dtk_string _ConfigurationName
Definition: solidworksw.hpp:86
catiav5w::inInstanceName
const Dtk_string & inInstanceName
Definition: catiav5w.hpp:618
Dtk_RGB
Definition: dtk_rgb.hpp:7
solidworksw::OpenAssembly
Dtk_ErrorStatus OpenAssembly(const Dtk_string &inFileName, const solidworksw::FileDescription &inFileDescription=solidworksw::FileDescription(), Dtk_Unit inUnit=DTK_UNIT_MM, const Dtk_string &inConfigurationName=Dtk_string())
Initialize a Assembly .
solidworksw::Instance
This class provides Instance about a Solidworks File. It can be used with solidworksw::OpenAssembly f...
Definition: solidworksw.hpp:79
Licence_dtk
char *(* Licence_dtk)(char *)
Definition: str_def.h:71
solidworksw::Instance::~Instance
~Instance()
Destructor.
Definition: solidworksw.hpp:101
solidworksw::Instance::AddMetadata
void AddMetadata(const Dtk_tab< Dtk_MetaDataPtr > &inArrayMetadata)
Definition: solidworksw.hpp:140
solidworksw::italian
@ italian
Definition: solidworksw.hpp:18
solidworksw::FileDescription::FileDescription
FileDescription(const Dtk_tab< Dtk_MetaDataPtr > &inArrayProperties)
Base constructor.
Definition: solidworksw.hpp:52