FemtoScan Online SDK Documentation

Home :: FsOnlineSDK :: fmutl :: SPMDataStream classes

class dimension

? ^ 
    extends FSAxesContainer as public

Dimension implementation.

This class is used for dimension description. Dimension has associated length (number of points) and one or more alternate axes.

Source:
../fmutl/SPMDataStream.h:180
Author:
ATC
Version:
1.0
See Also:
SPMDataStream::axis
Friend:
class SPMDataStream undocumented

Contents

^ 
EntityTypeScopeShort Description
~dimensiondestructor public Standart destructor.
dimensionconstructor public Standart constructor.
dimensionconstructor public Copy constructor.
get_lengthmethod public Get dimension length.
operator =operator public Copy operator.
set_lengthmethod public Set dimension length.

destructor ~dimension

? ^  > 
Standart destructor.
Source:
../fmutl/SPMDataStream.h:210
Code:
public ~ dimension ( )

constructor dimension

? ^  < > 
Standart constructor.
Source:
../fmutl/SPMDataStream.h:189
Code:
public dimension ( ) : length ( 0 )

constructor dimension

? ^  < > 
Copy constructor.
Source:
../fmutl/SPMDataStream.h:198
Param:
X object to copy.
Code:
public dimension ( const dimension & X ) : FSAxesContainer ( X ) , length ( X . length )

method get_length

? ^  < > 
Get dimension length.
Source:
../fmutl/SPMDataStream.h:216
Returns:
number of points along dimension axis.
Code:
public unsigned get_length ( ) const

operator =

? ^  < > 
Copy operator.
Source:
../fmutl/SPMDataStream.h:205
Param:
X object to copy.
Returns:
*this.
Code:
public FMUTL_API dimension & operator = ( const dimension & X )

method set_length

? ^  < > 
Set dimension length.

When changing dimension length, consider revising stride values.

Source:
../fmutl/SPMDataStream.h:223
Param:
l new length.
Code:
public void set_length ( unsigned l )

(C) Advanced Technologies Center, 2002-2006
For support contact us at fsdev@nanoscopy.net