ast::Stream Class Reference

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

#include <Stream.h>

Inheritance diagram for ast::Stream:

Public Member Functions
	Stream (std::istream *istreamPtr, std::ostream *ostreamPtr)
	Construct a Stream from input and output std::streams.
	Stream ()
virtual	~Stream ()
	Stream (Stream const &)=default
	Stream (Stream &&)=default
Stream &	operator= (Stream const &)=default
Stream &	operator= (Stream &&)=default
bool	hasStdStream ()
	Return true if this Stream has an input or output std::stream.
char const *	source ()
	Source (read) from the stream.
bool	sink (char const *cstr)
	Sink (write) to the stream.
bool	getIsFits () const
	get isfits

Protected Member Functions
void	setIsFits (bool isFits)
	set isFits

Protected Attributes
std::shared_ptr< std::istream >	_istreamPtr
	input stream
std::shared_ptr< std::ostream >	_ostreamPtr
	output stream
std::string	_sourceStr
	string containing a local copy of sourced data, so source can return a char * that won't disappear right away
bool	_isFits
	is this a FITS stream?

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]	istreamPtr	source/input stream; may match ostreamPtr; may be nullptr if sourcing not needed
[in]	ostreamPtr	sink/output stream; may match istreamPtr; may be nullptr if sinking not needed

Definition at line 51 of file Stream.h.

            : _istreamPtr(), _ostreamPtr(), _sourceStr(), _isFits(false) {
        if (istreamPtr) {
            _istreamPtr = std::make_shared<std::istream>(istreamPtr->rdbuf());
        }
        if (ostreamPtr) {
            _ostreamPtr = std::make_shared<std::ostream>(ostreamPtr->rdbuf());
        }
    }

Stream() [2/4]

ast::Stream::Stream ( )

inlineexplicit

Definition at line 61 of file Stream.h.

: Stream(nullptr, nullptr) {}

~Stream()

virtual ast::Stream::~Stream ( )

inlinevirtual

Definition at line 63 of file Stream.h.

{}

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.

{ 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.

{ 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.

{ _isFits = isFits; }

sink()

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

inline

Sink (write) to the stream.

Parameters

[in]

cstr

data 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.

                                {
        if (_ostreamPtr) {
            (*_ostreamPtr) << cstr;
            if (!_isFits) {
                (*_ostreamPtr) << std::endl;
            }
            return static_cast<bool>(*_ostreamPtr);
        } else {
            return true;
        }
    }

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.

                         {
        if ((_istreamPtr) && (*_istreamPtr)) {
            if (_isFits) {
                // http://codereview.stackexchange.com/a/28759
                _sourceStr.resize(detail::FITSLEN);
                _istreamPtr->read(&_sourceStr[0], detail::FITSLEN);
            } else {
                std::getline(*_istreamPtr, _sourceStr);
            }
            if (*_istreamPtr) {
                return _sourceStr.c_str();
            }
        }
        return nullptr;
    }

Friends And Related Symbol 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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/astshim/g50ff169b8f+5929b3527e/include/astshim/Stream.h