torc::architecture::DigestStream Class Reference

Encapsulation of a device or family digest stream. More...

#include <DigestStream.hpp>

Inheritance diagram for torc::architecture::DigestStream:

Collaboration diagram for torc::architecture::DigestStream:

Public Member Functions
	DigestStream (const boost::filesystem::path &inPath)
	Public constructor. More...
size_t	getBytesRead (void) const
	Returns the number of bytes read. More...
void	readSectionHeader (string &outHeader)
	Read and return a section header. More...
std::istream &	read (uint8_t &outValue)
	Read and return a uint8_t. More...
std::istream &	read (uint16_t &outValue)
	Read and return a uint16_t. More...
std::istream &	read (uint32_t &outValue)
	Read and return a uint32_t. More...
std::istream &	read (char *s, std::streamsize n)
	Read and return a character string. More...

Protected Types
typedef std::string	string
	Imported type name. More...
typedef boost::uint16_t	uint16_t
	Imported type name. More...
typedef boost::uint32_t	uint32_t
	Imported type name. More...
typedef char	DigestSectionHeader [16]
	Definition of a digest section header. More...

Protected Attributes
size_t	mBytesRead
	The number of bytes read. More...

Detailed Description

Encapsulation of a device or family digest stream.

DigestStreams are used to read family and device database files.

Definition at line 32 of file DigestStream.hpp.

Member Typedef Documentation

typedef char torc::architecture::DigestStream::DigestSectionHeader[16]

protected

Definition of a digest section header.

Definition at line 42 of file DigestStream.hpp.

typedef std::string torc::architecture::DigestStream::string

protected

Imported type name.

Definition at line 36 of file DigestStream.hpp.

typedef boost::uint16_t torc::architecture::DigestStream::uint16_t

protected

Imported type name.

Definition at line 38 of file DigestStream.hpp.

typedef boost::uint32_t torc::architecture::DigestStream::uint32_t

protected

Imported type name.

Definition at line 40 of file DigestStream.hpp.

Constructor & Destructor Documentation

torc::architecture::DigestStream::DigestStream ( const boost::filesystem::path &  inPath )

inline

Public constructor.

Definition at line 48 of file DigestStream.hpp.

            : gzifstream(inPath.string().c_str(), ios_base::in), mBytesRead(0) {}

Member Function Documentation

size_t torc::architecture::DigestStream::getBytesRead ( void  ) const

inline

Returns the number of bytes read.

Definition at line 52 of file DigestStream.hpp.

{ return mBytesRead; }

Here is the caller graph for this function:

std::istream& torc::architecture::DigestStream::read ( uint8_t &  outValue )

inline

Read and return a uint8_t.

Parameters

outValue

The uint8_t that was read from the stream.

Definition at line 64 of file DigestStream.hpp.

                                            {
            gzifstream::read(reinterpret_cast<char*>(&outValue), sizeof(uint8_t));
            //outValue = ntohs(outValue); // no endian conversion needed for single bytes
            mBytesRead += sizeof(uint8_t);
            return *this;
        }

Here is the caller graph for this function:

std::istream& torc::architecture::DigestStream::read ( uint16_t &  outValue )

inline

Read and return a uint16_t.

Parameters

outValue

The uint16_t that was read from the stream.

Definition at line 72 of file DigestStream.hpp.

                                             {
            gzifstream::read(reinterpret_cast<char*>(&outValue), sizeof(uint16_t));
            outValue = ntohs(outValue); // endian conversion
            mBytesRead += sizeof(uint16_t);
            return *this;
        }

std::istream& torc::architecture::DigestStream::read ( uint32_t &  outValue )

inline

Read and return a uint32_t.

Parameters

outValue

The uint32_t that was read from the stream.

Definition at line 80 of file DigestStream.hpp.

                                             {
            gzifstream::read(reinterpret_cast<char*>(&outValue), sizeof(uint32_t));
            outValue = ntohl(outValue); // endian conversion
            mBytesRead += sizeof(uint32_t);
            return *this;
        }

std::istream& torc::architecture::DigestStream::read ( char *  s, std::streamsize  n  )

inline

Read and return a character string.

This overrides the superclass behavior exclusively for the sake of tracking the number of bytes read.

Parameters

s	The character pointer to read into.
n	The number of characters to read.

Definition at line 91 of file DigestStream.hpp.

                                                   {
            gzifstream::read(s, n);
            mBytesRead += n;
            return *this;
        }

void torc::architecture::DigestStream::readSectionHeader ( string &  outHeader )

inline

Read and return a section header.

Parameters

outHeader

The section header that was read from the stream.

Definition at line 56 of file DigestStream.hpp.

                                                  {
            DigestSectionHeader sectionHeader;
            gzifstream::read(static_cast<char*>(sectionHeader), sizeof(sectionHeader));
            mBytesRead += sizeof(sectionHeader);
            outHeader.assign(sectionHeader, sizeof(sectionHeader));
        }

Here is the caller graph for this function:

Field Documentation

size_t torc::architecture::DigestStream::mBytesRead

protected

The number of bytes read.

Definition at line 45 of file DigestStream.hpp.

---

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

• DigestStream.hpp