BxBit1.h

// ##################################################################
// Binx
// $Id: BxBit1_8h-source.html,v 1.1.1.1 2006/04/19 14:19:02 edikt2 Exp $
//
// Class for bit-1 data type.
// ##################################################################
/*

//  edikt::BinX
//  www.edikt.org
//  support@edikt.org

// Copyright (c) 2003 The University of Edinburgh.

*/

#ifndef __BxBit1__
#define __BxBit1__

#include "BxDataObject.h"

/*
 * Class implementing the BinX data type bit-1.
 * A byte is the smallest unit of physical storage provided for
 * any BinX primitive data type (through the Base class attribute dataValue_).
 * Although a byte is used to store a bit, process is performed on the bit level.
 * This class provides methods
 * to pack and unpack the bits into and out of a byte.
 * NOTE: BxBit1 is not a widely used primitive data type.
 * <BR><B>Use example:</B><BR>
 * Monochrome bitmaps use one bit to represent one pixel. The whole image
 * can be seen as an array of bits.
 * <BR><B>Since:</B>  BinX version 1.0.
 */
class DECLSPEC BxBit1 : public BxDataObject
{
public:
    BxBit1();
    BxBit1(const BxBit1& copy);
    virtual ~BxBit1();

    virtual char * className() const { return "BxBit1"; } //<Returns the null-terminated string "BxBit1".
    virtual BxBit1 * clone() const;

    virtual bool readFromFile() { return false; } //<Always returns the value false.

    bx_byte8 pack(bx_byte8 b, int shift);
    void unpack(bx_byte8 b, int shift);
};

#endif

---