Open CASCADE Technology  7.6.0
Data Structures | Public Member Functions | Protected Attributes

OSD_CachedFileSystem Class Reference

File system keeping last stream created by linked file system (OSD_FileSystem::DefaultFileSystem() by default) to be reused for opening a stream with the same URL. Note that as file is kept in opened state, application will need destroying this object to ensure all files being closed. This interface could be handy in context of reading numerous objects pointing to the same file (at different offset). Make sure to create a dedicated OSD_CachedFileSystem for each working thread to avoid data races. More...

#include <OSD_CachedFileSystem.hxx>

Inheritance diagram for OSD_CachedFileSystem:
Inheritance graph
[legend]

Data Structures

struct  OSD_CachedStream
 

Public Member Functions

 OSD_CachedFileSystem (const Handle< OSD_FileSystem > &theLinkedFileSystem=Handle< OSD_FileSystem >())
 Constructor. More...
 
const Handle< OSD_FileSystem > & LinkedFileSystem () const
 Return linked file system; initialized with OSD_FileSystem::DefaultFileSystem() by default. More...
 
void SetLinkedFileSystem (const Handle< OSD_FileSystem > &theLinkedFileSystem)
 Sets linked file system. More...
 
virtual Standard_Boolean IsSupportedPath (const TCollection_AsciiString &theUrl) const override
 Returns TRUE if URL defines a supported protocol. More...
 
virtual Standard_Boolean IsOpenIStream (const opencascade::std::shared_ptr< std::istream > &theStream) const override
 Returns TRUE if current input stream is opened for reading operations. More...
 
virtual Standard_Boolean IsOpenOStream (const opencascade::std::shared_ptr< std::ostream > &theStream) const override
 Returns TRUE if current output stream is opened for writing operations. More...
 
virtual opencascade::std::shared_ptr< std::istream > OpenIStream (const TCollection_AsciiString &theUrl, const std::ios_base::openmode theParams, const int64_t theOffset, const opencascade::std::shared_ptr< std::istream > &theOldStream) override
 Opens stream for specified file URL for reading operations or returns previously created stream pointing to the same URL. More...
 
virtual opencascade::std::shared_ptr< std::ostream > OpenOStream (const TCollection_AsciiString &theUrl, const std::ios_base::openmode theMode) override
 Opens stream for specified file URL for writing operations (std::ostream) by calling parent's method. More...
 
virtual opencascade::std::shared_ptr< std::streambuf > OpenStreamBuffer (const TCollection_AsciiString &theUrl, const std::ios_base::openmode theMode, const int64_t theOffset=0, int64_t *theOutBufSize=NULL) override
 Opens stream buffer for specified file URL. More...
 
- Public Member Functions inherited from OSD_FileSystem
 OSD_FileSystem ()
 Constructor. More...
 
virtual ~OSD_FileSystem ()
 Destructor. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Attributes

OSD_CachedStream myStream
 active cached stream More...
 
Handle< OSD_FileSystemmyLinkedFS
 linked file system to open files More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from OSD_FileSystem
static const Handle< OSD_FileSystem > & DefaultFileSystem ()
 Returns a global file system, which a selector between registered file systems (OSD_FileSystemSelector). More...
 
static void AddDefaultProtocol (const Handle< OSD_FileSystem > &theFileSystem, bool theIsPreferred=false)
 Registers file system within the global file system selector returned by OSD_FileSystem::DefaultFileSystem(). Note that registering protocols is not thread-safe operation and expected to be done once at application startup. More...
 
static void RemoveDefaultProtocol (const Handle< OSD_FileSystem > &theFileSystem)
 Unregisters file system within the global file system selector returned by OSD_FileSystem::DefaultFileSystem(). More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

File system keeping last stream created by linked file system (OSD_FileSystem::DefaultFileSystem() by default) to be reused for opening a stream with the same URL. Note that as file is kept in opened state, application will need destroying this object to ensure all files being closed. This interface could be handy in context of reading numerous objects pointing to the same file (at different offset). Make sure to create a dedicated OSD_CachedFileSystem for each working thread to avoid data races.

Constructor & Destructor Documentation

◆ OSD_CachedFileSystem()

OSD_CachedFileSystem::OSD_CachedFileSystem ( const Handle< OSD_FileSystem > &  theLinkedFileSystem = HandleOSD_FileSystem >())

Constructor.

Member Function Documentation

◆ IsOpenIStream()

virtual Standard_Boolean OSD_CachedFileSystem::IsOpenIStream ( const opencascade::std::shared_ptr< std::istream > &  theStream) const
overridevirtual

Returns TRUE if current input stream is opened for reading operations.

Implements OSD_FileSystem.

◆ IsOpenOStream()

virtual Standard_Boolean OSD_CachedFileSystem::IsOpenOStream ( const opencascade::std::shared_ptr< std::ostream > &  theStream) const
overridevirtual

Returns TRUE if current output stream is opened for writing operations.

Implements OSD_FileSystem.

◆ IsSupportedPath()

virtual Standard_Boolean OSD_CachedFileSystem::IsSupportedPath ( const TCollection_AsciiString theUrl) const
overridevirtual

Returns TRUE if URL defines a supported protocol.

Implements OSD_FileSystem.

◆ LinkedFileSystem()

const Handle< OSD_FileSystem >& OSD_CachedFileSystem::LinkedFileSystem ( ) const
inline

Return linked file system; initialized with OSD_FileSystem::DefaultFileSystem() by default.

◆ OpenIStream()

virtual opencascade::std::shared_ptr<std::istream> OSD_CachedFileSystem::OpenIStream ( const TCollection_AsciiString theUrl,
const std::ios_base::openmode  theParams,
const int64_t  theOffset,
const opencascade::std::shared_ptr< std::istream > &  theOldStream 
)
overridevirtual

Opens stream for specified file URL for reading operations or returns previously created stream pointing to the same URL.

Reimplemented from OSD_FileSystem.

◆ OpenOStream()

virtual opencascade::std::shared_ptr<std::ostream> OSD_CachedFileSystem::OpenOStream ( const TCollection_AsciiString theUrl,
const std::ios_base::openmode  theMode 
)
overridevirtual

Opens stream for specified file URL for writing operations (std::ostream) by calling parent's method.

Reimplemented from OSD_FileSystem.

◆ OpenStreamBuffer()

virtual opencascade::std::shared_ptr<std::streambuf> OSD_CachedFileSystem::OpenStreamBuffer ( const TCollection_AsciiString theUrl,
const std::ios_base::openmode  theMode,
const int64_t  theOffset = 0,
int64_t *  theOutBufSize = NULL 
)
overridevirtual

Opens stream buffer for specified file URL.

Implements OSD_FileSystem.

◆ SetLinkedFileSystem()

void OSD_CachedFileSystem::SetLinkedFileSystem ( const Handle< OSD_FileSystem > &  theLinkedFileSystem)
inline

Sets linked file system.

Field Documentation

◆ myLinkedFS

Handle< OSD_FileSystem > OSD_CachedFileSystem::myLinkedFS
protected

linked file system to open files

◆ myStream

OSD_CachedStream OSD_CachedFileSystem::myStream
protected

active cached stream


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