DATAKIT API  V2025.4
sw::sww::FileDescription Class Reference

This class provides several informations about a Solidworks File.
It can be used with sw::OpenPart and OpenAssembly functions to specify file properties. More...

Public Member Functions

void AddMetadata (Dtk_MetaDataPtr &inMetadata)
 Add Metadata - read only -. More...
 
void Clear ()
 Clear Array - read only -. More...
 
 FileDescription ()
 Default constructor. More...
 
 FileDescription (const Dtk_tab< Dtk_MetaDataPtr > &inArrayProperties)
 Default constructor. More...
 
const Dtk_tab< Dtk_MetaDataPtr > & GetAdditionalProperties () const
 Get Metadata Array - read only -. More...
 
 ~FileDescription ()
 Destructor. More...
 

Protected Attributes

Dtk_tab< Dtk_MetaDataPtr_AdditionalProperties
 

Detailed Description

This class provides several informations about a Solidworks File.
It can be used with sw::OpenPart and OpenAssembly functions to specify file properties.

//...
FileDescription sw::sww::Desc;
Dtk_ErrorStatus dtkerror;
dtkerror= sw::sww::OpenPart( inOutputFile, Desc);
//...

Constructor & Destructor Documentation

◆ FileDescription() [1/2]

sw::sww::FileDescription::FileDescription ( )

Default constructor.

◆ ~FileDescription()

sw::sww::FileDescription::~FileDescription ( )

Destructor.

◆ FileDescription() [2/2]

sw::sww::FileDescription::FileDescription ( const Dtk_tab< Dtk_MetaDataPtr > &  inArrayProperties)

Default constructor.

Member Function Documentation

◆ AddMetadata()

void sw::sww::FileDescription::AddMetadata ( Dtk_MetaDataPtr inMetadata)

Add Metadata - read only -.

◆ Clear()

void sw::sww::FileDescription::Clear ( )

Clear Array - read only -.

◆ GetAdditionalProperties()

const Dtk_tab< Dtk_MetaDataPtr >& sw::sww::FileDescription::GetAdditionalProperties ( ) const

Get Metadata Array - read only -.

Field Documentation

◆ _AdditionalProperties

Dtk_tab< Dtk_MetaDataPtr > sw::sww::FileDescription::_AdditionalProperties
protected
sw::sww::OpenPart
Dtk_ErrorStatus OpenPart(const Dtk_string &inSolidworksFile, const sw::sww::FileDescription &inFileDescription=sw::sww::FileDescription(), Dtk_Unit inUnit=DTK_UNIT_MM, const Dtk_string &inConfigurationName=Dtk_string())
Initialize the part
sw::sww::FileDescription::FileDescription
FileDescription()
Default constructor.
Definition: solidworksw.hpp:52
Dtk_ErrorStatus
Dtk_ErrorStatus
Definition: error_dtk.hpp:6