seq.h File Reference

Sequence Header. More...

Go to the source code of this file.

Classes
struct	PmSeqIter_s
Typedefs
typedef struct PmSeqIter_s	PmSeqIter_t
typedef struct PmSeqIter_s *	pPmSeqIter_t
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 Header.

---

Typedef Documentation

typedef struct PmSeqIter_s PmSeqIter_t

Sequence Iterator Object

Instances of this object are created by GET_ITER and used by FOR_ITER. Stores a pointer to a sequence and an index int16_t.

---

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.