seq.c File Reference

Sequence. More...

#include "pm.h"

Defines
#define	__FILE_ID__   0x14
Functions
int8_t	seq_compare (pPmObj_t pobj1, pPmObj_t pobj2)
PmReturn_t	seq_getLength (pPmObj_t pobj, int16_t *r_index)
PmReturn_t	seq_getSubscript (pPmObj_t pobj, int16_t index, pPmObj_t *r_pobj)
PmReturn_t	seqiter_getNext (pPmObj_t pobj, pPmObj_t *r_pitem)
PmReturn_t	seqiter_new (pPmObj_t pobj, pPmObj_t *r_pobj)

---

Detailed Description

Sequence.

Functions that operate on sequences

---

Function Documentation

int8_t seq_compare	(	pPmObj_t	pobj1,
		pPmObj_t	pobj2
	)

Compares two sequences for equality

Parameters:

	pobj1	Ptr to first sequence.
	pobj2	Ptr to second sequence.

Returns:

C_SAME if the seuqences are equivalent, C_DIFFER otherwise.

PmReturn_t seq_getLength	(	pPmObj_t	pobj,
		int16_t *	r_index
	)

Returns the length of the sequence

Parameters:

	pobj	Ptr to sequence.
	r_index	Return arg, length of sequence

Returns:

Return status

PmReturn_t seq_getSubscript	(	pPmObj_t	pobj,
		int16_t	index,
		pPmObj_t *	r_pobj
	)

Returns the object from sequence[index]

Parameters:

	pobj	Ptr to sequence object to get object from
	index	Int index into the sequence
	r_pobj	Return arg, object from sequence

Returns:

Return status

PmReturn_t seqiter_getNext	(	pPmObj_t	pobj,
		pPmObj_t *	r_pitem
	)

Returns the next item from the sequence iterator object

Parameters:

	pobj	Ptr to sequence iterator.
	r_pitem	Return arg, pointer to next item from sequence.

Returns:

Return status.

PmReturn_t seqiter_new	(	pPmObj_t	pobj,
		pPmObj_t *	r_pobj
	)

Returns a new sequence iterator object

Parameters:

	pobj	Ptr to sequence.
	r_pitem	Return arg, pointer to sequence iterator object.

Returns:

Return status.