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

This class holds generic dataset object info. More...

#include <SDGenericDataset.h>

Public Member Functions

 SDGenericDatasetBasicObjectInfo ()
 Default constructor. More...
 
 ~SDGenericDatasetBasicObjectInfo ()
 Destructor. More...
 
 SDGenericDatasetBasicObjectInfo (SDGenericDatasetBasicObjectInfo &&rhs) noexcept
 Move Constructor. More...
 
SDGenericDatasetBasicObjectInfooperator= (SDGenericDatasetBasicObjectInfo &&rhs) noexcept
 Move Assignment Operator. More...
 
 SDGenericDatasetBasicObjectInfo (const SDGenericDatasetBasicObjectInfo &rhs)
 Copy Constructor. More...
 
SDGenericDatasetBasicObjectInfooperator= (const SDGenericDatasetBasicObjectInfo &rhs)
 Copy Assignment Operator. More...
 
std::string getName () const
 Gets the name of a SDGenericDatasetBasicObjectInfo object. More...
 
long long getSize () const
 Gets the size of a SDGenericDatasetBasicObjectInfo object. More...
 
void setName (const std::string &objname)
 Sets the name of a SDGenericDatasetBasicObjectInfo object. More...
 
void setSize (long long objsize)
 Sets the size of a SDGenericDatasetBasicObjectInfo object. More...
 

Detailed Description

This class holds generic dataset object info.

This class stores general information about the dataset: the name and size of the dataset.

Constructor & Destructor Documentation

◆ SDGenericDatasetBasicObjectInfo() [1/3]

seismicdrive::SDGenericDatasetBasicObjectInfo::SDGenericDatasetBasicObjectInfo ( )

Default constructor.

This constructor creates a SDGenericDatasetBasicObjectInfo object and initialize its name and size.

◆ ~SDGenericDatasetBasicObjectInfo()

seismicdrive::SDGenericDatasetBasicObjectInfo::~SDGenericDatasetBasicObjectInfo ( )

Destructor.

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

◆ SDGenericDatasetBasicObjectInfo() [2/3]

seismicdrive::SDGenericDatasetBasicObjectInfo::SDGenericDatasetBasicObjectInfo ( SDGenericDatasetBasicObjectInfo &&  rhs)
noexcept

Move Constructor.

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

◆ SDGenericDatasetBasicObjectInfo() [3/3]

seismicdrive::SDGenericDatasetBasicObjectInfo::SDGenericDatasetBasicObjectInfo ( const SDGenericDatasetBasicObjectInfo rhs)

Copy Constructor.

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

Member Function Documentation

◆ getName()

std::string seismicdrive::SDGenericDatasetBasicObjectInfo::getName ( ) const

Gets the name of a SDGenericDatasetBasicObjectInfo object.

This method is an accessor used to get the name of a SDGenericDatasetBasicObjectInfo object

Returns
the name of the SDGenericDatasetBasicObjectInfo object

◆ getSize()

long long seismicdrive::SDGenericDatasetBasicObjectInfo::getSize ( ) const

Gets the size of a SDGenericDatasetBasicObjectInfo object.

This method is an accessor used to get the size of a SDGenericDatasetBasicObjectInfo object

Returns
the size of the SDGenericDatasetBasicObjectInfo object

◆ operator=() [1/2]

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

Move Assignment Operator.

Same functionality as the move constructor.

◆ operator=() [2/2]

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

Copy Assignment Operator.

Same functionality as the copy constructor.

◆ setName()

void seismicdrive::SDGenericDatasetBasicObjectInfo::setName ( const std::string &  objname)

Sets the name of a SDGenericDatasetBasicObjectInfo object.

This method is a mutator used to set the name of a SDGenericDatasetBasicObjectInfo object

Parameters
objnameis the object name
Returns
Void

◆ setSize()

void seismicdrive::SDGenericDatasetBasicObjectInfo::setSize ( long long  objsize)

Sets the size of a SDGenericDatasetBasicObjectInfo object.

This method is a mutator used to set the size of a SDGenericDatasetBasicObjectInfo object

Parameters
objsizeis the object size
Returns
Void

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