SEDRIS Transmittal Access C++ API

00001 /*
00002  *  Copyright (c) 2003 Accent Geographic. All rights reserved.
00003  *  See the license file for licensing information.
00004  *  Created 2003/05/31
00005  */
00006 

00008 

00010 
00011 // $Id: seWorkspace.h,v 1.8 2004/06/02 18:19:00 wmacchi Exp $
00012 
00013 #ifndef _seWorkspace_h
00014 #define _seWorkspace_h
00015 
00021 #include "seCommon.h"
00022 
00023 namespace sedris {
00024 
00025 class IWorkspace;
00026 
00027 class seTransmittal;
00028 class seObject;
00029 
00054 class EXPORT_DLL seWorkspace
00055 {
00056 public:
00057 
00069     seWorkspace( const char *name=NULL, const char *params=NULL );
00070 
00074     virtual ~seWorkspace();
00075 
00094     virtual void open( const char *name=NULL, const char *params=NULL );
00095 
00107     virtual void close();
00108 
00117     virtual bool isValid() const;
00118 
00127     virtual void setName( const char *name );
00128 
00130     virtual const char *getName() const;
00131 
00155     virtual void openTransmittalByFile( const char *file_name, seTransmittal &xmtal,
00156                                     SE_Access_Mode access_mode = SE_AC_MODE_READ_ONLY );
00157 
00166     void createTransmittal( const char *file_name, seTransmittal &xmtal )
00167     {
00168         openTransmittalByFile(file_name, xmtal, SE_AC_MODE_CREATE);
00169     }
00170 
00179     void editTransmittal( const char *file_name, seTransmittal &xmtal )
00180     {
00181         openTransmittalByFile(file_name, xmtal, SE_AC_MODE_UPDATE);
00182     }
00183 
00200     virtual void openTransmittalByURN( const char *xmtal_urn, seTransmittal &xmtal,
00201                                 SE_Access_Mode access_mode = SE_AC_MODE_READ_ONLY );
00202 
00206     virtual unsigned int getOpenedTransmittalCount() const;
00207 
00224     virtual void getOpenedTransmittal( unsigned int index, seTransmittal &xmtal ) const;
00225 
00289     virtual const char *resolveTransmittalURN( const char *xmtal_urn );
00290 
00333     virtual void createUnresolvedObject( const char *xmtal_urn,
00334                                 const char *obj_label, seObject &obj ) const;
00335 
00346     virtual void setITRBehaviour( SE_ITR_Behaviour itr_behaviour );
00347 
00351     virtual SE_ITR_Behaviour getITRBehaviour();
00352 
00371     virtual void setAccessModeInheritance( bool tf );
00372 
00376     virtual bool getAccessModeInheritance() const;
00377 
00385     virtual void setITRResolverPath( const char *new_path );
00386 
00390     virtual const char *getITRResolverPath() const;
00391 
00402     virtual void setMemoryModel( unsigned int mem_model );
00403 
00407     virtual unsigned int getMemoryModel() const;
00408 
00411     virtual const char *getImplVerInfo() const;
00412 
00413 protected:
00414 
00415     seWorkspace( const seWorkspace &other ) {} 
00416     seWorkspace &operator =( const seWorkspace & ) { return *this; } 
00417 
00418 private:
00419 
00420     SE_HANDLE_DECL_O(Workspace)
00421 };
00422 
00423 
00424 } // namespace sedris
00425 
00426 #endif // _seWorkspace_h
SEDRIS Transmittal Access C++ API	4.0.0 beta - 14 Jul 2004
Copyright © 2004 SEDRIS™	Docs by Doxygen 1.3.2