DynaRecord Class Reference

#include <dynashell_recording.h>

Classes
struct	FieldTuple_T
	Record Field Tuple Structure Type. More...

Public Member Functions
	DynaRecord ()
	Default constructor.
virtual	~DynaRecord ()
	Default destructor.
int	GetFieldCount () const
	Get the current number of field tuples in record. More...
void	ResetFieldCount ()
	Reset the field count to zero.
virtual int	AddField (int nPos, int nSpeed)
	Add a field tuple to the record. More...
DynaRecord &	operator= (const DynaRecord &rhs)
	Assignment operator. More...
FieldTuple_T const &	operator[] (const int nFldNum) const
	Subscript operator. More...

Static Public Member Functions
static const bool	NaF (FieldTuple_T &field)
	Test if field is 'Not a Field'. More...

Static Public Attributes
static const int	END = -1
	past-the-end mark
static const FieldTuple_T	NoField = {INT_MAX, INT_MAX}

Protected Attributes
int	m_nFieldCnt
	number of field tuples
FieldTuple_T	m_field [DYNA_ID_NUMOF]
	one record of field data

Friends
class	DynaRecording

Detailed Description

Dynamixel record.

Definition at line 93 of file dynashell_recording.h.

Member Function Documentation

int DynaRecord::AddField ( int  nPos, int  nSpeed  )

virtual

Add a field tuple to the record.

Parameters

nPos	Servo position.
nSpeed	Servo speed.

Returns

On success, returns the newly added field number.
On failure, DynaRecord::END is returned.

Definition at line 94 of file dynashell_recording.cxx.

References DYNA_ID_NUMOF, and END.

{
  if( m_nFieldCnt < DYNA_ID_NUMOF )
  {
    int nFldNum = m_nFieldCnt;
    m_field[nFldNum].m_nPos   = nPos;
    m_field[nFldNum].m_nSpeed = nSpeed;
    m_nFieldCnt++;
    return nFldNum;
  }
  else
  {
    return DynaRecord::END;
  }
}

int DynaRecord::GetFieldCount ( ) const

inline

Get the current number of field tuples in record.

Returns

Field tuple count.

Definition at line 128 of file dynashell_recording.h.

  {
    return m_nFieldCnt;
  }

static const bool DynaRecord::NaF ( FieldTuple_T &  field )

inlinestatic

Test if field is 'Not a Field'.

Parameters

field

Field tuple to test.

Returns

Returns true or false.

Definition at line 150 of file dynashell_recording.h.

References DynaRecord::FieldTuple_T::m_nPos, DynaRecord::FieldTuple_T::m_nSpeed, and NoField.

  {
    return  (field.m_nPos   == DynaRecord::NoField.m_nPos) &&
            (field.m_nSpeed == DynaRecord::NoField.m_nSpeed);
  }

DynaRecord & DynaRecord::operator=

(

const DynaRecord &

rhs

)

Assignment operator.

Parameters

rhs	Right hand side.

Returns

Reference to this.

Definition at line 117 of file dynashell_recording.cxx.

References m_field, m_nFieldCnt, and NoField.

{
  int   i;

  m_nFieldCnt = rhs.m_nFieldCnt;

  for(i=0; i<m_nFieldCnt; ++i)
  {
    m_field[i] = rhs.m_field[i];
  }

  return *this;
}

FieldTuple_T const& DynaRecord::operator[] ( const int  nFldNum ) const

inline

Subscript operator.

Parameters

nFldNum

Field number subscript.

Returns

Field tuple.

Definition at line 165 of file dynashell_recording.h.

  {
    return nFldNum < m_nFieldCnt? m_field[nFldNum]: NoField;
  }

Member Data Documentation

const DynaRecord::FieldTuple_T DynaRecord::NoField = {INT_MAX, INT_MAX}

static

'Not a Field' field.

Definition at line 108 of file dynashell_recording.h.

Referenced by DynaRecording::GetField(), NaF(), and operator=().

---

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

• dynashell/dynashell_recording.h
• dynashell/dynashell_recording.cxx