LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ast::FileStream Class Reference

File-based source or sink (not both) for channels. More...

#include <Stream.h>

Inheritance diagram for ast::FileStream:
ast::Stream

Public Member Functions

 FileStream (std::string const &path, bool doWrite=false)
 Construct a FileStream for reading or writing, but not both. More...
 
virtual ~FileStream ()
 
std::string getPath () const
 Get the path to the file, as a string. More...
 
bool hasStdStream ()
 Return true if this Stream has an input or output std::stream. More...
 
char const * source ()
 Source (read) from the stream. More...
 
bool sink (char const *cstr)
 Sink (write) to the stream. More...
 
bool getIsFits () const
 get isfits More...
 

Protected Member Functions

void setIsFits (bool isFits)
 set isFits More...
 

Protected Attributes

std::shared_ptr< std::istream_istreamPtr
 input stream More...
 
std::shared_ptr< std::ostream_ostreamPtr
 output stream More...
 
std::string _sourceStr
 string containing a local copy of sourced data, so source can return a char * that won't disappear right away More...
 
bool _isFits
 is this a FITS stream? More...
 

Detailed Description

File-based source or sink (not both) for channels.

Definition at line 142 of file Stream.h.

Constructor & Destructor Documentation

◆ FileStream()

ast::FileStream::FileStream ( std::string const &  path,
bool  doWrite = false 
)
inlineexplicit

Construct a FileStream for reading or writing, but not both.

Parameters
[in]pathPath to file as a string
[in]doWriteIf true then write to the file, otherwise read from the file

Definition at line 150 of file Stream.h.

150  : Stream(), _path(path) {
151  auto mode = doWrite ? std::ios_base::out : std::ios_base::in;
152  auto fstreamPtr = std::make_shared<std::fstream>(path, mode);
153  if (!*fstreamPtr) {
155  os << "Failed to open file \"" << path << "\" for " << (doWrite ? "writing" : "reading");
156  throw std::runtime_error(os.str());
157  }
158  if (doWrite) {
159  _ostreamPtr = fstreamPtr;
160  } else {
161  _istreamPtr = fstreamPtr;
162  }
163  }
Stream()
Definition: Stream.h:61
std::shared_ptr< std::istream > _istreamPtr
input stream
Definition: Stream.h:131
T str(T... args)
std::shared_ptr< std::ostream > _ostreamPtr
output stream
Definition: Stream.h:132
std::ostream * os
Definition: Schema.cc:746

◆ ~FileStream()

virtual ast::FileStream::~FileStream ( )
inlinevirtual

Definition at line 165 of file Stream.h.

165 {}

Member Function Documentation

◆ getIsFits()

bool ast::Stream::getIsFits ( ) const
inlineinherited

get isfits

Definition at line 125 of file Stream.h.

125 { return _isFits; }
bool _isFits
is this a FITS stream?
Definition: Stream.h:136

◆ getPath()

std::string ast::FileStream::getPath ( ) const
inline

Get the path to the file, as a string.

Definition at line 168 of file Stream.h.

168 { return _path; }

◆ hasStdStream()

bool ast::Stream::hasStdStream ( )
inlineinherited

Return true if this Stream has an input or output std::stream.

Definition at line 73 of file Stream.h.

73 { return _istreamPtr || _ostreamPtr; }
std::shared_ptr< std::istream > _istreamPtr
input stream
Definition: Stream.h:131
std::shared_ptr< std::ostream > _ostreamPtr
output stream
Definition: Stream.h:132

◆ setIsFits()

void ast::Stream::setIsFits ( bool  isFits)
inlineprotectedinherited

set isFits

Definition at line 129 of file Stream.h.

129 { _isFits = isFits; }
bool _isFits
is this a FITS stream?
Definition: Stream.h:136

◆ sink()

bool ast::Stream::sink ( char const *  cstr)
inlineinherited

Sink (write) to the stream.

Parameters
[in]cstrdata to write; a newline is then written if _isFits false
Returns
true on success or if there is no stream pointer (a normal mode), false if the stream pointer is in a bad state after writing
Note
this function is not virtual because of type slicing: this function is called from code that casts a void pointer to a Stream pointer without knowing which kind of Stream it is.

Definition at line 110 of file Stream.h.

110  {
111  if (_ostreamPtr) {
112  (*_ostreamPtr) << cstr;
113  if (!_isFits) {
114  (*_ostreamPtr) << std::endl;
115  }
116  return static_cast<bool>(*_ostreamPtr);
117  } else {
118  return true;
119  }
120  }
T endl(T... args)
bool _isFits
is this a FITS stream?
Definition: Stream.h:136
std::shared_ptr< std::ostream > _ostreamPtr
output stream
Definition: Stream.h:132

◆ source()

char const* ast::Stream::source ( )
inlineinherited

Source (read) from the stream.

Returns
the data read as a C string, or nullptr if there is no source stream or the source stream is empty or in an error state. The Stream owns the string buffer, and it will be invalidated on the next call to this function.

Definition at line 84 of file Stream.h.

84  {
85  if ((_istreamPtr) && (*_istreamPtr)) {
86  if (_isFits) {
87  // http://codereview.stackexchange.com/a/28759
88  _sourceStr.resize(detail::FITSLEN);
89  _istreamPtr->read(&_sourceStr[0], detail::FITSLEN);
90  } else {
92  }
93  if (*_istreamPtr) {
94  return _sourceStr.c_str();
95  }
96  }
97  return nullptr;
98  }
T getline(T... args)
std::string _sourceStr
string containing a local copy of sourced data, so source can return a char * that won&#39;t disappear ri...
Definition: Stream.h:135
T resize(T... args)
std::shared_ptr< std::istream > _istreamPtr
input stream
Definition: Stream.h:131
bool _isFits
is this a FITS stream?
Definition: Stream.h:136
T c_str(T... args)

Member Data Documentation

◆ _isFits

bool ast::Stream::_isFits
protectedinherited

is this a FITS stream?

Definition at line 136 of file Stream.h.

◆ _istreamPtr

std::shared_ptr<std::istream> ast::Stream::_istreamPtr
protectedinherited

input stream

Definition at line 131 of file Stream.h.

◆ _ostreamPtr

std::shared_ptr<std::ostream> ast::Stream::_ostreamPtr
protectedinherited

output stream

Definition at line 132 of file Stream.h.

◆ _sourceStr

std::string ast::Stream::_sourceStr
protectedinherited

string containing a local copy of sourced data, so source can return a char * that won't disappear right away

Definition at line 135 of file Stream.h.


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