#include <bit/record.h>
Inheritance diagram for bit::Record:
FOLDOC defines record as: "An ordered set of fields, usually stored contiguously. ... Some programming languages use the term to mean a type composed of fields of several other types (C calls this a "struct")."
In the context of the bit library, a record stores an ordered set of bit::Field types.
The Record class extends the RecordBase by providing storage for Field objects as well as providing the concept of a name and description strings.
Public Types | |
typedef BitPointer< Record > | pointer |
Convenience typedef to a smart pointer to bit::Record. | |
typedef BitPointer< Record > | pointer |
Convenience typedef to a smart pointer to bit::Record. | |
typedef BitPointer< Record > | pointer |
Convenience typedef to a smart pointer to bit::Record. | |
Public Member Functions | |
Record (std::string name="", size_t length_units=BITS, int offset=0, size_t offset_units=BITS, std::string descr="") | |
Default constructor. | |
virtual | ~Record () |
Destructor. | |
virtual size_t | length () const |
| |
virtual size_t | length (size_t units) const |
virtual const std::string & | xml () |
virtual iterator | begin () |
virtual iterator | end () |
virtual FieldBase::pointer | field (std::string s) |
virtual FieldBase::pointer | field (size_t i) |
virtual void | add_field (FieldBase::pointer field) |
virtual void | remove_field (FieldBase::pointer field) |
virtual void | remove_field (const std::string &name) |
virtual size_t | fields () |
virtual FieldBase::pointer | clone () |
virtual Container | container_type () |
Record (std::string name="", size_t length_units=BITS, int offset=0, size_t offset_units=BITS, std::string descr="") | |
Default constructor. | |
virtual | ~Record () |
Destructor. | |
virtual size_t | length () const |
| |
virtual size_t | length (size_t units) const |
virtual const std::string & | xml () |
virtual iterator | begin () |
virtual iterator | end () |
virtual FieldBase::pointer | field (std::string s) |
virtual FieldBase::pointer | field (size_t i) |
virtual void | add_field (FieldBase::pointer field) |
virtual void | remove_field (FieldBase::pointer field) |
virtual void | remove_field (const std::string &name) |
virtual size_t | fields () |
virtual FieldBase::pointer | clone () |
virtual Container | container_type () |
Record (std::string name="", size_t length_units=BITS, int offset=0, size_t offset_units=BITS, std::string descr="") | |
Default constructor. | |
virtual | ~Record () |
Destructor. | |
virtual size_t | length () const |
| |
virtual size_t | length (size_t units) const |
virtual const std::string & | xml () |
virtual iterator | begin () |
virtual iterator | end () |
virtual FieldBase::pointer | field (std::string s) |
virtual FieldBase::pointer | field (size_t i) |
virtual void | add_field (FieldBase::pointer field) |
virtual void | remove_field (FieldBase::pointer field) |
virtual void | remove_field (const std::string &name) |
virtual size_t | fields () |
virtual FieldBase::pointer | clone () |
virtual Container | container_type () |
Static Public Member Functions | |
static Record::pointer | create (std::string name="", size_t length_units=BITS, int offset=0, size_t offset_units=BITS, std::string descr="") |
Static method returns a smart pointer to a new Record object. | |
static Record::pointer | create (std::string name="", size_t length_units=BITS, int offset=0, size_t offset_units=BITS, std::string descr="") |
Static method returns a smart pointer to a new Record object. | |
static Record::pointer | create (std::string name="", size_t length_units=BITS, int offset=0, size_t offset_units=BITS, std::string descr="") |
Static method returns a smart pointer to a new Record object. | |
Protected Member Functions | |
virtual FieldBase::pointer | previous_field (FieldBase::pointer current_field) throw (exception::invalid_container_op) |
virtual FieldBase::pointer | next_field (FieldBase::pointer current_field) throw (exception::invalid_container_op) |
virtual FieldBase::pointer | previous_field (FieldBase::pointer current_field) throw (exception::invalid_container_op) |
virtual FieldBase::pointer | next_field (FieldBase::pointer current_field) throw (exception::invalid_container_op) |
virtual FieldBase::pointer | previous_field (FieldBase::pointer current_field) throw (exception::invalid_container_op) |
virtual FieldBase::pointer | next_field (FieldBase::pointer current_field) throw (exception::invalid_container_op) |
Protected Attributes | |
RecordStorage | m_fields |