Basic Image AlgorithmS Library  2.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Public Attributes | Related Functions | List of all members
BIAS::AppData Class Reference

this is a chunk of metadata, also see MetaData More...

#include <Base/Image/MetaData.hh>

+ Collaboration diagram for BIAS::AppData:

Public Types

enum  TAppData {
  MD_PMatrix =0, MD_Orientation =1, MD_TimeStamp =2, MD_PTU_Data =3,
  MD_Inertial_Sensor =4, MD_ASCII_DATA =5, MD_RMatrix =6, MD_KMatrix =7,
  MD_CVector =8, MD_HomgPoint2D =9, MD_Invalid =10, MD_UUID =11,
  MD_USE_ASCII =12, MD_Focal_Length =14, MD_GPS_Data =15, MD_Projection = 16,
  MD_RefUUID =17, MD_PMD_DataDesc =18
}
 Type of AppData. More...
 

Public Member Functions

 AppData ()
 
 AppData (const AppData &app)
 
int CheckFormat ()
 checks if stag and sdata have the correct format More...
 
void Clear ()
 Resets all members. More...
 
AppDataoperator= (const AppData &app)
 
 ~AppData ()
 

Public Attributes

char * data
 pointer to block of data More...
 
int length
 number of bytes used by the data block More...
 
std::string sdata
 the data as given in ascii meta data More...
 
std::string stag
 the tag as given in ascii meta data More...
 
enum TAppData tag
 The tag defines the type of data, e.g. More...
 

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &os, const AppData &ad)
 
std::istream & operator>> (std::istream &is, AppData &ta)
 

Detailed Description

this is a chunk of metadata, also see MetaData

AppData can hold the meta datum either in ascii format (in this case AppData.tag is set to AppData::MD_USE_ASCII) or in binary format (in this case AppData.tag is set to anything except AppData::MD_USE_ASCII or AppData::MD_Invalid)

Basic operators for reading, writing and assignig exist

Author
woelk 11/2003
Examples:
ExampleMetaData.cpp, ExampleParabola.cpp, and ExampleTrackerBase.cpp.

Definition at line 49 of file MetaData.hh.

Member Enumeration Documentation

Type of AppData.

If set to MD_USE_ASCII, AppData.tag, AppData.length and AppData.data are invalid. AppData.stag and AppData.sdata should be used.

If set to anything else except MD_Invalid, AppData.tag, AppData.length and AppData.data are valid. AppData.stag and AppData.sdata should not be used in this case.

The string tag AppData.stag can be generated from the enum id by removing 'MD_', substituting underscores with blanks and bracketing with '#[' and ']'.

For example tag=MD_Inertial_Sensor evolves to stag="#[Inertial Sensor]".

!! MD_ASCII_DATA is deprecated and should no longer be used. !! It is keept her for compatibility reasons.

Enumerator
MD_PMatrix 
MD_Orientation 
MD_TimeStamp 
MD_PTU_Data 
MD_Inertial_Sensor 
MD_ASCII_DATA 
MD_RMatrix 
MD_KMatrix 
MD_CVector 
MD_HomgPoint2D 
MD_Invalid 
MD_UUID 
MD_USE_ASCII 
MD_Focal_Length 
MD_GPS_Data 
MD_Projection 
MD_RefUUID 
MD_PMD_DataDesc 

Definition at line 72 of file MetaData.hh.

Constructor & Destructor Documentation

AppData::AppData ( )

Definition at line 40 of file MetaData.cpp.

AppData::~AppData ( )

Definition at line 46 of file MetaData.cpp.

AppData::AppData ( const AppData app)

Definition at line 51 of file MetaData.cpp.

Member Function Documentation

int AppData::CheckFormat ( )

checks if stag and sdata have the correct format

Definition at line 81 of file MetaData.cpp.

Referenced by BIAS::MetaData::Add().

void AppData::Clear ( )

Resets all members.

Definition at line 72 of file MetaData.cpp.

Referenced by BIAS::MetaData::Add(), and BIAS::MetaData::Find().

AppData & AppData::operator= ( const AppData app)

Definition at line 57 of file MetaData.cpp.

References data, length, sdata, stag, and tag.

Friends And Related Function Documentation

std::ostream & operator<< ( std::ostream &  os,
const AppData ad 
)
related
std::istream & operator>> ( std::istream &  is,
AppData ta 
)
related

Member Data Documentation

char* BIAS::AppData::data
int BIAS::AppData::length
std::string BIAS::AppData::sdata
std::string BIAS::AppData::stag

the tag as given in ascii meta data

Examples:
ExampleMetaData.cpp, ExampleParabola.cpp, and ExampleTrackerBase.cpp.

Definition at line 100 of file MetaData.hh.

Referenced by BIAS::MetaData::Add(), and operator=().

enum TAppData BIAS::AppData::tag

The tag defines the type of data, e.g.

MD_PMatrix is set to MD_USE_ASCII if ascii data is used. See TAppData.

Examples:
ExampleParabola.cpp, and ExampleTrackerBase.cpp.

Definition at line 94 of file MetaData.hh.

Referenced by BIAS::MetaData::Add(), BIAS::IOUtils::GetProjection(), BIAS::ImageIO::ImportImage(), operator=(), and BIAS::Camera< StorageType >::ParseMetaData().


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