Seismic Drive Client API
Public Member Functions | Friends | List of all members
seismicdrive::SDGenericDatasetBasicObjectIterator Class Reference

This class is a generic Dataset class object iterator. More...

#include <SDGenericDataset.h>

Public Member Functions

 SDGenericDatasetBasicObjectIterator ()
 Default constructor. More...
 
 ~SDGenericDatasetBasicObjectIterator ()
 Destructor. More...
 
 SDGenericDatasetBasicObjectIterator (SDGenericDatasetBasicObjectIterator &&rhs) noexcept
 Move Constructor. More...
 
SDGenericDatasetBasicObjectIteratoroperator= (SDGenericDatasetBasicObjectIterator &&rhs) noexcept
 Move Assignment Operator. More...
 
 SDGenericDatasetBasicObjectIterator (const SDGenericDatasetBasicObjectIterator &rhs)
 Copy Constructor. More...
 
SDGenericDatasetBasicObjectIteratoroperator= (const SDGenericDatasetBasicObjectIterator &rhs)
 Copy Assignment Operator. More...
 
bool hasNext ()
 Checks if more SDGenericDatasetBasicObjectInfo objects are available. More...
 
SDGenericDatasetBasicObjectInfo next ()
 Returns the next SDGenericDatasetBasicObjectInfo object. More...
 

Friends

class SDGenericDataset
 
class SDGenericDatasetTest
 

Detailed Description

This class is a generic Dataset class object iterator.

This class is an iterator used to iterate through SDGenericDatasetBasicObjectInfo objects.

Constructor & Destructor Documentation

◆ SDGenericDatasetBasicObjectIterator() [1/3]

seismicdrive::SDGenericDatasetBasicObjectIterator::SDGenericDatasetBasicObjectIterator ( )

Default constructor.

This constructor creates a SDGenericDatasetBasicObjectIterator object and initialize whether it has a next SDGenericDatasetBasicObjectInfo object.

◆ ~SDGenericDatasetBasicObjectIterator()

seismicdrive::SDGenericDatasetBasicObjectIterator::~SDGenericDatasetBasicObjectIterator ( )

Destructor.

This destructor deletes the SDGenericDatasetBasicObjectIterator object and free up the memory after it goes out of scope.

◆ SDGenericDatasetBasicObjectIterator() [2/3]

seismicdrive::SDGenericDatasetBasicObjectIterator::SDGenericDatasetBasicObjectIterator ( SDGenericDatasetBasicObjectIterator &&  rhs)
noexcept

Move Constructor.

This constructor moves the SDGenericDatasetBasicObjectIterator object from the source to the new object and destroy the source object.

◆ SDGenericDatasetBasicObjectIterator() [3/3]

seismicdrive::SDGenericDatasetBasicObjectIterator::SDGenericDatasetBasicObjectIterator ( const SDGenericDatasetBasicObjectIterator rhs)

Copy Constructor.

This constructor makes a copy of the SDGenericDatasetBasicObjectIterator object from the source to the new object without modifying the source object.

Member Function Documentation

◆ hasNext()

bool seismicdrive::SDGenericDatasetBasicObjectIterator::hasNext ( )

Checks if more SDGenericDatasetBasicObjectInfo objects are available.

This method checks to see if the current SDGenericDatasetBasicObjectInfo has a following object of the name type.

Returns
true if the object has a next object and false if the current object is the last one

◆ next()

SDGenericDatasetBasicObjectInfo seismicdrive::SDGenericDatasetBasicObjectIterator::next ( )

Returns the next SDGenericDatasetBasicObjectInfo object.

This method creates a new SDGenericDatasetBasicObjectInfo object, assigns its name and size from the next object and return that object that is a copy from the next object.

Returns
the next SDGenericDatasetBasicObjectInfo object that follows the current object if it exists.

◆ operator=() [1/2]

SDGenericDatasetBasicObjectIterator& seismicdrive::SDGenericDatasetBasicObjectIterator::operator= ( SDGenericDatasetBasicObjectIterator &&  rhs)
noexcept

Move Assignment Operator.

Same functionality as the move constructor.

◆ operator=() [2/2]

SDGenericDatasetBasicObjectIterator& seismicdrive::SDGenericDatasetBasicObjectIterator::operator= ( const SDGenericDatasetBasicObjectIterator rhs)

Copy Assignment Operator.

Same functionality as the copy constructor.

Friends And Related Function Documentation

◆ SDGenericDataset

friend class SDGenericDataset
friend

◆ SDGenericDatasetTest

friend class SDGenericDatasetTest
friend

The documentation for this class was generated from the following file: