LSSTApplications  19.0.0-14-gb0260a2+68b5710e34,20.0.0+34a42eae2c,20.0.0+5e413b1bb7,20.0.0+8220981c08,20.0.0+8558dd3f48,20.0.0+9105c11c27,20.0.0+9c492b2baa,20.0.0+b290a576ab,20.0.0+b2ea66fa67,20.0.0+bdb47f006b,20.0.0+c80b78a72c,20.0.0+ca71b4c878,20.0.0+dcf29472a8,20.0.0+f45b7d88f4,20.0.0+ff38a75775,20.0.0-1-g10df615+0301c91ccb,20.0.0-1-g253301a+dcf29472a8,20.0.0-1-g498fb60+ff88705a28,20.0.0-1-g4d801e7+0fef26433e,20.0.0-1-g8a53f90+2817c06967,20.0.0-1-gc96f8cb+9c492b2baa,20.0.0-1-gd1c87d7+2817c06967,20.0.0-1-gdb27ee5+60996fbbb1,20.0.0-11-gda4966f+51d1f94bfc,20.0.0-17-g98646ba4+6d72394450,20.0.0-2-g25c5319+53d663580f,20.0.0-2-gec03fae+3bc057fb2a,20.0.0-27-g22bab1b+63c2eb6a9e,20.0.0-3-gd2e950e+f45b7d88f4,20.0.0-4-g4a2362f+f45b7d88f4,20.0.0-4-ge48a6ca+6f08222a1e,20.0.0-5-gac0d578b1+6c871ee35c,20.0.0-6-g01203fff+c632a9a46a,20.0.0-7-g3c4151b+49dfb5b924,20.0.0-8-g9573cbd+60996fbbb1,20.0.0-8-gc2abeef+9c492b2baa,w.2020.32
LSSTDataManagementBasePackage
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
ast::Stream Class Reference

A stream for ast::Channel. More...

#include <Stream.h>

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

Public Member Functions

 Stream (std::istream *istreamPtr, std::ostream *ostreamPtr)
 Construct a Stream from input and output std::streams. More...
 
 Stream ()
 
virtual ~Stream ()
 
 Stream (Stream const &)=default
 
 Stream (Stream &&)=default
 
Streamoperator= (Stream const &)=default
 
Streamoperator= (Stream &&)=default
 
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...
 

Friends

class Channel
 

Detailed Description

A stream for ast::Channel.

Definition at line 41 of file Stream.h.

Constructor & Destructor Documentation

◆ Stream() [1/4]

ast::Stream::Stream ( std::istream istreamPtr,
std::ostream ostreamPtr 
)
inlineexplicit

Construct a Stream from input and output std::streams.

Parameters
[in]istreamPtrsource/input stream; may match ostreamPtr; may be nullptr if sourcing not needed
[in]ostreamPtrsink/output stream; may match istreamPtr; may be nullptr if sinking not needed

Definition at line 51 of file Stream.h.

52  : _istreamPtr(), _ostreamPtr(), _sourceStr(), _isFits(false) {
53  if (istreamPtr) {
54  _istreamPtr = std::make_shared<std::istream>(istreamPtr->rdbuf());
55  }
56  if (ostreamPtr) {
57  _ostreamPtr = std::make_shared<std::ostream>(ostreamPtr->rdbuf());
58  }
59  }

◆ Stream() [2/4]

ast::Stream::Stream ( )
inlineexplicit

Definition at line 61 of file Stream.h.

61 : Stream(nullptr, nullptr) {}

◆ ~Stream()

virtual ast::Stream::~Stream ( )
inlinevirtual

Definition at line 63 of file Stream.h.

63 {}

◆ Stream() [3/4]

ast::Stream::Stream ( Stream const &  )
default

◆ Stream() [4/4]

ast::Stream::Stream ( Stream &&  )
default

Member Function Documentation

◆ getIsFits()

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

get isfits

Definition at line 125 of file Stream.h.

125 { return _isFits; }

◆ hasStdStream()

bool ast::Stream::hasStdStream ( )
inline

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

Definition at line 73 of file Stream.h.

73 { return _istreamPtr || _ostreamPtr; }

◆ operator=() [1/2]

Stream& ast::Stream::operator= ( Stream &&  )
default

◆ operator=() [2/2]

Stream& ast::Stream::operator= ( Stream const &  )
default

◆ setIsFits()

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

set isFits

Definition at line 129 of file Stream.h.

129 { _isFits = isFits; }

◆ sink()

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

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  }

◆ source()

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

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  }

Friends And Related Function Documentation

◆ Channel

friend class Channel
friend

Definition at line 122 of file Stream.h.

Member Data Documentation

◆ _isFits

bool ast::Stream::_isFits
protected

is this a FITS stream?

Definition at line 136 of file Stream.h.

◆ _istreamPtr

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

input stream

Definition at line 131 of file Stream.h.

◆ _ostreamPtr

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

output stream

Definition at line 132 of file Stream.h.

◆ _sourceStr

std::string ast::Stream::_sourceStr
protected

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:
std::string::resize
T resize(T... args)
std::istream::rdbuf
T rdbuf(T... args)
ast::Stream::_sourceStr
std::string _sourceStr
string containing a local copy of sourced data, so source can return a char * that won't disappear ri...
Definition: Stream.h:135
std::istream::read
T read(T... args)
ast::Stream::Stream
Stream()
Definition: Stream.h:61
std::string::c_str
T c_str(T... args)
std::endl
T endl(T... args)
std::getline
T getline(T... args)
ast::Stream::_istreamPtr
std::shared_ptr< std::istream > _istreamPtr
input stream
Definition: Stream.h:131
ast::Stream::_isFits
bool _isFits
is this a FITS stream?
Definition: Stream.h:136
ast::Stream::_ostreamPtr
std::shared_ptr< std::ostream > _ostreamPtr
output stream
Definition: Stream.h:132