bit::Field Class Reference
["Record Definitions""Record Definitions""Record Definitions"]

#include <bit/field.h>

Inheritance diagram for bit::Field:

Inheritance graph
[legend]
List of all members.

Detailed Description

A Field identifies a starting point and a length.

This class extends FieldBase by including a name and a description.

Author:
Rick L. Vinyard, Jr.


Public Types

typedef BitPointer< Fieldpointer
typedef BitPointer< Fieldpointer
typedef BitPointer< Fieldpointer

Public Member Functions

 Field (std::string name="", size_t length=0, size_t length_units=BITS, int offset=0, size_t offset_units=BITS, std::string descr="")
virtual size_t length () const
 
Returns:
the length of this object in it's length units

virtual size_t length (size_t units) const
virtual void set_length (size_t length)
virtual size_t length_units () const
virtual void set_length_units (size_t units)
virtual int offset () const
 
Returns:
the offset of this object in the offset units of this object

virtual int offset (size_t units) const
virtual void set_offset (int offset)
virtual size_t offset_units () const
virtual void set_offset_units (size_t units)
virtual std::string name () const
 Returns the string name associated with this object.
virtual std::string name (int depth) const
virtual void set_name (const std::string &name)
virtual std::string description () const
 Returns the string description of this object.
virtual void set_description (const std::string &description)
virtual const std::string & xml ()
virtual FieldBase::pointer clone ()
virtual Container container_type ()
 Field (std::string name="", size_t length=0, size_t length_units=BITS, int offset=0, size_t offset_units=BITS, std::string descr="")
virtual size_t length () const
 
Returns:
the length of this object in it's length units

virtual size_t length (size_t units) const
virtual void set_length (size_t length)
virtual size_t length_units () const
virtual void set_length_units (size_t units)
virtual int offset () const
 
Returns:
the offset of this object in the offset units of this object

virtual int offset (size_t units) const
virtual void set_offset (int offset)
virtual size_t offset_units () const
virtual void set_offset_units (size_t units)
virtual std::string name () const
 Returns the string name associated with this object.
virtual std::string name (int depth) const
virtual void set_name (const std::string &name)
virtual std::string description () const
 Returns the string description of this object.
virtual void set_description (const std::string &description)
virtual const std::string & xml ()
virtual FieldBase::pointer clone ()
virtual Container container_type ()
 Field (std::string name="", size_t length=0, size_t length_units=BITS, int offset=0, size_t offset_units=BITS, std::string descr="")
virtual size_t length () const
 
Returns:
the length of this object in it's length units

virtual size_t length (size_t units) const
virtual void set_length (size_t length)
virtual size_t length_units () const
virtual void set_length_units (size_t units)
virtual int offset () const
 
Returns:
the offset of this object in the offset units of this object

virtual int offset (size_t units) const
virtual void set_offset (int offset)
virtual size_t offset_units () const
virtual void set_offset_units (size_t units)
virtual std::string name () const
 Returns the string name associated with this object.
virtual std::string name (int depth) const
virtual void set_name (const std::string &name)
virtual std::string description () const
 Returns the string description of this object.
virtual void set_description (const std::string &description)
virtual const std::string & xml ()
virtual FieldBase::pointer clone ()
virtual Container container_type ()

Static Public Member Functions

static Field::pointer create (std::string name="", size_t length=0, size_t length_units=BITS, int offset=0, size_t offset_units=BITS, std::string descr="")
static Field::pointer create (std::string name="", size_t length=0, size_t length_units=BITS, int offset=0, size_t offset_units=BITS, std::string descr="")
static Field::pointer create (std::string name="", size_t length=0, size_t length_units=BITS, int offset=0, size_t offset_units=BITS, std::string descr="")

Protected Attributes

std::string m_name
size_t m_length
size_t m_length_units
int m_offset
size_t m_offset_units
std::string m_description


Member Function Documentation

std::string bit::Field::name (  )  const [virtual]

Returns the string name associated with this object.

This pure virtual method is reimplemented by children to provide the proper notation, such as the array notation of elements, by children.

Implements bit::FieldBase.

virtual std::string bit::Field::name (  )  const [virtual]

Returns the string name associated with this object.

This pure virtual method is reimplemented by children to provide the proper notation, such as the array notation of elements, by children.

Implements bit::FieldBase.

virtual std::string bit::Field::name (  )  const [virtual]

Returns the string name associated with this object.

This pure virtual method is reimplemented by children to provide the proper notation, such as the array notation of elements, by children.

Implements bit::FieldBase.


The documentation for this class was generated from the following files:
Generated on Tue Mar 13 20:00:04 2007 by  doxygen 1.5.1