SALOMEDS::UseCaseIterator Interface Reference

Interface of the UseCaseIterator. More...

import "SALOMEDS.idl";

Inheritance diagram for SALOMEDS::UseCaseIterator:

Public Member Functions
void	Init (in boolean allLevels)
	Activates the UseCaseIterator. More...
boolean	More ()
	Method More. More...
void	Next ()
	Passes the iterator to the next object. More...
SObject	Value ()
	Returns the SObject corresponding to the current object found by the Iterator. More...
void	Register ()
	Increase the reference count (mark as used by another object). More...
void	UnRegister ()
	Decrease the reference count (release by another object). More...
void	Destroy ()
	Obsolete, left for compatibility reasons only. More...

Detailed Description

Interface of the UseCaseIterator.

This interface contains a set of methods used for iteration over the objects in the use case.

Member Function Documentation

void SALOME::GenericObj::Destroy ( )

inherited

Obsolete, left for compatibility reasons only.

Use UnRegister() instead.

void SALOMEDS::UseCaseIterator::Init

(

in boolean

allLevels

)

Activates the UseCaseIterator.

Parameters

allLevels

If the value of this parameter is True the Iterator is activated for all subobjects.

boolean SALOMEDS::UseCaseIterator::More

(

)

Method More.

Returns

True if the UseCaseIterator finds one more object.

void SALOMEDS::UseCaseIterator::Next

(

)

Passes the iterator to the next object.

void SALOME::GenericObj::Register ( )

inherited

Increase the reference count (mark as used by another object).

void SALOME::GenericObj::UnRegister ( )

inherited

Decrease the reference count (release by another object).

SObject SALOMEDS::UseCaseIterator::Value

(

)

Returns the SObject corresponding to the current object found by the Iterator.