liblas::Dimension Class Reference

Dimension definition. More...

#include <dimension.hpp>

Collaboration diagram for liblas::Dimension:

Public Member Functions
	Dimension (std::string const &name, std::size_t size_in_bits)
Dimension &	operator= (Dimension const &rhs)
	Dimension (Dimension const &other)
bool	operator== (const Dimension &other) const
bool	operator!= (const Dimension &other) const
virtual	~Dimension ()
std::string const &	GetName () const
std::size_t	GetBitSize () const
	bits, total logical size of point record, including any custom dimensions More...
std::size_t	GetByteSize () const
	bytes, physical/serialisation size of record More...
std::size_t	GetByteOffset () const
	The byte location to start reading/writing point data from in a composited schema. More...
void	SetByteOffset (std::size_t v)
std::size_t	GetBitOffset () const
	The bit location within the byte to start reading data. More...
void	SetBitOffset (std::size_t v)
bool	IsRequired () const
	Is this dimension required by PointFormatName. More...
void	IsRequired (bool v)
bool	IsActive () const
	Is this dimension being used. More...
void	IsActive (bool v)
std::string	GetDescription () const
void	SetDescription (std::string const &v)
bool	IsNumeric () const
	Is this dimension a numeric dimension. More...
void	IsNumeric (bool v)
bool	IsSigned () const
	Does this dimension have a sign? Only applicable to dimensions with IsNumeric == true. More...
void	IsSigned (bool v)
bool	IsInteger () const
	Does this dimension interpret to an integer? Only applicable to dimensions with IsNumeric == true. More...
void	IsInteger (bool v)
double	GetMinimum () const
	The minimum value of this dimension as a double. More...
void	SetMinimum (double min)
double	GetMaximum () const
	The maximum value of this dimension as a double. More...
void	SetMaximum (double max)
uint32_t	GetPosition () const
	The index position of the index. More...
void	SetPosition (uint32_t v)
double	GetScale () const
	The scaling value for this dimension as a double. More...
void	SetScale (double v)
double	GetOffset () const
	The offset value for this dimension. More...
void	SetOffset (double v)
bool	IsFinitePrecision () const
	If true, this dimension uses scale/offset values. More...
void	IsFinitePrecision (bool v)
bool	operator< (Dimension const &dim) const
bool	operator> (Dimension const &dim) const
liblas::property_tree::ptree	GetPTree () const

Detailed Description

Dimension definition.

Constructor & Destructor Documentation

liblas::Dimension::Dimension	(	std::string const &	name,
		std::size_t	size_in_bits
	)

liblas::Dimension::Dimension

(

Dimension const &

other

)

virtual liblas::Dimension::~Dimension ( )

inlinevirtual

Member Function Documentation

std::size_t liblas::Dimension::GetBitOffset ( ) const

inline

The bit location within the byte to start reading data.

liblas::Schema will set these values for you when liblas::Dimension are added to the liblas::Schema. This value will be 0 for dimensions that are composed of entire bytes.

std::size_t liblas::Dimension::GetBitSize ( ) const

inline

bits, total logical size of point record, including any custom dimensions

std::size_t liblas::Dimension::GetByteOffset ( ) const

inline

The byte location to start reading/writing point data from in a composited schema.

liblas::Schema will set these values for you when liblas::Dimension are added to the liblas::Schema.

std::size_t liblas::Dimension::GetByteSize

(

)

const

bytes, physical/serialisation size of record

std::string liblas::Dimension::GetDescription ( ) const

inline

double liblas::Dimension::GetMaximum ( ) const

inline

The maximum value of this dimension as a double.

double liblas::Dimension::GetMinimum ( ) const

inline

The minimum value of this dimension as a double.

std::string const& liblas::Dimension::GetName ( ) const

inline

double liblas::Dimension::GetOffset ( ) const

inline

The offset value for this dimension.

Usually zero, but it can be set to any value in combination with the scale to allow for more expressive ranges.

uint32_t liblas::Dimension::GetPosition ( ) const

inline

The index position of the index.

In a standard ePointFormat0 data record, the X dimension would have a position of 0, while the Y dimension would have a position of 1, for example.

liblas::property_tree::ptree liblas::Dimension::GetPTree

(

)

const

double liblas::Dimension::GetScale ( ) const

inline

The scaling value for this dimension as a double.

This should be positive or negative powers of ten.

bool liblas::Dimension::IsActive ( ) const

inline

Is this dimension being used.

A dimension with IsActive false may exist as a placeholder in PointFormatName-specified dimensions, but have their IsActive flag set to false. In this case, those values may be disregarded.

Referenced by liblas::SetActive::operator()().

void liblas::Dimension::IsActive ( bool  v )

inline

bool liblas::Dimension::IsFinitePrecision ( ) const

inline

If true, this dimension uses scale/offset values.

void liblas::Dimension::IsFinitePrecision ( bool  v )

inline

bool liblas::Dimension::IsInteger ( ) const

inline

Does this dimension interpret to an integer? Only applicable to dimensions with IsNumeric == true.

void liblas::Dimension::IsInteger ( bool  v )

inline

bool liblas::Dimension::IsNumeric ( ) const

inline

Is this dimension a numeric dimension.

Dimensions with IsNumeric == false are considered generic bit/byte fields/

void liblas::Dimension::IsNumeric ( bool  v )

inline

bool liblas::Dimension::IsRequired ( ) const

inline

Is this dimension required by PointFormatName.

Referenced by liblas::SetRequired::operator()().

void liblas::Dimension::IsRequired ( bool  v )

inline

bool liblas::Dimension::IsSigned ( ) const

inline

Does this dimension have a sign? Only applicable to dimensions with IsNumeric == true.

void liblas::Dimension::IsSigned ( bool  v )

inline

bool liblas::Dimension::operator!= ( const Dimension &  other ) const

inline

bool liblas::Dimension::operator< ( Dimension const &  dim ) const

inline

Dimension& liblas::Dimension::operator=

(

Dimension const &

rhs

)

bool liblas::Dimension::operator==

(

const Dimension &

other

)

const

bool liblas::Dimension::operator> ( Dimension const &  dim ) const

inline

void liblas::Dimension::SetBitOffset ( std::size_t  v )

inline

void liblas::Dimension::SetByteOffset ( std::size_t  v )

inline

void liblas::Dimension::SetDescription ( std::string const &  v )

inline

void liblas::Dimension::SetMaximum ( double  max )

inline

void liblas::Dimension::SetMinimum ( double  min )

inline

void liblas::Dimension::SetOffset ( double  v )

inline

void liblas::Dimension::SetPosition ( uint32_t  v )

inline

void liblas::Dimension::SetScale ( double  v )

inline

---

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

• /mnt/d/libLAS.wsl/include/liblas/dimension.hpp