Open CASCADE Technology  7.7.0
Public Member Functions | Protected Attributes
OSD_FileSystemSelector Class Reference

File system implementation which tried to open stream using registered list of file systems. More...

#include <OSD_FileSystemSelector.hxx>

Inheritance diagram for OSD_FileSystemSelector:
Inheritance graph
[legend]

Public Member Functions

 OSD_FileSystemSelector ()
 Constructor. More...
 
void AddProtocol (const Handle< OSD_FileSystem > &theFileSystem, bool theIsPreferred=false)
 Registers file system within this selector. More...
 
void RemoveProtocol (const Handle< OSD_FileSystem > &theFileSystem)
 Unregisters file system within this selector. More...
 
virtual bool IsSupportedPath (const TCollection_AsciiString &theUrl) const override
 Returns TRUE if URL defines a supported protocol. More...
 
virtual Standard_Boolean IsOpenIStream (const 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 std::shared_ptr< std::ostream > &theStream) const override
 Returns TRUE if current output stream is opened for writing operations. More...
 
virtual std::shared_ptr< std::istream > OpenIStream (const TCollection_AsciiString &theUrl, const std::ios_base::openmode theMode, const int64_t theOffset=0, const std::shared_ptr< std::istream > &theOldStream=std::shared_ptr< std::istream >()) override
 Opens input stream using one of registered protocols. More...
 
virtual std::shared_ptr< std::ostream > OpenOStream (const TCollection_AsciiString &theUrl, const std::ios_base::openmode theMode) override
 Opens output stream using one of registered protocols. More...
 
virtual 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 using one of registered protocols. 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

NCollection_List< Handle< OSD_FileSystem > > myProtocols
 

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 implementation which tried to open stream using registered list of file systems.

Constructor & Destructor Documentation

◆ OSD_FileSystemSelector()

OSD_FileSystemSelector::OSD_FileSystemSelector ( )
inline

Constructor.

Member Function Documentation

◆ AddProtocol()

void OSD_FileSystemSelector::AddProtocol ( const Handle< OSD_FileSystem > &  theFileSystem,
bool  theIsPreferred = false 
)

Registers file system within this selector.

Parameters
theFileSystem[in] file system to register
theIsPreferred[in] add to the beginning of the list when TRUE, or add to the end otherwise

◆ IsOpenIStream()

virtual Standard_Boolean OSD_FileSystemSelector::IsOpenIStream ( const 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_FileSystemSelector::IsOpenOStream ( const std::shared_ptr< std::ostream > &  theStream) const
overridevirtual

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

Implements OSD_FileSystem.

◆ IsSupportedPath()

virtual bool OSD_FileSystemSelector::IsSupportedPath ( const TCollection_AsciiString theUrl) const
overridevirtual

Returns TRUE if URL defines a supported protocol.

Implements OSD_FileSystem.

◆ OpenIStream()

virtual std::shared_ptr<std::istream> OSD_FileSystemSelector::OpenIStream ( const TCollection_AsciiString theUrl,
const std::ios_base::openmode  theMode,
const int64_t  theOffset = 0,
const std::shared_ptr< std::istream > &  theOldStream = std::shared_ptr< std::istream >() 
)
overridevirtual

Opens input stream using one of registered protocols.

Reimplemented from OSD_FileSystem.

◆ OpenOStream()

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

Opens output stream using one of registered protocols.

Reimplemented from OSD_FileSystem.

◆ OpenStreamBuffer()

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

Opens stream buffer using one of registered protocols.

Implements OSD_FileSystem.

◆ RemoveProtocol()

void OSD_FileSystemSelector::RemoveProtocol ( const Handle< OSD_FileSystem > &  theFileSystem)

Unregisters file system within this selector.

Field Documentation

◆ myProtocols

NCollection_List<Handle< OSD_FileSystem > > OSD_FileSystemSelector::myProtocols
protected

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