SALOMEDS::SComponentIterator Interface Reference

SComponentIterator interface More...

import "SALOMEDS.idl";

Inheritance diagram for SALOMEDS::SComponentIterator:

Public Member Functions
void	Init ()
	Activates the SComponentIterator. More...
boolean	More ()
	Method More. More...
void	Next ()
	Moves the iterator to the next SComponent in the list. More...
SComponent	Value ()
	Returns the SComponent corresponding to the current SComponent 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

SComponentIterator interface

This interface contains the methods allowing to iterate over all components in the list. The search is started from the first SComponent in the list.

Member Function Documentation

void SALOME::GenericObj::Destroy ( )

inherited

Obsolete, left for compatibility reasons only.

Use UnRegister() instead.

void SALOMEDS::SComponentIterator::Init

(

)

Activates the SComponentIterator.

boolean SALOMEDS::SComponentIterator::More

(

)

Method More.

Returns

True if there is one more SComponent in the list.

void SALOMEDS::SComponentIterator::Next

(

)

Moves the iterator to the next SComponent in the list.

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).

SComponent SALOMEDS::SComponentIterator::Value

(

)

Returns the SComponent corresponding to the current SComponent found by the iterator.

See example1 for an example of this method usage in batchmode of SALOME application.