org.asam.ods

Interface InstanceElementIteratorOperations

All Known Subinterfaces:

InstanceElementIterator

All Known Implementing Classes:

_InstanceElementIteratorStub, InstanceElementIterator, InstanceElementIterator, InstanceElementIteratorPOA

public interface InstanceElementIteratorOperations

The ASAM ODS instance element iterator interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() (15001) Destroy the iterator and free the associated memory.
int	getCount() (15002) Get the total number of elements accessible by the iterator.
InstanceElement[]	nextN(int how_many) (15003) Get the next n elements from the sequence.
InstanceElement	nextOne() (15004) Get the next element from the sequence.
void	reset() (15005) Reset the pointer in the element sequence to the first element.

Method Detail

destroy

void destroy()
             throws AoException

(15001) Destroy the iterator and free the associated memory.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getCount

int getCount()
             throws AoException

(15002) Get the total number of elements accessible by the iterator.

Returns:

The number of elements accessible by the iterator.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

nextN

InstanceElement[] nextN(int how_many)
                        throws AoException

(15003) Get the next n elements from the sequence. In case there are less elements available than requested, only as many as are available will be returned; if there is none left an empty list is returned.

Parameters:

how_many - The number of requested elements.

Returns:

The next n instance elements from the instance sequence.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

nextOne

InstanceElement nextOne()
                        throws AoException

(15004) Get the next element from the sequence. In case no element is available a NIL object is returned.

Returns:

The next instance element from the instance sequence.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

reset

void reset()
           throws AoException

(15005) Reset the pointer in the element sequence to the first element.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE