Public Member Functions | Private Attributes | Friends | List of all members
ecl::devices::SharedFileCommon Class Reference

Interface distributed to all members of a shared output file. More...

#include <shared_file.hpp>

Public Member Functions

 SharedFileCommon ()
 
 SharedFileCommon (const std::string &name, ecl::WriteMode mode)
 Automatically opens a file and initialises the count. More...
 
virtual ~SharedFileCommon ()
 

Private Attributes

unsigned int count
 
Error error_handler
 
OFile file
 
ecl::Mutex mutex
 

Friends

class ecl::SharedFile
 
class SharedFileManager
 

Detailed Description

Interface distributed to all members of a shared output file.

Contains the objects required to be distributed amongst all members of a shared output file.

Definition at line 74 of file shared_file.hpp.

Constructor & Destructor Documentation

◆ SharedFileCommon() [1/2]

ecl::devices::SharedFileCommon::SharedFileCommon ( )
inline

Definition at line 80 of file shared_file.hpp.

◆ SharedFileCommon() [2/2]

ecl::devices::SharedFileCommon::SharedFileCommon ( const std::string &  name,
ecl::WriteMode  mode 
)

Automatically opens a file and initialises the count.

Automatically opens a file and initialises the count.

Parameters
name: file name.
mode: writing mode (either New or Append).

Definition at line 60 of file shared_file.cpp.

◆ ~SharedFileCommon()

virtual ecl::devices::SharedFileCommon::~SharedFileCommon ( )
inlinevirtual

Definition at line 90 of file shared_file.hpp.

Friends And Related Function Documentation

◆ ecl::SharedFile

friend class ecl::SharedFile
friend

Definition at line 92 of file shared_file.hpp.

◆ SharedFileManager

friend class SharedFileManager
friend

Definition at line 93 of file shared_file.hpp.

Member Data Documentation

◆ count

unsigned int ecl::devices::SharedFileCommon::count
private

Definition at line 96 of file shared_file.hpp.

◆ error_handler

Error ecl::devices::SharedFileCommon::error_handler
private

Definition at line 99 of file shared_file.hpp.

◆ file

OFile ecl::devices::SharedFileCommon::file
private

Definition at line 98 of file shared_file.hpp.

◆ mutex

ecl::Mutex ecl::devices::SharedFileCommon::mutex
private

Definition at line 97 of file shared_file.hpp.


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


ecl_devices
Author(s): Daniel Stonier
autogenerated on Sun Aug 2 2020 03:12:18