HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HDK_Sample::FS_HomeWriteHelper Class Reference

Class to open a file as a write stream. The class tests for a "home:" prefix and replaces it with $HOME. More...

#include <FS_HomeHelper.h>

+ Inheritance diagram for HDK_Sample::FS_HomeWriteHelper:

Public Member Functions

 FS_HomeWriteHelper ()
 
 ~FS_HomeWriteHelper () override
 
FS_WriterStreamcreateStream (const char *source) override
 If the filename begins with "home:" return a new write stream. More...
 
bool canMakeDirectory (const char *source) override
 Whether this helper supports the given source path for makeDirectory(). More...
 
bool makeDirectory (const char *source, mode_t mode=0777, bool ignore_umask=false) override
 Make a directory and all the parent directories needed. More...
 
- Public Member Functions inherited from FS_WriterHelper
 FS_WriterHelper ()
 
virtual ~FS_WriterHelper ()
 

Detailed Description

Class to open a file as a write stream. The class tests for a "home:" prefix and replaces it with $HOME.

Examples:
FS/FS_HomeHelper.C.

Definition at line 85 of file FS_HomeHelper.h.

Constructor & Destructor Documentation

FS_HomeWriteHelper::FS_HomeWriteHelper ( )
Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 446 of file FS_HomeHelper.C.

FS_HomeWriteHelper::~FS_HomeWriteHelper ( )
override
Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 451 of file FS_HomeHelper.C.

Member Function Documentation

bool FS_HomeWriteHelper::canMakeDirectory ( const char *  source)
overridevirtual

Whether this helper supports the given source path for makeDirectory().

Reimplemented from FS_WriterHelper.

Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 468 of file FS_HomeHelper.C.

FS_WriterStream * FS_HomeWriteHelper::createStream ( const char *  source)
overridevirtual

If the filename begins with "home:" return a new write stream.

Implements FS_WriterHelper.

Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 456 of file FS_HomeHelper.C.

bool FS_HomeWriteHelper::makeDirectory ( const char *  source,
mode_t  mode = 0777,
bool  ignore_umask = false 
)
overridevirtual

Make a directory and all the parent directories needed.

Reimplemented from FS_WriterHelper.

Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 475 of file FS_HomeHelper.C.


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