solidworksw::FileDescription Class Reference

This class provides several informations about a Solidworks File.
It can be used with solidworksw::OpenPart and solidworksw::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 ()
	Base constructor. More...
	FileDescription (const Dtk_tab< Dtk_MetaDataPtr > &inArrayProperties)
	Base 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 solidworksw::OpenPart and solidworksw::OpenAssembly functions to specify file properties.

//...
soldiworksw::FileDescription Desc;
Dtk_ErrorStatus dtkerror;
dtkerror= solidworksw::OpenPart( inOutputFile, Desc);
//...

Constructor & Destructor Documentation

FileDescription() [1/2]

solidworksw::FileDescription::FileDescription

(

)

Base constructor.

{}

~FileDescription()

solidworksw::FileDescription::~FileDescription

(

)

Destructor.

{}

FileDescription() [2/2]

solidworksw::FileDescription::FileDescription

(

const Dtk_tab< Dtk_MetaDataPtr > &

inArrayProperties

)

Base constructor.

:_AdditionalProperties ( inArrayProperties){};

Member Function Documentation

AddMetadata()

void solidworksw::FileDescription::AddMetadata

(

Dtk_MetaDataPtr &

inMetadata

)

Add Metadata - read only -.

Clear()

void solidworksw::FileDescription::Clear

(

)

Clear Array - read only -.

{return _AdditionalProperties.clear();}

GetAdditionalProperties()

const Dtk_tab< Dtk_MetaDataPtr >& solidworksw::FileDescription::GetAdditionalProperties

(

)

const

Get Metadata Array - read only -.

{return _AdditionalProperties;}

Field Documentation

_AdditionalProperties

Dtk_tab< Dtk_MetaDataPtr > solidworksw::FileDescription::_AdditionalProperties

protected