solidworksw::Instance Class Reference

This class provides Instance about a Solidworks File.
It can be used with solidworksw::OpenAssembly functions to Add Instance. More...

Public Member Functions
void	AddMetadata (const Dtk_tab< Dtk_MetaDataPtr > &inArrayMetadata)
const Dtk_Int32 &	GetBlankedStatus ()
const Dtk_RGB &	GetColor ()
const Dtk_string &	GetConfigurationName ()
const Dtk_string &	GetInstanceName ()
const Dtk_transfo &	GetMatrix ()
const Dtk_tab< Dtk_MetaDataPtr > &	GetMetadata ()
const Dtk_string &	GetName ()
	Instance ()
	Base constructor. More...
	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. More...
	~Instance ()
	Destructor. More...

Protected Attributes
Dtk_Int32	_BlankedStatus
Dtk_RGB	_Color
Dtk_string	_ConfigurationName
Dtk_string	_InstanceName
Dtk_transfo	_Matrix
Dtk_string	_Name
Dtk_tab< Dtk_MetaDataPtr >	m_ArrayMetadata

Detailed Description

This class provides Instance about a Solidworks File.
It can be used with solidworksw::OpenAssembly functions to Add Instance.

//...
soldiworksw::Instance instance;
Dtk_ErrorStatus dtkerror;
dtkerror = solidworksw::AddInstance( instance);
//...

Constructor & Destructor Documentation

Instance() [1/2]

solidworksw::Instance::Instance

(

)

Base constructor.

        {
            _Color = Dtk_RGB(-1,-1,-1,-1);
            _BlankedStatus=DTK_FALSE;
        }

~Instance()

solidworksw::Instance::~Instance

(

)

Destructor.

{}

Instance() [2/2]

solidworksw::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.

                                                                                                                                                                                                                                                                      :
               _Name (inSolidfileName),_InstanceName ( inInstanceName),_Matrix (inTransfo),_Color (inColorInstance),_BlankedStatus ( inBlankedStatus), _ConfigurationName( inConfigurationName )
        {
            
        };

Member Function Documentation

AddMetadata()

void solidworksw::Instance::AddMetadata

(

const Dtk_tab< Dtk_MetaDataPtr > &

inArrayMetadata

)

          {
               m_ArrayMetadata = inArrayMetadata;
          };

GetBlankedStatus()

const Dtk_Int32& solidworksw::Instance::GetBlankedStatus

(

)

        {
            return _BlankedStatus;
        };

GetColor()

const Dtk_RGB& solidworksw::Instance::GetColor

(

)

        {
            return _Color;
        };

GetConfigurationName()

const Dtk_string& solidworksw::Instance::GetConfigurationName

(

)

          {
               return _ConfigurationName;
          };

GetInstanceName()

const Dtk_string& solidworksw::Instance::GetInstanceName

(

)

        {
            return _InstanceName;
        };

GetMatrix()

const Dtk_transfo& solidworksw::Instance::GetMatrix

(

)

        {
            return _Matrix;
        };

GetMetadata()

const Dtk_tab<Dtk_MetaDataPtr>& solidworksw::Instance::GetMetadata

(

)

          {
               return m_ArrayMetadata ;
          };

GetName()

const Dtk_string& solidworksw::Instance::GetName

(

)

        {
            return _Name;
        };

Field Documentation

_BlankedStatus

Dtk_Int32 solidworksw::Instance::_BlankedStatus

protected

_Color

Dtk_RGB solidworksw::Instance::_Color

protected

_ConfigurationName

Dtk_string solidworksw::Instance::_ConfigurationName

protected

_InstanceName

Dtk_string solidworksw::Instance::_InstanceName

protected

_Matrix

Dtk_transfo solidworksw::Instance::_Matrix

protected

_Name

Dtk_string solidworksw::Instance::_Name

protected

m_ArrayMetadata

Dtk_tab<Dtk_MetaDataPtr> solidworksw::Instance::m_ArrayMetadata

protected