PStream Class Reference

#include <PStream.h>

Inheritance diagram for PStream:

Public Member Functions
	PStream (const std::string &filename, StreamDirection dir, StreamType type)
	The Standard constructor.
	PStream (const PStream &ps)
virtual	~PStream ()
	The Standard destructor.
void	Open (const std::string &filename, StreamDirection dir, StreamType type)
void	WriteChar (const char character)
	This method sends a single character to the stream.
void	WriteString (const std::string &buffer)
	This method just writes the char* string to the stream.
void	WriteBuffer (const std::string &buffer, unsigned int length)
char	ReadChar ()
std::string	ReadToken (const char separator)
	This reads up until the next separator token (or eof character)
std::string	ReadLine ()
std::string	ReadLineClean ()
bool	Eof ()
bool	Eol ()
bool	Close ()
virtual PEBL_DEVICE_TYPE	GetDeviceType ()
virtual bool	SetProperty (std::string, Variant v)
virtual Variant	GetProperty (std::string) const
virtual ObjectValidationError	ValidateProperty (std::string, Variant v) const
virtual ObjectValidationError	ValidateProperty (std::string) const
Public Member Functions inherited from PDevice
	PDevice ()
	The Standard constructor.
virtual	~PDevice ()
	The Standard destructor.
virtual int	GetState (int iface) const
Public Member Functions inherited from PEBLObjectBase
	PEBLObjectBase ()
	Standard Constructor.
	PEBLObjectBase (ComplexDataType cdt)
	Standard Constructor.
	PEBLObjectBase (const PEBLObjectBase &pob)
virtual	~PEBLObjectBase ()
	Standard Destructor.
virtual bool	InitializeProperty (std::string name, Variant v)
Variant	GetProperty (std::string) const
ComplexDataType	GetType ()
virtual std::string	ObjectName () const
virtual std::ostream &	PrintProperties (std::ostream &out)
virtual Variant	GetPropertyList ()

Protected Member Functions
virtual std::ostream &	SendToStream (std::ostream &out) const

Additional Inherited Members
Protected Attributes inherited from PEBLObjectBase
ComplexDataType	mCDT
std::map< std::string, Variant >	mProperties

Detailed Description

This is the base File Stream class. It is used to read and write files. It is also a subclass of PDevice, which means that it can be added to the event loop for interesting between-process communications, and probably even used as a basis for other input devices.

Definition at line 59 of file PStream.h.

Constructor & Destructor Documentation

PStream() [1/2]

PStream::PStream	(	const std::string &	filename,
		StreamDirection	dir,
		StreamType	type
	)

The Standard constructor.

PStream() [2/2]

PStream::PStream

(

const PStream &

ps

)

Definition at line 112 of file PStream.cpp.

{
    mFileStream = NULL;
}

References NULL.

~PStream()

PStream::~PStream ( )

virtual

The Standard destructor.

This is the standard pNode destructor.

Definition at line 401 of file PStream.cpp.

{
    // Standard Destructor
 
}

Member Function Documentation

Close()

bool PStream::Close

(

)

Definition at line 394 of file PStream.cpp.

{
    mFileStream->close();
    return true;
}

Referenced by PEBLStream::FileClose(), PEBLStream::FileReadList(), PEBLStream::FileReadTable(), PEBLStream::FileReadText(), and main().

Eof()

bool PStream::Eof

(

)

Definition at line 388 of file PStream.cpp.

{
    return mFileStream->eof();
}

Referenced by PEBLStream::EndOfFile(), PEBLStream::FileReadList(), PEBLStream::FileReadTable(), PEBLStream::FileReadText(), and main().

Eol()

bool PStream::Eol

(

)

Definition at line 356 of file PStream.cpp.

{
    // std::cout << "EOL:" << mFileStream->tellg() << "["<<mFileStream->peek()<<"]" << endl;
    if(mFileStream->peek() == 10)  //LF
        return true;
 
    if(mFileStream->peek() == 13)  //CR (precedes an LF in DOS.
        {
 
 
            streampos curr = mFileStream->tellg();
            mFileStream->seekg(1,ios_base::cur);//look forward one
            //cout<< "Next character: " << mFileStream->peek() <<endl;
            //std::cout<< "13 matchses:\n";
            if(mFileStream->peek() == 10)
                {
 
                    return true;
                }
            else
                {
                    //reverse out of it if this happens to not be paired with a LF.
                    mFileStream->seekg(-1,ios_base::cur);
                    return true;
                }
        }
    if(mFileStream->eof())   //EOF --treat as an EOL.)
        return true;
 
    return false;
}

Referenced by PEBLStream::EndOfLine(), and ReadToken().

GetDeviceType()

virtual PEBL_DEVICE_TYPE PStream::GetDeviceType ( )

inlinevirtual

Reimplemented from PDevice.

Definition at line 86 of file PStream.h.

{return PDT_STREAM;};

References PDT_STREAM.

GetProperty()

Variant PStream::GetProperty ( std::string  name ) const

virtual

Definition at line 430 of file PStream.cpp.

{
    //PEBLObjectBase::PrintProperties(cout);
    return PEBLObjectBase::GetProperty(name);
}

References PEBLObjectBase::GetProperty().

Open()

void PStream::Open	(	const std::string &	filename,
		StreamDirection	dir,
		StreamType	type
	)

Definition at line 118 of file PStream.cpp.

{
 
    mStreamFileName  = filename;
    mStreamDirection = dir;
    mStreamType      = type;
 
    //Now, create the stream with proper flags and ready it for
    //input/output.
 
 
    if(mStreamDirection==sdRead)
        {
            mFileStream->open(mStreamFileName.c_str(),  ios_base::in);
            if(!mFileStream->is_open())
                {
                    PError::SignalFatalError("Unable to open file ["+ mStreamFileName+"] for reading");
                }
        }
    else if (mStreamDirection==sdWrite)
        {
            mFileStream->open(mStreamFileName.c_str(),  ios_base::out);
            if(!mFileStream->is_open())
                {
                    PError::SignalFatalError("Unable to open file ["+ mStreamFileName+"] for writing");
                }
 
        }
    else if (mStreamDirection == sdAppend)
        {
            mFileStream->open(mStreamFileName.c_str(), ios_base::out | ios_base::app);
            if(!mFileStream->is_open())
                {
                    PError::SignalFatalError("Unable to open file ["+ mStreamFileName+"] for appending");
                }
        }
    else
        {
            //error
            PError::SignalFatalError("Error occurred in PStream::Open");
        }
    //Binary/ascii/unicode/etc could be done here as well.
 
 
    //If we didn't manage to encode anything, call an error
    if(!mFileStream)
        {
            PError::SignalFatalError("Error initiating file [" + mStreamFileName + ".");
        }
 
}

References sdAppend, sdRead, sdWrite, and PError::SignalFatalError().

Referenced by main().

ReadChar()

char PStream::ReadChar

(

)

This reads a single character from the filestream and returns it.

Definition at line 230 of file PStream.cpp.

{
    if(mStreamDirection == sdRead)
        {
 
            char tmp;
            mFileStream->get(tmp);
            return tmp;
 
        }
    else
        {
 
            PError::SignalFatalError("Error in PStream::ReadChar--trying to Read a Write stream\n");
            return 0;
        }
}

References sdRead, and PError::SignalFatalError().

Referenced by PEBLStream::FileReadCharacter(), and main().

ReadLine()

std::string PStream::ReadLine

(

)

This reads up until the next eol/eof character, including the newline character at the end.

Definition at line 290 of file PStream.cpp.

{
    if(mStreamDirection == sdRead)
        {
            std::string tmpstring;
            char tmp;
            mFileStream->get(tmp);
 
 
            while( !mFileStream->eof())
                {
                    tmpstring += tmp;
                    if(tmp == 10)       //10 is the newline character
                        break;          //Break out if the next character is eol
 
                    mFileStream->get(tmp);
                }
 
 
            return tmpstring;
        }
 
    else
        {
            PError::SignalFatalError("Error in PStream::ReadLine--trying to Read a Write stream\n");
            return 0;
        }
}

References sdRead, and PError::SignalFatalError().

Referenced by PEBLStream::FileReadText(), and main().

ReadLineClean()

std::string PStream::ReadLineClean

(

)

Definition at line 323 of file PStream.cpp.

{
    if(mStreamDirection == sdRead)
        {
            std::string tmpstring;
            char tmp;
            mFileStream->get(tmp);
 
 
            while( !mFileStream->eof())
                {
 
                    if(tmp == 10)       //10 is the newline character
                        break;          //Break out if the next character is eol
 
                    tmpstring += tmp;
                    mFileStream->get(tmp);
                }
 
 
            return tmpstring;
        }
 
    else
        {
            PError::SignalFatalError("Error in PStream::ReadLine--trying to Read a Write stream\n");
            return 0;
        }
}

References sdRead, and PError::SignalFatalError().

Referenced by PEBLStream::FileReadLine(), PEBLStream::FileReadList(), and PEBLStream::FileReadTable().

ReadToken()

std::string PStream::ReadToken

(

const char

separator

)

This reads up until the next separator token (or eof character)

Definition at line 251 of file PStream.cpp.

{
    if(mStreamDirection == sdRead)
        {
 
            std::string tmpstring;  //Create a stream to use to capture input.
            char tmp;
            while(!mFileStream->eof() )
                {
                    tmp = mFileStream->peek();
                    if (Eol())
                        {
                            //mFileStream->get(tmp);
                            break;
                        }
 
                    else  if(tmp == separator )
                        {
                            mFileStream->get(tmp);
                            break;
                        }
                    else
                        {
                            mFileStream->get(tmp);
                            tmpstring += tmp;
                        }
                }
            return tmpstring;
        }
    else
        {
            PError::SignalFatalError("Error in PStream::ReadToken--trying to Read a Write stream\n");
            return 0;
        }
}

References Eol(), sdRead, and PError::SignalFatalError().

Referenced by PEBLStream::FileReadWord(), and main().

SendToStream()

ostream & PStream::SendToStream ( std::ostream &  out ) const

protectedvirtual

Reimplemented from PDevice.

Definition at line 408 of file PStream.cpp.

{
    out << "<Generic File Stream>" << flush;
    return out;
}

SetProperty()

bool PStream::SetProperty ( std::string  name, Variant  v  )

virtual

Reimplemented from PEBLObjectBase.

Definition at line 416 of file PStream.cpp.

{
    if(name=="FILENAME")
        {
            PEBLObjectBase::SetProperty("FILENAME",v);
        }else if(name=="DIRECTION")
        {
            PEBLObjectBase::SetProperty("DIRECTION",v);
        }
    return true;
}

References PEBLObjectBase::SetProperty().

ValidateProperty() [1/2]

ObjectValidationError PStream::ValidateProperty ( std::string  name ) const

virtual

Reimplemented from PEBLObjectBase.

Definition at line 444 of file PStream.cpp.

{
 
    if(name == "FILENAME" || name=="DIRECTION")
        {
            return OVE_VALID;
        }else
        {
 
            return OVE_INVALID_PROPERTY_NAME;
        }
}

References OVE_INVALID_PROPERTY_NAME, and OVE_VALID.

ValidateProperty() [2/2]

ObjectValidationError PStream::ValidateProperty ( std::string  name, Variant  v  ) const

virtual

Reimplemented from PEBLObjectBase.

Definition at line 438 of file PStream.cpp.

{
    return ValidateProperty(name);
}

References ValidateProperty().

Referenced by ValidateProperty().

WriteBuffer()

void PStream::WriteBuffer	(	const std::string &	buffer,
		unsigned int	length
	)

This method sends the number of bytes specified by the length parameter from the buffer to the stream. This could be dangerous if the user is allowed to specify these things themselves.

Definition at line 190 of file PStream.cpp.

{
 
    if(mStreamDirection == sdWrite ||
       mStreamDirection == sdAppend)
        {
 
            int len =  length < buffer.size()? length: (int)(buffer.size());
            string tmp;
            std::copy(buffer.begin(), buffer.begin()+len, tmp.begin());
            (* mFileStream) << tmp << flush;
 
        }
    else
        {
            PError::SignalFatalError("Error in PStream::WriteBuffer--trying to write a Read stream: "+ string(mStreamFileName) + ".");
        }
}

References sdAppend, sdWrite, and PError::SignalFatalError().

Referenced by main().

WriteChar()

void PStream::WriteChar

(

const char

character

)

This method sends a single character to the stream.

Definition at line 172 of file PStream.cpp.

{
    if(mStreamDirection == sdWrite ||
       mStreamDirection == sdAppend)
        {
            (*mFileStream) << character << flush;
        }
    else
        {
           PError::SignalFatalError("Error in PStream::WriteChar--trying to write a Read stream: "+ string(mStreamFileName) + ".");
        }
 
}

References sdAppend, sdWrite, and PError::SignalFatalError().

Referenced by main().

WriteString()

void PStream::WriteString

(

const std::string &

buffer

)

This method just writes the char* string to the stream.

Definition at line 211 of file PStream.cpp.

{
 
    if(mStreamDirection == sdWrite ||
       mStreamDirection == sdAppend)
        {
            (* mFileStream) << buffer << flush;
 
        }
    else
        {
            PError::SignalFatalError("Error in PStream::WriteString--trying to write a Read stream: "+ string(mStreamFileName) + ".");
        }
 
}

References sdAppend, sdWrite, and PError::SignalFatalError().

Referenced by PEBLStream::FilePrint(), PEBLStream::FilePrint_(), and main().

---

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

• PStream.h
• PStream.cpp