ItModelDocument Class Reference

Interface of document of an assembly model or a part model. More...

#include <conv_model_document.h>

Inheritance diagram for ItModelDocument:

Collaboration diagram for ItModelDocument:

Public Member Functions
virtual bool	IsAssembly () const =0
	Is it an assembly?
virtual bool	IsEmpty () const =0
	Is it neither an assembly nor a part?
virtual void	SetContent (MbItem *)=0
	Prototype of a new interface function - get the placement the model is defined in. More...
virtual MbItem *	GetContent ()=0
	Prototype of a new interface function - get the filling.
virtual ModelAssemblyPtr	CreateAssembly (const c3d::ItemsSPtrVector &componentItems, const c3d::string_t &fileName)=0
	Create a document with a new assembly while importing. More...
virtual ModelPartPtr	CreatePart (const c3d::ItemsSPtrVector &componentItems, const c3d::string_t &fileName)=0
	Create a document with a new part while importing. More...
virtual ModelAssemblyPtr	GetInstanceAssembly ()=0
	Get an assembly for export. More...
virtual ModelPartPtr	GetInstancePart ()=0
	Get the detail for export. More...
virtual bool	FinishImport (IProgressIndicator *indicator)=0
	Complete the import and save the document. More...
virtual map_of_visual_items	GetAnnotationItems (eTextForm) const =0
	Get elements of annotation, corresponding items of geometric model. More...
virtual void	SetAnnotationItems (const map_of_visual_items &)=0
	Set sizes.
virtual void	OpenDocument ()=0
	Open a document.
Public Member Functions inherited from MbRefItem
virtual MbeRefType	RefType () const
	Registration type (for copying, duplication).
refcount_t	GetUseCount () const
	Get count of references (get count of owners of an object).
refcount_t	AddRef () const
	Increase count of references by one.
refcount_t	DecRef () const
	Decrease count of references by one.
refcount_t	Release () const
	Decrease count of references by one and if count of references became zero, then remove itself.

Additional Inherited Members
Protected Member Functions inherited from MbRefItem
	MbRefItem ()
	Constructor without parameters.

Detailed Description

Interface of document of an assembly model or a part model.

Member Function Documentation

SetContent()

virtual void ItModelDocument::SetContent ( MbItem *  )

pure virtual

Prototype of a new interface function - get the placement the model is defined in.

Prototype of a new interface function - set a model to fill.

Implemented in C3dModelDocument.

CreateAssembly()

virtual ModelAssemblyPtr ItModelDocument::CreateAssembly ( const c3d::ItemsSPtrVector &  componentItems, const c3d::string_t &  fileName  )

pure virtual

Create a document with a new assembly while importing.

Increase the reference counter of the resultant document by 1.

Parameters

[in]	fileName	- Assembly name.
[in]	solids	- Solids to add into the assembly.

Returns

Instance of an assembly if the operation succeeded, nullptr - otherwise.

Implemented in C3dModelDocument.

CreatePart()

virtual ModelPartPtr ItModelDocument::CreatePart ( const c3d::ItemsSPtrVector &  componentItems, const c3d::string_t &  fileName  )

pure virtual

Create a document with a new part while importing.

Increase the reference counter of the resultant document by 1.

Parameters

[in]	solids	- Solids to add into a part.
[in]	fileName	- A part name.

Returns

Instance of the part if the operation succeeded, nullptr - otherwise.

Implemented in C3dModelDocument.

GetInstanceAssembly()

virtual ModelAssemblyPtr ItModelDocument::GetInstanceAssembly ( )

pure virtual

Get an assembly for export.

Increase the reference counter of the resultant assembly by 1.

Returns

Instance of an assembly if the operation succeeded, nullptr - otherwise.

Implemented in C3dModelDocument.

GetInstancePart()

virtual ModelPartPtr ItModelDocument::GetInstancePart ( )

pure virtual

Get the detail for export.

Increase the reference counter of the resultant part by 1.

Returns

Instance of the part if the operation succeeded, nullptr - otherwise.

Implemented in C3dModelDocument.

FinishImport()

virtual bool ItModelDocument::FinishImport ( IProgressIndicator *  indicator )

pure virtual

Complete the import and save the document.

Returns

true if the operation succeeded, false - otherwise.

Parameters

[in]

indicator

An object indicating a process progress.

Implemented in C3dModelDocument.

GetAnnotationItems()

virtual map_of_visual_items ItModelDocument::GetAnnotationItems ( eTextForm  ) const

pure virtual

Get elements of annotation, corresponding items of geometric model.

Parameters

[in]

eTextForm

- Text representation form.

Returns

Vector of annotation objects.

Implemented in C3dModelDocument.

---

The documentation for this class was generated from the following file:

• conv_model_document.h