PrepackedBuffer Class Reference

#include <PrepackedBuffer.h>

Collaboration diagram for PrepackedBuffer:

Public Member Functions
unsigned int	conv2buf (char *buf) const
const char *	data () const
unsigned int	dataSize () const
bool	isVector () const
unsigned int	numEntries () const
const char *	operator[] (unsigned int index) const
	PrepackedBuffer (const char *data, unsigned int dataSize, unsigned int numEntries=0)
	PrepackedBuffer (const PrepackedBuffer &other)
	PrepackedBuffer (const char *buf)
	PrepackedBuffer ()
unsigned int	size () const
	~PrepackedBuffer ()

Private Attributes
char *	data_
unsigned int	dataSize_
unsigned int	individualDataSize_
unsigned int	numEntries_

Detailed Description

this class is used to take data that has already been converted into a buffer by one or more Conv<> operations, and send it between nodes. Useful when one doesn't know the data type being transferred.

Definition at line 15 of file PrepackedBuffer.h.

Constructor & Destructor Documentation

PrepackedBuffer::PrepackedBuffer	(	const char *	data,
		unsigned int	dataSize,
		unsigned int	numEntries = 0
	)

Constructor. Here data is a pointer to the entire data block. dataSize is the size of the entire data block to be transferred, dataSize = individualDataSize * numEntries. numEntries is the # of array entries. For non-arrays it defaults to 0.

Definition at line 13 of file PrepackedBuffer.cpp.

References data_, dataSize(), dataSize_, individualDataSize_, and numEntries_.

    : dataSize_( dataSize ), numEntries_( numEntries )
{
    if ( numEntries == 0 )
        individualDataSize_ = dataSize_;
    else
        individualDataSize_ = dataSize_ / numEntries_;

    data_ = new char[ dataSize ];
    memcpy( data_, data, dataSize );
}

Here is the call graph for this function:

PrepackedBuffer::PrepackedBuffer

(

const PrepackedBuffer &

other

)

Definition at line 26 of file PrepackedBuffer.cpp.

References data_, dataSize_, individualDataSize_, and numEntries_.

    : dataSize_( other.dataSize_ ),
        numEntries_( other.numEntries_ )
{
    if ( numEntries_ == 0 )
        individualDataSize_ = dataSize_;
    else
        individualDataSize_ = dataSize_ / numEntries_;
    data_ = new char[ dataSize_ ];
    memcpy( data_, other.data_, dataSize_ );
}

PrepackedBuffer::PrepackedBuffer

(

const char *

buf

)

Constructor Here the char buffer is a serialized version of the Prepacked buffer

Definition at line 38 of file PrepackedBuffer.cpp.

References data_, dataSize_, individualDataSize_, and numEntries_.

    : dataSize_( *reinterpret_cast< const unsigned int * >( buf ) ),
        numEntries_( *reinterpret_cast< const unsigned int * >(
            buf + sizeof( unsigned int ) ) )
{
    if ( numEntries_ == 0 )
        individualDataSize_ = dataSize_;
    else
        individualDataSize_ = dataSize_ / numEntries_;
    data_ = new char[ dataSize_ ];
    memcpy( data_, buf + 2 * sizeof( unsigned int ), dataSize_ );
}

PrepackedBuffer::PrepackedBuffer

(

)

Definition at line 51 of file PrepackedBuffer.cpp.

References data_.

    : dataSize_( 0 ), numEntries_( 0 ), individualDataSize_( 0 )
{
    data_ = new char[1];
    data_[0] = '\0';
}

PrepackedBuffer::~PrepackedBuffer

(

)

Definition at line 58 of file PrepackedBuffer.cpp.

References data_.

{
    delete[] data_;
}

Member Function Documentation

unsigned int PrepackedBuffer::conv2buf

(

char *

buf

)

const

Converts to a buffer. Buf must be preallocated.

Definition at line 70 of file PrepackedBuffer.cpp.

References data_, dataSize_, numEntries_, and size().

{
    *reinterpret_cast< unsigned int* >( buf ) = dataSize_;
    buf += sizeof( unsigned int );
    *reinterpret_cast< unsigned int* >( buf ) = numEntries_;
    buf += sizeof( unsigned int );
    memcpy( buf, data_, dataSize_ );
    return size();
}

Here is the call graph for this function:

const char* PrepackedBuffer::data ( ) const

inline

Definition at line 42 of file PrepackedBuffer.h.

References data_.

                                 {
            return data_;
        }

unsigned int PrepackedBuffer::dataSize ( ) const

inline

Returns the size of the data contents.

Definition at line 56 of file PrepackedBuffer.h.

References dataSize_.

Referenced by PrepackedBuffer().

                                      {
            return dataSize_;
        }

Here is the caller graph for this function:

bool PrepackedBuffer::isVector ( ) const

inline

Flag: is the data type a single value or a vector?

Definition at line 82 of file PrepackedBuffer.h.

References numEntries_.

                              {
            return numEntries_ > 0;
        }

unsigned int PrepackedBuffer::numEntries ( ) const

inline

Returns number of data entries: size of transferred array.

Definition at line 75 of file PrepackedBuffer.h.

References numEntries_.

                                        {
            return numEntries_;
        }

const char * PrepackedBuffer::operator[]

(

unsigned int

index

)

const

looks up entry. If index exceeds numEntries_, then goes back to beginning. Lets us tile the target with repeating sequences. Most commonly just repeat one entry.

Definition at line 63 of file PrepackedBuffer.cpp.

References data_, individualDataSize_, and numEntries_.

{
    if ( numEntries_ == 0 )
        return data_ ;
    return data_ + ( index % numEntries_ ) * individualDataSize_;
}

unsigned int PrepackedBuffer::size ( ) const

inline

Returns the size of the entire PrepackedBuffer converted to char*

Definition at line 63 of file PrepackedBuffer.h.

References dataSize_.

Referenced by conv2buf().

                                  {
            return dataSize_ + 2 * sizeof( unsigned int );
        }

Here is the caller graph for this function:

Member Data Documentation

char* PrepackedBuffer::data_

private

Definition at line 89 of file PrepackedBuffer.h.

Referenced by conv2buf(), data(), operator[](), PrepackedBuffer(), and ~PrepackedBuffer().

unsigned int PrepackedBuffer::dataSize_

private

Definition at line 86 of file PrepackedBuffer.h.

Referenced by conv2buf(), dataSize(), PrepackedBuffer(), and size().

unsigned int PrepackedBuffer::individualDataSize_

private

Definition at line 88 of file PrepackedBuffer.h.

Referenced by operator[](), and PrepackedBuffer().

unsigned int PrepackedBuffer::numEntries_

private

Definition at line 87 of file PrepackedBuffer.h.

Referenced by conv2buf(), isVector(), numEntries(), operator[](), and PrepackedBuffer().

---

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

• moose-core/basecode/PrepackedBuffer.h
• moose-core/basecode/PrepackedBuffer.cpp