liblas::VariableRecord Class Reference

Representation of variable-length record data. More...

#include <lasvariablerecord.hpp>

List of all members.

Public Member Functions

 VariableRecord ()
 Default constructor.
 VariableRecord (VariableRecord const &other)
 Copy constructor.
 ~VariableRecord ()
VariableRecordoperator= (VariableRecord const &rhs)
 Assignment operator.
uint16_t GetReserved () const
 Get record signature (LAS 1.0) or reserved bytes (LAS 1.1).
void SetReserved (uint16_t)
std::string GetUserId (bool pad) const
 Get identifier of user which created the record.
void SetUserId (std::string const &)
uint16_t GetRecordId () const
 Get identifier of record.
void SetRecordId (uint16_t)
uint16_t GetRecordLength () const
 Get record length after the header.
void SetRecordLength (uint16_t)
std::string GetDescription (bool pad) const
 Get text description of data in the record.
void SetDescription (std::string const &)
std::vector< uint8_t > const & GetData () const
 Get the data for this VLR.
void SetData (std::vector< uint8_t > const &)
bool equal (VariableRecord const &other) const
 Compare actual header object against the other.
uint32_t GetTotalSize () const
 Get the total size of the VLR in bytes.

Detailed Description

Representation of variable-length record data.


Constructor & Destructor Documentation

liblas::VariableRecord::VariableRecord (  ) 

Default constructor.

Zero-initialization of record data.

Exceptions:
No throw
liblas::VariableRecord::VariableRecord ( VariableRecord const &  other  ) 

Copy constructor.

Construction of new record object as a copy of existing one.

Exceptions:
No throw
liblas::VariableRecord::~VariableRecord (  ) 

Member Function Documentation

bool liblas::VariableRecord::equal ( VariableRecord const &  other  )  const

Compare actual header object against the other.

Exceptions:
No throw

Referenced by liblas::operator==().

Here is the caller graph for this function:

std::vector<uint8_t> const& liblas::VariableRecord::GetData (  )  const

Get the data for this VLR.

std::string liblas::VariableRecord::GetDescription ( bool  pad  )  const

Get text description of data in the record.

The character data is up to 32 bytes long.

Exceptions:
No throw
uint16_t liblas::VariableRecord::GetRecordId (  )  const

Get identifier of record.

The record ID is closely related to the user ID.

Exceptions:
No throw
uint16_t liblas::VariableRecord::GetRecordLength (  )  const

Get record length after the header.

Exceptions:
No throw
uint16_t liblas::VariableRecord::GetReserved (  )  const

Get record signature (LAS 1.0) or reserved bytes (LAS 1.1).

Exceptions:
No throw
uint32_t liblas::VariableRecord::GetTotalSize (  )  const

Get the total size of the VLR in bytes.

std::string liblas::VariableRecord::GetUserId ( bool  pad  )  const

Get identifier of user which created the record.

The character data is up to 16 bytes long.

Exceptions:
No throw
VariableRecord& liblas::VariableRecord::operator= ( VariableRecord const &  rhs  ) 

Assignment operator.

Construction and initializition of record object by assignment of another one.

Exceptions:
No throw
void liblas::VariableRecord::SetData ( std::vector< uint8_t > const &   ) 
void liblas::VariableRecord::SetDescription ( std::string const &   ) 
void liblas::VariableRecord::SetRecordId ( uint16_t   ) 
void liblas::VariableRecord::SetRecordLength ( uint16_t   ) 
void liblas::VariableRecord::SetReserved ( uint16_t   ) 
void liblas::VariableRecord::SetUserId ( std::string const &   ) 

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

Generated on Fri Jul 30 19:30:13 2010 for libLAS API Reference by  doxygen 1.6.1