SPAIDocumentAssemblyInfo Class Reference

The SPAIDocumentAssemblyInfo class. More...

#include <SPAIDocumentAssemblyInfo.h>

Inheritance diagram for SPAIDocumentAssemblyInfo:

[legend]

Collaboration diagram for SPAIDocumentAssemblyInfo:

[legend]

List of all members.

Public Member Functions
void *	GetData () const
	For Spatial Corp.
virtual int	GetModelsCount ()
	Returns the number of models in the document.
virtual bool	IsValid () const
SPAIDocumentAssemblyInfo &	operator= (const SPAIDocumentAssemblyInfo &iInfo)
	Equal operator.
virtual SPAIResult	SaveAs (SPAIFile &iFile) const
	Saves the assembly information in an XML-EBOM file.
virtual SPAIResult	SelectModel (int iModel)
	Some specific documents like CATIAV4 exp files may contain more than 1 model.
void	SetData (void *ipData)
	For Spatial Corp.
	SPAIDocumentAssemblyInfo (const SPAIDocument &iDocument)
	Constructor.
virtual	~SPAIDocumentAssemblyInfo ()
	Destructor.
Protected Member Functions
int	Ref ()
int	Unref ()
Protected Attributes
SPAIObjectType	_type

---

Detailed Description

The SPAIDocumentAssemblyInfo class.

The SPAIDocumentAssemblyInfo class give information about documents containing assembly information. SPAIDocumentAssemblyInfo can generate an XML-EBOM file describing the product structure of the assembly.

---

Constructor & Destructor Documentation

SPAIDocumentAssemblyInfo::SPAIDocumentAssemblyInfo

(

const SPAIDocument &

iDocument

)

Constructor.

Parameters:

iDocument,:

the accessed document for which assembly information will be retrieved

virtual SPAIDocumentAssemblyInfo::~SPAIDocumentAssemblyInfo

(

)

[virtual]

Destructor.

---

Member Function Documentation

void* SPAIObject::GetData

(

)

const [inherited]

For Spatial Corp.

internal use only.

virtual int SPAIDocumentInfo::GetModelsCount

(

)

[virtual, inherited]

Returns the number of models in the document.

For most documents this method will return 1. Some specific documents like CATIAV4 exp files may contain more than 1 model.

virtual bool SPAIObject::IsValid

(

)

const [virtual, inherited]

Returns:

true if this object was correctly initialized ; false otherwise.

SPAIDocumentAssemblyInfo& SPAIDocumentAssemblyInfo::operator=

(

const SPAIDocumentAssemblyInfo &

iInfo

)

Equal operator.

int SPAIObject::Ref

(

)

[protected, inherited]

virtual SPAIResult SPAIDocumentAssemblyInfo::SaveAs

(

SPAIFile &

iFile

)

const [virtual]

Saves the assembly information in an XML-EBOM file.

Parameters:

iFile

indicates where the five should be saved.

virtual SPAIResult SPAIDocumentInfo::SelectModel

(

int

iModel

)

[virtual, inherited]

Some specific documents like CATIAV4 exp files may contain more than 1 model.

Selects the model for which information will be queried.

Parameters:

iModel

the model index from 0 included to model count excluded.

void SPAIObject::SetData

(

void *

ipData

)

[inherited]

For Spatial Corp.

internal use only.

int SPAIObject::Unref

(

)

[protected, inherited]

---

Member Data Documentation

SPAIObjectType SPAIObject::_type [protected, inherited]