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

exotkDX_Root Class Reference

Root class for all the DataExchange plugins. More...

#include <exotkDX_Root.hxx>

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 exotkDX_Root ()
 Constructor. More...

virtual Standard_EXPORT ~exotkDX_Root ()
 Destructor. More...

virtual Standard_EXPORT Standard_Boolean AllowImport ()
 Return true if the plugin allow import. More...

virtual Standard_EXPORT Standard_Boolean AllowExport ()
 Return true if the plugin allow export. More...

virtual Standard_EXPORT Standard_Boolean Match (const TCollection_AsciiString &aFilename)
 Return true if aFilename match the plugin file format. More...

virtual Standard_EXPORT TCollection_AsciiString FormatName ()=0
 Return the format name ( ex: "BRep" ). More...

virtual Standard_EXPORT Handle_TColStd_HSequenceOfAsciiString FormatExtensions ()=0
 Return the format extensions ( ex : {".brep";".rle"} ). More...

Standard_EXPORT TCollection_AsciiString Filename ()
 Return the filename to handle in the Read-Write action. More...

Standard_EXPORT void SetFilename (const TCollection_AsciiString &aFilename)
 Set the filename to handle in the Read-Write action. More...

virtual Standard_EXPORT TopoDS_Shape LoadShape ()
 Load one shape from the file. More...

virtual Standard_EXPORT Handle_TopTools_HSequenceOfShape LoadShapes ()=0
 Load more shapes from the file. More...

virtual Standard_EXPORT Standard_Boolean SaveShape (const TopoDS_Shape &aShape)=0
 Save aShape in the file. More...

virtual Standard_EXPORT Standard_Boolean SaveShapes (const Handle_TopTools_HSequenceOfShape &aSequenceOfShapes)=0
 Save aSequenceOfShapes in the file. 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 Attributes

TCollection_AsciiString myFileName
Standard_Boolean myAllowImport
Standard_Boolean myAllowExport

Friends

Standard_EXPORT friend Handle_Standard_Type & exotkDX_Root_Type_ ()
 Type management. More...


Detailed Description

Root class for all the DataExchange plugins.

Author:
Stephane Routelous

Definition at line 52 of file exotkDX_Root.hxx.


Constructor & Destructor Documentation

exotkDX_Root::exotkDX_Root  
 

Constructor.

Definition at line 68 of file exotkDX_Root.cxx.

References myAllowExport, and myAllowImport.

exotkDX_Root::~exotkDX_Root   [virtual]
 

Destructor.

Definition at line 74 of file exotkDX_Root.cxx.


Member Function Documentation

exotkDX_Root::AllowExport   [virtual]
 

Return true if the plugin allow export.

Returns:
Standard_Boolean

Definition at line 83 of file exotkDX_Root.cxx.

References myAllowExport.

exotkDX_Root::AllowImport   [virtual]
 

Return true if the plugin allow import.

Returns:
Standard_Boolean

Definition at line 79 of file exotkDX_Root.cxx.

References myAllowImport.

Handle_Standard_Type & exotkDX_Root::DynamicType   const
 

Type management.

Returns:
const Handle_Standard_Type&

exotkDX_Root::Filename  
 

Return the filename to handle in the Read-Write action.

Returns:
TCollection_AsciiString

Definition at line 88 of file exotkDX_Root.cxx.

References myFileName.

exotkDX_Root::FormatExtensions   [pure virtual]
 

Return the format extensions ( ex : {".brep";".rle"} ).

Returns:
Handle_TColStd_HSequenceOfAsciiString

Referenced by Match().

exotkDX_Root::FormatName   [pure virtual]
 

Return the format name ( ex: "BRep" ).

Returns:
TCollection_AsciiString

exotkDX_Root::IsKind const Handle_Standard_Type &    const
 

Type management.

Returns:
Standard_Boolean
Parameters:
const  Handle_Standard_Type&

exotkDX_Root::LoadShape   [virtual]
 

Load one shape from the file.

Returns:
TopoDS_Shape

Definition at line 97 of file exotkDX_Root.cxx.

References exotkUtils_BRep::BuildShape(), and LoadShapes().

exotkDX_Root::LoadShapes   [pure virtual]
 

Load more shapes from the file.

Returns:
Handle_TopTools_HSequenceOfShape

Referenced by LoadShape().

exotkDX_Root::Match const TCollection_AsciiString &    aFilename [virtual]
 

Return true if aFilename match the plugin file format.

Returns:
Standard_Boolean
Parameters:
aFilename  const TCollection_AsciiString&

Definition at line 128 of file exotkDX_Root.cxx.

References FormatExtensions().

void exotkDX_Root::operator delete void *    anAddress [inline]
 

OCC delete.

Returns:
inline void
Parameters:
void  *anAddress

Definition at line 85 of file exotkDX_Root.hxx.

void * exotkDX_Root::operator new size_t    size [inline]
 

OCC new.

Returns:
inline void*
Parameters:
size_t  size

Definition at line 74 of file exotkDX_Root.hxx.

void * exotkDX_Root::operator new size_t   ,
void *    anAddress
[inline]
 

OCC new.

Returns:
inline void*
Parameters:
size_t 
void  * anAddress

Definition at line 63 of file exotkDX_Root.hxx.

exotkDX_Root::SaveShape const TopoDS_Shape &    aShape [pure virtual]
 

Save aShape in the file.

Returns:
Standard_Boolean
Parameters:
aShape  const TopoDS_Shape&

Referenced by SaveShapes().

exotkDX_Root::SaveShapes const Handle_TopTools_HSequenceOfShape &    aSequenceOfShapes [pure virtual]
 

Save aSequenceOfShapes in the file.

Returns:
Standard_Boolean
Parameters:
aSequenceOfShapes  const Handle_TopTools_HSequenceOfShape&

Definition at line 113 of file exotkDX_Root.cxx.

References exotkUtils_BRep::BuildShape(), and SaveShape().

exotkDX_Root::SetFilename const TCollection_AsciiString &    aFilename
 

Set the filename to handle in the Read-Write action.

Parameters:
aFilename  const TCollection_AsciiString&

Definition at line 92 of file exotkDX_Root.cxx.

References myFileName.


Friends And Related Function Documentation

Handle_Standard_Type & exotkDX_Root::exotkDX_Root_Type_   [friend]
 

Type management.

Returns:
friend Handle_Standard_Type&


Member Data Documentation

Standard_Boolean exotkDX_Root::myAllowExport [protected]
 

the allow export flag

Definition at line 217 of file exotkDX_Root.hxx.

Referenced by AllowExport(), and exotkDX_Root().

Standard_Boolean exotkDX_Root::myAllowImport [protected]
 

the allow import flag

Definition at line 215 of file exotkDX_Root.hxx.

Referenced by AllowImport(), and exotkDX_Root().

TCollection_AsciiString exotkDX_Root::myFileName [protected]
 

the filename to handle

Definition at line 213 of file exotkDX_Root.hxx.

Referenced by Filename(), and SetFilename().


The documentation for this class was generated from the following files:
Generated on Wed Jan 23 12:18:33 2002 for exotk by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001