kpilot

PilotRecord Class Reference

An "uninterpreted" representation of the bits comprising a HH record. More...

#include <pilotRecord.h>

Inheritance diagram for PilotRecord:

List of all members.


Public Member Functions

const pi_buffer_t * buffer () const
char * data () const
PilotRecordoperator= (PilotRecord &orig)
 PilotRecord (PilotRecord *orig)
 PilotRecord (pi_buffer_t *buf, const PilotRecordBase *entry)
 PilotRecord (pi_buffer_t *buf, int attrib, int cat, recordid_t uid)
 PilotRecord (void *data, int length, int attrib, int cat, recordid_t uid) KDE_DEPRECATED
void setData (const char *data, int len)
void setData (pi_buffer_t *b)
int size () const
virtual QString textRepresentation () const
virtual ~PilotRecord ()

Static Public Member Functions

static void allocationInfo ()

Detailed Description

An "uninterpreted" representation of the bits comprising a HH record.

This binary blob only exposes the data via the data() and size() functions, and also exposes the common characteristics of all entries.

Definition at line 235 of file pilotRecord.h.


Constructor & Destructor Documentation

PilotRecord::PilotRecord ( void *  data,
int  length,
int  attrib,
int  cat,
recordid_t  uid 
)

Constructor.

Using the given data and length, create a record. Give it the additional attributes and category numbers; the UID is a HH unique ID for identifying records.

This constructor makes a copy of the data buffer (and owns that buffer).

Definition at line 74 of file pilotRecord.cc.

PilotRecord::PilotRecord ( pi_buffer_t *  buf,
int  attrib,
int  cat,
recordid_t  uid 
) [inline]

Constructor.

Using the given buffer buf (which carries its own data and length), create a record. Otherwise much like the above constructor except that this record assumes ownership of the buffer, and doesn't make an additional copy (In practice, this just saves copying around extra buffers).

Definition at line 252 of file pilotRecord.h.

PilotRecord::PilotRecord ( pi_buffer_t *  buf,
const PilotRecordBase entry 
) [inline]

Constructor.

Like the above, only take the attributes, category and id from the given entry.

Definition at line 264 of file pilotRecord.h.

virtual PilotRecord::~PilotRecord (  )  [inline, virtual]

Destructor.

Dispose of the buffers in the right form.

Definition at line 274 of file pilotRecord.h.

PilotRecord::PilotRecord ( PilotRecord orig  ) 

Constructor.

Copies the data from the orig record.

Definition at line 88 of file pilotRecord.cc.


Member Function Documentation

void PilotRecord::allocationInfo (  )  [static]

This is an interface for tracking down memory leaks in the use of PilotRecords (for those without valgrind).

Count the number of allocations and deallocations.

Definition at line 66 of file pilotRecord.cc.

const pi_buffer_t* PilotRecord::buffer (  )  const [inline]

Returns the data buffer associated with this record.

Definition at line 316 of file pilotRecord.h.

char* PilotRecord::data (  )  const [inline]

Retrieve the data buffer for this record.

Note that trying to change this data is fraught with peril -- especially trying to lengthen it.

See also:
setData

Definition at line 296 of file pilotRecord.h.

PilotRecord & PilotRecord::operator= ( PilotRecord orig  ) 

Assignment operator.

Makes a copy of the orig record.

Definition at line 100 of file pilotRecord.cc.

void PilotRecord::setData ( const char *  data,
int  len 
)

Sets the data for this record.

Makes a copy of the data buffer.

Definition at line 122 of file pilotRecord.cc.

void PilotRecord::setData ( pi_buffer_t *  b  )  [inline]

Set the data for this record.

Frees old data. Assumes ownership of the passed in buffer b.

Definition at line 321 of file pilotRecord.h.

int PilotRecord::size (  )  const [inline]

Returns the size of the data for this record.

Definition at line 309 of file pilotRecord.h.

QString PilotRecord::textRepresentation (  )  const [virtual]

Returns a text representation of this record.

Definition at line 54 of file pilotRecord.cc.


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