AURobotServers  4
Public Member Functions | Private Attributes | List of all members
UMapGmk Class Reference

#include <umapgmk.h>

Public Member Functions

void copy (UMapGmk *source)
 
float getBlockSize ()
 
unsigned long getID ()
 
int getSize ()
 
bool load (Uxml3D *fxmap, char *name=NULL)
 
void print ()
 
bool save (Uxml3D *fxmap, const char *name=NULL)
 
void setBlock (const float size)
 
void setFrame (const int size)
 
void setID (const unsigned long ID)
 
 UMapGmk ()
 
 UMapGmk (const unsigned long ID, const float size, const int frame)
 
 ~UMapGmk ()
 

Private Attributes

float blockSize
 
unsigned long code
 
int frameSize
 

Detailed Description

Class that holds additional information for a map object regarding guidemark information. size, number etc.

Constructor & Destructor Documentation

UMapGmk::UMapGmk ( )

Constructor

UMapGmk::UMapGmk ( const unsigned long  ID,
const float  size,
const int  frame 
)
UMapGmk::~UMapGmk ( )

Destructor

Member Function Documentation

void UMapGmk::copy ( UMapGmk source)
inline

Set guidemark info as a copy of the source data.

float UMapGmk::getBlockSize ( )
inline

Get size of each block in GMK frame.

References blockSize.

unsigned long UMapGmk::getID ( )
inline

Get code

References code.

int UMapGmk::getSize ( )
inline

Get number of blocks each side of GMK frame.

References frameSize.

bool UMapGmk::load ( Uxml3D *  fxmap,
char *  name = NULL 
)

Load guidemark info - ex position - from a xml-class object. Returns true if loaded. Errors are reported to UxmlFile-class.

Referenced by setFrame().

void UMapGmk::print ( )

Print guidemark information to console

Referenced by setFrame().

bool UMapGmk::save ( Uxml3D *  fxmap,
const char *  name = NULL 
)

Save guidemark infor in html-like format. Returns true if saved.

Referenced by setFrame().

void UMapGmk::setBlock ( const float  size)
inline

Set block size (nformation only).

References blockSize.

void UMapGmk::setFrame ( const int  size)
inline

Set GMK framesize

References frameSize, load(), print(), and save().

void UMapGmk::setID ( const unsigned long  ID)
inline

Set (or change) ID

References code.

Member Data Documentation

float UMapGmk::blockSize
private

Size of each frame block - im meter. e.g. 0.02 for 2 cm blocks

Referenced by UMapZGmk::getBlock(), getBlockSize(), and setBlock().

unsigned long UMapGmk::code
private

Guidemark code (in short form (32 but integer))

Referenced by UMapZGmk::getBlock(), getID(), UMapZGmk::getID(), and setID().

int UMapGmk::frameSize
private

Number of blocks each side ofGMK

Referenced by UMapZGmk::getFrame(), getSize(), and setFrame().


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