Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages

exotkAF_Document Class Reference

Describe a document. More...

#include <exotkAF_Document.hxx>

Collaboration diagram for exotkAF_Document:

[legend]List of all members.

Public Methods
void *	operator new (size_t, void *anAddress)
	OCC new. More...
void *	operator new (size_t size)
	OCC new. More...
void	operator delete (void *anAddress)
	OCC delete. More...
Standard_EXPORT	exotkAF_Document ()
	Constructor. More...
virtual Standard_EXPORT	~exotkAF_Document ()
	Destructor. More...
virtual Standard_EXPORT Standard_Boolean	SetActiveView (const Handle_exotkAF_View &aView)
	Set aView* as active.* More...
virtual Standard_EXPORT Handle_exotkAF_View	ActiveView ()
	Return the active view. More...
virtual Standard_EXPORT Handle_exotkTree_Tree	Tree ()
	Return the associated tree. More...
virtual Standard_EXPORT void	SetName (const TCollection_AsciiString &aName)
	Set aName* as document name.* More...
virtual Standard_EXPORT TCollection_AsciiString	Name ()
	Return the name of the document. More...
virtual Standard_EXPORT Standard_Boolean	Init ()
	Initialize the document. Must be called in the applcation when the document is initialized. More...
virtual Standard_EXPORT Handle_exotkAF_View	CreateView (const Aspect_Handle &anHandle)
	Create a new Handle_exotkAF_View using anHandle. More...
virtual Standard_EXPORT Standard_Boolean	AddShape (const TopoDS_Shape &aShapeToAdd, const TCollection_AsciiString &aName)
	Add aShapeToAdd* to the document with the name aName.* More...
virtual Standard_EXPORT Standard_Boolean	OpenFile (const TCollection_AsciiString &aFilename)
	Open aFilename, create a shape from the content this file and add it to the document. More...
virtual Standard_EXPORT Standard_Boolean	RemoveView (const Handle_exotkAF_View &aView)
	Remove aView* from the document.* More...
virtual Standard_EXPORT Standard_Integer	NbViews ()
	Return the number a views associated with this document. More...
virtual Standard_EXPORT void	InitViewIterator ()
	Initialize the view iterator. More...
virtual Standard_EXPORT Standard_Boolean	MoreViewIterator ()
	Returns true if the iterator is not at its end. More...
virtual Standard_EXPORT void	NextViewIterator ()
	Set the iterator to the next document. More...
virtual Standard_EXPORT Handle_exotkAF_View	CurrentViewIterator ()
	Return the view corresponding to the current iterator. More...
virtual Standard_EXPORT Standard_Boolean	SaveFile (const TCollection_AsciiString &aFilename)
	Save this document in aFilename. More...
Standard_EXPORT Handle_exotkAIS_DisplayManager	DisplayManager ()
	Return the display manager. More...
Standard_EXPORT const Handle_Standard_Type &	DynamicType () const
	Type management. More...
Standard_EXPORT Standard_Boolean	IsKind (const Handle_Standard_Type &) const
	Type management. More...
Protected Methods
virtual Standard_EXPORT Standard_Boolean	AddView (const Handle_exotkAF_View &aView)
	Add aView* to the list of known views. Called in exotkAF_Document::CreateView(const Aspect_Handle& anHandle).* More...
Protected Attributes
Handle_exotkAIS_DisplayManager	myDisplayManager
Handle_exotkAF_HSetOfView	myViews
Handle_exotkAF_View	myActiveView
TCollection_AsciiString	myName
Standard_Boolean	myIsInitialized
Handle_exotkTree_Tree	myTree
Handle_TopTools_HSequenceOfShape	myShapes
Friends
Standard_EXPORT friend Handle_Standard_Type &	exotkAF_Document_Type_ ()
	Type management. More...

Detailed Description

Describe a document.

Author:: Stephane Routelous

Definition at line 72 of file exotkAF_Document.hxx.

Constructor & Destructor Documentation

exotkAF_Document::exotkAF_Document ( )

Constructor.

Definition at line 128 of file exotkAF_Document.cxx.
References myIsInitialized, and myViews.

exotkAF_Document::~exotkAF_Document ( ) [virtual]

Destructor.

Definition at line 143 of file exotkAF_Document.cxx.
References myViews.

Member Function Documentation

exotkAF_Document::ActiveView ( ) [virtual]

Return the active view.

Returns:
Handle_exotkAF_View : can be null if not view was set to active

Definition at line 465 of file exotkAF_Document.cxx.
References myActiveView.

exotkAF_Document::AddShape ( const TopoDS_Shape & aShapeToAdd,

const TCollection_AsciiString & aName

) [virtual]

Add aShapeToAdd to the document with the name aName.

Returns:
Standard_Boolean : false if the document cannot be initialized
Parameters:

aShapeToAdd const TopoDS_Shape&

aName const TCollection_AsciiString&

Definition at line 303 of file exotkAF_Document.cxx.
References exotkBRepTree::ComputeTopNode(), Init(), myDisplayManager, myShapes, and myTree.
Referenced by OpenFile().

exotkAF_Document::AddView ( const Handle_exotkAF_View & aView ) [protected, virtual]

Add aView to the list of known views. Called in exotkAF_Document::CreateView(const Aspect_Handle& anHandle).

Returns:
Standard_Boolean
Parameters:

aView const Handle_exotkAF_View&

Definition at line 360 of file exotkAF_Document.cxx.
References myViews.
Referenced by CreateView().

exotkAF_Document::CreateView ( const Aspect_Handle & anHandle ) [virtual]

Create a new Handle_exotkAF_View using anHandle.

Returns:
Handle_exotkAF_View : can be null if the creation failed
Parameters:

anHandle const Aspect_Handle& : the handle of the window used in the view

Definition at line 334 of file exotkAF_Document.cxx.
References AddView(), and myDisplayManager.

exotkAF_Document::CurrentViewIterator ( ) [virtual]

Return the view corresponding to the current iterator.

Returns:
Handle_exotkAF_View

Definition at line 421 of file exotkAF_Document.cxx.

exotkAF_Document::DisplayManager ( )

Return the display manager.

Returns:
Handle_exotkAIS_DisplayManager

Definition at line 156 of file exotkAF_Document.cxx.
References myDisplayManager.

Handle_Standard_Type & exotkAF_Document::DynamicType ( ) const

Type management.

Returns:
const Handle_Standard_Type&

exotkAF_Document::Init ( ) [virtual]

Initialize the document. Must be called in the applcation when the document is initialized.

Returns:
Standard_Boolean

Definition at line 205 of file exotkAF_Document.cxx.
References exotkAF::Application(), myDisplayManager, myIsInitialized, myShapes, myTree, and exotkTrace_Datas::theRoot.
Referenced by AddShape().

exotkAF_Document::InitViewIterator ( ) [virtual]

Initialize the view iterator.

Definition at line 385 of file exotkAF_Document.cxx.
References myViews.

exotkAF_Document::IsKind ( const Handle_Standard_Type & ) const

Type management.

Returns:
Standard_Boolean
Parameters:

const Handle_Standard_Type&

exotkAF_Document::MoreViewIterator ( ) [virtual]

Returns true if the iterator is not at its end.

Returns:
Standard_Boolean

Definition at line 397 of file exotkAF_Document.cxx.

exotkAF_Document::Name ( ) [virtual]

Return the name of the document.

Returns:
TCollection_AsciiString

Definition at line 181 of file exotkAF_Document.cxx.
References myName.

exotkAF_Document::NbViews ( ) [virtual]

Return the number a views associated with this document.

Returns:
Standard_Integer

Definition at line 433 of file exotkAF_Document.cxx.
References myViews.

exotkAF_Document::NextViewIterator ( ) [virtual]

Set the iterator to the next document.

Definition at line 409 of file exotkAF_Document.cxx.

exotkAF_Document::OpenFile ( const TCollection_AsciiString & aFilename ) [virtual]

Open aFilename, create a shape from the content this file and add it to the document.

Returns:
Standard_Boolean : false if something get wrong
Parameters:

aFilename const TCollection_AsciiString&

Definition at line 231 of file exotkAF_Document.cxx.
References AddShape(), exotkTrace::Debug(), exotkTrace::Error(), exotkGUI::HideProgressBox(), exotkDX::LoadShapes(), myName, exotkGUI::SetProgressBoxPosition(), exotkGUI::SetProgressBoxRange(), exotkGUI::SetProgressBoxText(), exotkGUI::SetProgressBoxTitle(), and exotkGUI::ShowProgressBox().

void exotkAF_Document::operator delete ( void * anAddress ) [inline]

OCC delete.

Returns:
inline void
Parameters:

void *anAddress

Definition at line 105 of file exotkAF_Document.hxx.

void * exotkAF_Document::operator new ( size_t size ) [inline]

OCC new.

Returns:
inline void*
Parameters:

size_t size

Definition at line 94 of file exotkAF_Document.hxx.

void * exotkAF_Document::operator new ( size_t ,

void * anAddress

) [inline]

OCC new.

Returns:
inline void*
Parameters:

size_t

void * anAddress

Definition at line 83 of file exotkAF_Document.hxx.

exotkAF_Document::RemoveView ( const Handle_exotkAF_View & aView ) [virtual]

Remove aView from the document.

Returns:
Standard_Boolean : false if the view is not in the set
Parameters:

aView const Handle_exotkAF_View&

Definition at line 373 of file exotkAF_Document.cxx.
References myViews.

exotkAF_Document::SaveFile ( const TCollection_AsciiString & aFilename ) [virtual]

Save this document in aFilename.

Returns:
Standard_Boolean
Parameters:

aFilename const TCollection_AsciiString&

Definition at line 470 of file exotkAF_Document.cxx.
References myShapes, and exotkDX::SaveShapes().

exotkAF_Document::SetActiveView ( const Handle_exotkAF_View & aView ) [virtual]

Set aView as active.

Returns:
Standard_Boolean : false if aView is null or not known in the document ( use AddView before )
Parameters:

aView const Handle_exotkAF_View&

Definition at line 447 of file exotkAF_Document.cxx.
References myActiveView, and myViews.

exotkAF_Document::SetName ( const TCollection_AsciiString & aName ) [virtual]

Set aName as document name.

Parameters:

aName const TCollection_AsciiString&

Definition at line 169 of file exotkAF_Document.cxx.
References myName.

exotkAF_Document::Tree ( ) [virtual]

Return the associated tree.

Returns:
Handle_exotkTree_Tree

Definition at line 194 of file exotkAF_Document.cxx.
References myTree.

Friends And Related Function Documentation

Handle_Standard_Type & exotkAF_Document::exotkAF_Document_Type_ ( ) [friend]

Type management.

Returns:
friend Handle_Standard_Type&

Member Data Documentation

Handle_exotkAF_View exotkAF_Document::myActiveView [protected]

the active view
Definition at line 289 of file exotkAF_Document.hxx.
Referenced by ActiveView(), and SetActiveView().

Handle_exotkAIS_DisplayManager exotkAF_Document::myDisplayManager [protected]

the display manager
Definition at line 283 of file exotkAF_Document.hxx.
Referenced by AddShape(), CreateView(), DisplayManager(), and Init().

Standard_Boolean exotkAF_Document::myIsInitialized [protected]

true if the document is initialized
Definition at line 295 of file exotkAF_Document.hxx.
Referenced by exotkAF_Document(), and Init().

TCollection_AsciiString exotkAF_Document::myName [protected]

the document name
Definition at line 292 of file exotkAF_Document.hxx.
Referenced by Name(), OpenFile(), and SetName().

Handle_TopTools_HSequenceOfShape exotkAF_Document::myShapes [protected]

the shapes
Definition at line 301 of file exotkAF_Document.hxx.
Referenced by AddShape(), Init(), and SaveFile().

Handle_exotkTree_Tree exotkAF_Document::myTree [protected]

the tree associated to the document
Definition at line 298 of file exotkAF_Document.hxx.
Referenced by AddShape(), Init(), and Tree().

Handle_exotkAF_HSetOfView exotkAF_Document::myViews [protected]

the set of views associated to this document
Definition at line 286 of file exotkAF_Document.hxx.
Referenced by AddView(), exotkAF_Document(), InitViewIterator(), NbViews(), RemoveView(), SetActiveView(), and ~exotkAF_Document().

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

Generated on Wed Jan 23 12:18:23 2002 for exotk by

exotkAF_Document Class Reference

Public Methods

Protected Methods

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation