bit::FieldVector::Element Class Reference

#include <bit/fieldvector.h>

Inheritance diagram for bit::FieldVector::Element:

Inheritance graph
[legend]
List of all members.

Detailed Description

Element is an base element in a field vector.

Author:
Rick L. Vinyard, Jr.


Public Types

typedef boost::shared_ptr<
Element
pointer

Public Member Functions

virtual size_t length () const
virtual size_t length (size_t units) const
virtual size_t length_units () const
virtual int offset () const
virtual int offset (size_t units) const
virtual size_t offset_units () const
 The offset units of an element are always specified in the length units of elements.
virtual std::string name () const
 Returns the string name associated with this object.
virtual std::string name (int depth) const
virtual std::string description () const
 Returns the string description of this object.
size_t index () const
virtual FieldBase::pointer clone ()

Protected Member Functions

 Element (size_t index)

Static Protected Member Functions

static Element::pointer create (size_t index)

Protected Attributes

size_t m_index

Friends

class FieldVector


Member Function Documentation

size_t bit::FieldVector::Element::length  )  const [virtual]
 

Returns:
the length of this object in it's length units

Implements bit::FieldBase.

size_t bit::FieldVector::Element::length_units  )  const [virtual]
 

Returns:
the length units of this object

Implements bit::FieldBase.

std::string bit::FieldVector::Element::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.

int bit::FieldVector::Element::offset  )  const [virtual]
 

Returns:
the offset of this object in the offset units of this object

Implements bit::FieldBase.

size_t bit::FieldVector::Element::offset_units  )  const [virtual]
 

The offset units of an element are always specified in the length units of elements.

In this way the offset is always specified as a multiple of length.

Implements bit::FieldBase.


The documentation for this class was generated from the following files:
Generated on Thu Jul 6 14:38:09 2006 by  doxygen 1.4.6