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

exotkAF_Application Class Reference

Application class. It must only be one instance of this application class in an Applcation. The instance is stored in the exotkAF class. More...

#include <exotkAF_Application.hxx>

Collaboration diagram for exotkAF_Application:

[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_Application ()
	Constructor. More...
virtual Standard_EXPORT	~exotkAF_Application ()
	Destructor. More...
virtual Standard_EXPORT Standard_Boolean	SetActiveDocument (const Handle_exotkAF_Document &aDocument)
	Set aDocument* as active document.* More...
virtual Standard_EXPORT Handle_exotkAF_Document	ActiveDocument ()
	Return the active document. More...
virtual Standard_EXPORT Standard_Boolean	AddDocument (const Handle_exotkAF_Document &aDocument)
	Add aDocument* to the set of known documents.* More...
virtual Standard_EXPORT Standard_Boolean	RemoveDocument (const Handle_exotkAF_Document &aDocument)
	Remove aDocuemnt* from the set of known documents.* More...
virtual Standard_EXPORT Standard_Integer	NbDocuments ()
	Return the number of documents. More...
virtual Standard_EXPORT void	InitDocIterator ()
	Initialize the document iterator. More...
virtual Standard_EXPORT Standard_Boolean	MoreDocIterator ()
	Returns true if the iterator is not at its end. More...
virtual Standard_EXPORT void	NextDocIterator ()
	Set the iterator to the next document. More...
virtual Standard_EXPORT Handle_exotkAF_Document	CurrentDocIterator ()
	Get the current document from the iterator. More...
virtual Standard_EXPORT Standard_Boolean	SetOpenCASCADEEnvironmentVariables (const TCollection_AsciiString &aCSFGraphicShr, const TCollection_AsciiString &aCSFUnitsDefinition, const TCollection_AsciiString &aCSFUnitsLexicon, const TCollection_AsciiString &aCSFMDTVFontDirectory, const TCollection_AsciiString &aCSFMDTVTexturesDirectory)
	Set the environment variables needed for OpenCASCADE. More...
virtual Standard_EXPORT Standard_Boolean	SetPluginPath (const TCollection_AsciiString &aPluginPath)
	Set the path where the plugins are located. More...
virtual Standard_EXPORT TCollection_AsciiString	PluginPath ()
	Return the path where the plugins are located. More...
virtual Standard_EXPORT Standard_Boolean	LoadPlugins ()
	Load and dispatch the plugins. More...
Standard_EXPORT const Handle_Standard_Type &	DynamicType () const
	OCC type management. More...
Standard_EXPORT Standard_Boolean	IsKind (const Handle_Standard_Type &) const
	OCC type management. More...
Protected Methods
virtual Standard_EXPORT void	DispatchPlugin (const Handle_exotkPlugin_Plugin &aPlugin)
	Dispatch aPlugin* in the good package.* More...
Private Attributes
Handle_exotkAF_HSetOfDocument	myDocuments
Handle_exotkAF_Document	myActiveDocument
TCollection_AsciiString	myPluginPath
Friends
Standard_EXPORT friend Handle_Standard_Type &	exotkAF_Document_Type_ ()
	OCC type management. More...

Detailed Description

Application class. It must only be one instance of this application class in an Applcation. The instance is stored in the exotkAF class.

Author:: Stephane Routelous

Definition at line 61 of file exotkAF_Application.hxx.

Constructor & Destructor Documentation

exotkAF_Application::exotkAF_Application ( )

Constructor.

Definition at line 109 of file exotkAF_Application.cxx.
References myDocuments.

exotkAF_Application::~exotkAF_Application ( ) [virtual]

Destructor.

Definition at line 122 of file exotkAF_Application.cxx.
References myDocuments, and exotkAF::SetApplication().

Member Function Documentation

exotkAF_Application::ActiveDocument ( ) [virtual]

Return the active document.

Returns:
Handle_exotkAF_Document : can be null if no document is set as active

Definition at line 404 of file exotkAF_Application.cxx.
References myActiveDocument.

exotkAF_Application::AddDocument ( const Handle_exotkAF_Document & aDocument ) [virtual]

Add aDocument to the set of known documents.

Returns:
Standard_Boolean : false if the document already exists
Parameters:

aDocument const Handle_exotkAF_Document&

Definition at line 174 of file exotkAF_Application.cxx.
References myDocuments.

exotkAF_Application::CurrentDocIterator ( ) [virtual]

Get the current document from the iterator.

Returns:
Handle_exotkAF_Document

Definition at line 235 of file exotkAF_Application.cxx.

exotkAF_Application::DispatchPlugin ( const Handle_exotkPlugin_Plugin & aPlugin ) [protected, virtual]

Dispatch aPlugin in the good package.

Parameters:

aPlugin const Handle_exotkPlugin_Plugin&

Definition at line 346 of file exotkAF_Application.cxx.
References exotkTrace::Error(), exotkTrace::Info(), PLUGINID_FCT, and exotkDX::RegisterPlugin().
Referenced by LoadPlugins().

Handle_Standard_Type & exotkAF_Application::DynamicType ( ) const

OCC type management.

Returns:
const Handle_Standard_Type&

exotkAF_Application::InitDocIterator ( ) [virtual]

Initialize the document iterator.

Definition at line 199 of file exotkAF_Application.cxx.
References myDocuments.

exotkAF_Application::IsKind ( const Handle_Standard_Type & ) const

OCC type management.

Returns:
Standard_Boolean
Parameters:

const Handle_Standard_Type&

exotkAF_Application::LoadPlugins ( ) [virtual]

Load and dispatch the plugins.

Returns:
Standard_Boolean : false if the plugin path is empty or not valid

Definition at line 300 of file exotkAF_Application.cxx.
References DispatchPlugin(), myPluginPath, and exotkPlugin::RegisterPlugin().

exotkAF_Application::MoreDocIterator ( ) [virtual]

Returns true if the iterator is not at its end.

Returns:
Standard_Boolean

Definition at line 211 of file exotkAF_Application.cxx.

exotkAF_Application::NbDocuments ( ) [virtual]

Return the number of documents.

Returns:
Standard_Integer

Definition at line 247 of file exotkAF_Application.cxx.
References myDocuments.

exotkAF_Application::NextDocIterator ( ) [virtual]

Set the iterator to the next document.

Definition at line 223 of file exotkAF_Application.cxx.

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

OCC delete.

Returns:
inline void
Parameters:

void *anAddress

Definition at line 94 of file exotkAF_Application.hxx.

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

OCC new.

Returns:
inline void*
Parameters:

size_t size

Definition at line 83 of file exotkAF_Application.hxx.

void * exotkAF_Application::operator new ( size_t ,

void * anAddress

) [inline]

OCC new.

Returns:
inline void*
Parameters:

size_t

void * anAddress

Definition at line 72 of file exotkAF_Application.hxx.

exotkAF_Application::PluginPath ( ) [virtual]

Return the path where the plugins are located.

Returns:
TCollection_AsciiString

Definition at line 287 of file exotkAF_Application.cxx.
References myPluginPath.

exotkAF_Application::RemoveDocument ( const Handle_exotkAF_Document & aDocument ) [virtual]

Remove aDocuemnt from the set of known documents.

Returns:
Standard_Boolean : return false if the document is not in the list
Parameters:

const Handle_exotkAF_Document& aDocument

Definition at line 187 of file exotkAF_Application.cxx.
References myDocuments.

exotkAF_Application::SetActiveDocument ( const Handle_exotkAF_Document & aDocument ) [virtual]

Set aDocument as active document.

Returns:
Standard_Boolean : false if aDocument is null or not known by the application ( should use AddDocument before )
Parameters:

aDocument const Handle_exotkAF_Document&

Definition at line 386 of file exotkAF_Application.cxx.
References myActiveDocument, and myDocuments.

exotkAF_Application::SetOpenCASCADEEnvironmentVariables ( const TCollection_AsciiString & aCSFGraphicShr,

const TCollection_AsciiString & aCSFUnitsDefinition,

const TCollection_AsciiString & aCSFUnitsLexicon,

const TCollection_AsciiString & aCSFMDTVFontDirectory,

const TCollection_AsciiString & aCSFMDTVTexturesDirectory

) [virtual]

Set the environment variables needed for OpenCASCADE.

Returns:
Standard_Boolean
Parameters:

aCSFGraphicShr const TCollection_AsciiString&

aCSFUnitsDefinition const TCollection_AsciiString&

aCSFUnitsLexicon const TCollection_AsciiString&

aCSFMDTVFontDirectory const TCollection_AsciiString&

aCSFMDTVTexturesDirectory const TCollection_AsciiString&

Definition at line 140 of file exotkAF_Application.cxx.
References exotkUtils_OSD::AddEnvironmentVariable(), and exotkUtils_OSD::FileExists().

exotkAF_Application::SetPluginPath ( const TCollection_AsciiString & aPluginPath ) [virtual]

Set the path where the plugins are located.

Returns:
Standard_Boolean : true if aPluginPath is valid
Parameters:

aPluginPath const TCollection_AsciiString&

Definition at line 261 of file exotkAF_Application.cxx.
References myPluginPath.

Friends And Related Function Documentation

Handle_Standard_Type & exotkAF_Application::exotkAF_Document_Type_ ( ) [friend]

OCC type management.

Returns:
friend Handle_Standard_Type&

Member Data Documentation

Handle_exotkAF_Document exotkAF_Application::myActiveDocument [private]

the active document
Definition at line 241 of file exotkAF_Application.hxx.
Referenced by ActiveDocument(), and SetActiveDocument().

Handle_exotkAF_HSetOfDocument exotkAF_Application::myDocuments [private]

the set of known documents
Definition at line 238 of file exotkAF_Application.hxx.
Referenced by AddDocument(), exotkAF_Application(), InitDocIterator(), NbDocuments(), RemoveDocument(), SetActiveDocument(), and ~exotkAF_Application().

TCollection_AsciiString exotkAF_Application::myPluginPath [private]

the path to search the plugins
Definition at line 244 of file exotkAF_Application.hxx.
Referenced by LoadPlugins(), PluginPath(), and SetPluginPath().

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

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

exotkAF_Application Class Reference

Public Methods

Protected Methods

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation