FemtoScan Online SDK Documentation

Axis implementation.

This class is used for axis description. Axis has start value, scale (point size), and units.

Source:

../fmutl/SPMDataStream.h:15

Author:

ATC

Version:

1.0

Entity	Type	Scope	Short Description
~FSAxis	destructor	public	Standart destructor.
FSAxis	constructor	public	Standart constructor.
FSAxis	constructor	public	Copy constructor.
convert_units	method	public	Convert axis to the compatible units
get_scale	method	public	Get axis scale value.
get_start	method	public	Get axis start value.
get_units	method	public	Get axis units.
operator =	operator	public	Copy operator.
set_scale	method	public	Set axis scale value.
set_start	method	public	Set axis start value.
set_units	method	public	Set axis units.

Standart destructor.

Source:

../fmutl/SPMDataStream.h:44

Code:

public FMUTL_API virtual ~ FSAxis ( )

Standart constructor.

Source:

../fmutl/SPMDataStream.h:20

Code:

public FMUTL_API FSAxis (

)

Copy constructor.

Source:

../fmutl/SPMDataStream.h:26

Param:

X	object to copy.

Code:

public FMUTL_API FSAxis (

const FSAxis & X )

Convert axis to the compatible units

Source:

../fmutl/SPMDataStream.h:86

Param:

u

new units

Code:

public FMUTL_API bool convert_units (

const char * u )

Get axis scale value.

Source:

../fmutl/SPMDataStream.h:62

Returns:

scale value.

Code:

public double get_scale (

) const

Get axis start value.

Source:

../fmutl/SPMDataStream.h:50

Returns:

start value.

Code:

public double get_start (

) const

Get axis units.

Source:

../fmutl/SPMDataStream.h:74

Returns:

units as zero-terminated string.

Code:

public const char * get_units (

) const

Copy operator.

Source:

../fmutl/SPMDataStream.h:39

Param:

X	object to copy.

Returns:

*this.

Code:

public FSAxis & operator = (

const FSAxis & X )

Set axis scale value.

Source:

../fmutl/SPMDataStream.h:68

Param:

s	new scale value.

Code:

public void set_scale (

double s )

Set axis start value.

Source:

../fmutl/SPMDataStream.h:56

Param:

s	new start value.

Code:

public void set_start (

double s )

Set axis units.

Source:

../fmutl/SPMDataStream.h:80

Param:

u	new units.

Code:

public FMUTL_API void set_units (

const char * u )

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