#include <ByteStream.h>

Public Member Functions
	ByteStream ()

	ByteStream (const ByteStream &other)

template<typename T >
	ByteStream (T in)

	~ByteStream ()

template<typename T >
T	As ()

template<typename T >
const T	As () const

std::size_t	GetSize () const

std::string	GetTypeName () const

void *	IKnowWhatImDoing ()

template<typename T >
bool	Is () const

template<typename T >
bool	Is (const T &t) const

bool	IsEmpty () const

template<typename T >
	operator const T () const

template<typename T >
	operator T ()

void	operator= (const ByteStream &other)

bool	operator== (const ByteStream &other) const

void	Release ()

void	Set (const ByteStream &other)

template<typename T >
void	Set (T in)

Protected Attributes
bool	m_holding

std::size_t	m_size

void *	m_stream

std::string	m_typeName

Detailed Description

Generic byte stream class. Kinda like a void* that you can save and cast later. Work around for c++98 auto keyword and other wonky problems.

               DO NOT USE THIS IMPROPERLY!!

If you don't understand what this does and how it CAN GO HORRIBLY WRONG, DO NOT USE THIS CLASS!

This is used by BIO_SANITIZE_WITH_CACHE and Containers.

NOTE: ByteStreams are not virtual to save what space we can. This may change in a future release if we decide we somehow need more hacky, abstract storage.

Definition at line 47 of file ByteStream.h.

Constructor & Destructor Documentation

◆ ByteStream() [1/3]

bio::ByteStream::ByteStream ( )

DON'T USE THIS UNLESS YOU KNOW WHAT YOU'RE DOING

Definition at line 26 of file ByteStream.cpp.

    :
    m_stream(NULL),
    m_typeName(""),
    m_size(0),
    m_holding(false)
{
}

◆ ByteStream() [2/3]

template<typename T >

bio::ByteStream::ByteStream ( T in )

inline

Definition at line 56 of file ByteStream.h.

    {
        Set(in);
    }

References Set().

◆ ByteStream() [3/3]

bio::ByteStream::ByteStream ( const ByteStream & other )

Parameters

other

Definition at line 35 of file ByteStream.cpp.

{
    *this = other;
}

◆ ~ByteStream()

bio::ByteStream::~ByteStream ( )

Definition at line 40 of file ByteStream.cpp.

{
    Release();
}

References Release().

Member Function Documentation

◆ As() [1/2]

template<typename T >

T bio::ByteStream::As ( )

inline

Casts stored data to T.

Template Parameters

T

Returns: stored bytes as T.

Definition at line 89 of file ByteStream.h.

    {
        BIO_ASSERT(Is< T >());
        T* ret;
        std::memcpy(
            ret,
            m_stream,
            sizeof(T));
        return *ret;
    }

References BIO_ASSERT, and m_stream.

◆ As() [2/2]

template<typename T >

const T bio::ByteStream::As ( ) const

inline

Casts stored data to T.

Template Parameters

T

Returns: stored bytes as T.

Definition at line 106 of file ByteStream.h.

    {
        BIO_ASSERT(Is< T >());
        T* ret;
        std::memcpy(
            ret,
            m_stream,
            sizeof(T));
        return *ret;
    }

References BIO_ASSERT, and m_stream.

◆ GetSize()

std::size_t bio::ByteStream::GetSize ( ) const

Returns: the number of bytes *this points to.

Definition at line 73 of file ByteStream.cpp.

{
    return m_size;
}

References m_size.

◆ GetTypeName()

std::string bio::ByteStream::GetTypeName ( ) const

Returns: the type stored in *this as a string.

Definition at line 68 of file ByteStream.cpp.

{
    return m_typeName;
}

References m_typeName.

◆ IKnowWhatImDoing()

void * bio::ByteStream::IKnowWhatImDoing ( )

Assume the caller knows something we don't. Please don't use this.

Returns: the data in *this

Definition at line 78 of file ByteStream.cpp.

{
    return m_stream;
}

References m_stream.

Referenced by bio::genetic::Insertion::Seek(), and bio::genetic::Localization::Seek().

◆ Is() [1/2]

template<typename T >

bool bio::ByteStream::Is ( ) const

inline

Check if Set was called with T.

Template Parameters

T

Returns: whether or not *this should be pointing to data of type T.

Definition at line 183 of file ByteStream.h.

    {
        return sizeof(T) == m_size && TypeName< T >() == m_typeName;
    }

References m_size, and m_typeName.

Referenced by bio::physical::Arrangement< TYPE >::Add(), bio::physical::Arrangement< TYPE >::AreEqual(), and bio::physical::Line::AreEqual().

◆ Is() [2/2]

template<typename T >

bool bio::ByteStream::Is ( const T & t ) const

inline

Auto template determining version of Is<T>().

Template Parameters

T

Parameters

t	only used for automatically determining T.

Returns: whether or not *this should be pointing to data of type T.

Definition at line 195 of file ByteStream.h.

    {
        return Is< T >();
    }

◆ IsEmpty()

bool bio::ByteStream::IsEmpty ( ) const

Check if *this has been Set.

Returns: Whether or not *this points to any possibly valid data.

Definition at line 63 of file ByteStream.cpp.

{
    return !m_stream;
}

References m_stream.

◆ operator const T()

template<typename T >

bio::ByteStream::operator const T ( ) const

inline

Casts stored data to T.

Template Parameters

T

Returns: stored bytes as T.

Definition at line 134 of file ByteStream.h.

    {
        return As< T >();
    }

◆ operator T()

template<typename T >

bio::ByteStream::operator T ( )

inline

Casts stored data to T.

Template Parameters

T

Returns: stored bytes as T.

Definition at line 123 of file ByteStream.h.

    {
        return As< T >();
    }

◆ operator=()

void bio::ByteStream::operator= ( const ByteStream & other )

Parameters

other

Definition at line 45 of file ByteStream.cpp.

{
    Release(); //wipe old state.
 
    if (other.m_holding)
    {
        //We can't free the same memory twice, so we have to allocate a new block for ourselves.
        Set(other);
    }
    else
    {
        m_stream = other.m_stream;
        m_typeName = other.m_typeName;
        m_size = other.m_size;
        m_holding = false;
    }
}

References m_holding, m_size, m_stream, m_typeName, Release(), and Set().

◆ operator==()

bool bio::ByteStream::operator== ( const ByteStream & other ) const

Compares the memory contained in both *this and other.

Parameters

other

Returns: whether or not other holds the same bits as *this.

Definition at line 108 of file ByteStream.cpp.

{
    if (m_size != other.m_size || m_typeName != other.m_typeName)
    {
        return false;
    }
    return memcmp(
        m_stream,
        other.m_stream,
        m_size
    ) == 0;
}

References m_size, m_stream, and m_typeName.

◆ Release()

void bio::ByteStream::Release ( )

Frees the memory this was Holding. Nop if *this was not holding anything. NOTE: This does not call any destructors. You must do that yourself. (i.e. there is no typename -> new type -> union -> delete; delete)

Definition at line 96 of file ByteStream.cpp.

{
    if (!m_holding)
    {
        return;
    }
    std::free(m_stream);
    m_size = 0;
    m_typeName.clear();
    m_holding = false;
}

References m_holding, m_size, m_stream, and m_typeName.

Referenced by ~ByteStream(), and operator=().

◆ Set() [1/2]

void bio::ByteStream::Set ( const ByteStream & other )

Copies the data from an other into *this and Holds it.

Definition at line 83 of file ByteStream.cpp.

{
    m_stream = std::malloc(other.m_size);
    memcpy(
        m_stream,
        other.m_stream,
        other.m_size
    );
    m_size = other.m_size;
    m_typeName = other.m_typeName;
    m_holding = true;
}

References m_holding, m_size, m_stream, and m_typeName.

◆ Set() [2/2]

template<typename T >

void bio::ByteStream::Set ( T in )

inline

Copies the data given to a new memory location. This should be used if the provided "in" is expected to go out of scope but the value still be valid. Make sure you Release *this to delete the stored content.

Template Parameters

T

Parameters

in	data to store

Definition at line 147 of file ByteStream.h.

    {
        m_stream = std::malloc(sizeof(T));
        std::memcpy(
            m_stream,
            &in,
            sizeof(T));
        m_size = sizeof(T);
        m_typeName = TypeName< T >();
    }

References m_size, m_stream, and m_typeName.

Referenced by ByteStream(), bio::chemical::ExcitationWithoutArgument< WAVE, RETURN >::CallDown(), bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >::CallDown(), bio::chemical::ExcitationWithTwoArguments< WAVE, RETURN, ARGUMENT1, ARGUMENT2 >::CallDown(), operator=(), bio::physical::Filterable::Spin(), bio::physical::Periodic::Spin(), and bio::physical::Quantum< T >::Spin().

Member Data Documentation

◆ m_holding

bool bio::ByteStream::m_holding

protected

Definition at line 221 of file ByteStream.h.

Referenced by operator=(), Release(), and Set().

◆ m_size

std::size_t bio::ByteStream::m_size

protected

Definition at line 220 of file ByteStream.h.

Referenced by GetSize(), Is(), operator=(), operator==(), Release(), and Set().

◆ m_stream

void* bio::ByteStream::m_stream

protected

Definition at line 218 of file ByteStream.h.

Referenced by As(), IKnowWhatImDoing(), IsEmpty(), operator=(), operator==(), Release(), and Set().

◆ m_typeName

std::string bio::ByteStream::m_typeName

protected

Definition at line 219 of file ByteStream.h.

Referenced by GetTypeName(), Is(), operator=(), operator==(), Release(), and Set().

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

/home/eons/git/biology/lib_bio/inc/bio/common/ByteStream.h
/home/eons/git/biology/lib_bio/src/common/ByteStream.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ByteStream() [1/3]

◆ ByteStream() [2/3]

◆ ByteStream() [3/3]

◆ ~ByteStream()

Member Function Documentation

◆ As() [1/2]

◆ As() [2/2]

◆ GetSize()

◆ GetTypeName()

◆ IKnowWhatImDoing()

◆ Is() [1/2]

◆ Is() [2/2]

◆ IsEmpty()

◆ operator const T()

◆ operator T()

◆ operator=()

◆ operator==()

◆ Release()

◆ Set() [1/2]

◆ Set() [2/2]

Member Data Documentation

◆ m_holding

◆ m_size

◆ m_stream

◆ m_typeName