libcrn  3.9.5
A document image processing library
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Friends | List of all members
Description Class Reference

Alto global description. More...

#include <CRNAltoDescription.hpp>

+ Inheritance diagram for Description:
+ Collaboration diagram for Description:

Public Types

enum  MeasurementUnit { MeasurementUnit::Undef = 0, MeasurementUnit::Pixel, MeasurementUnit::MM, MeasurementUnit::Inch }
 

Public Member Functions

 Description (const Description &)=delete
 
 Description (Description &&)=default
 
virtual ~Description () override
 
Descriptionoperator= (const Description &)=delete
 
Descriptionoperator= (Description &&)=default
 
Option< MeasurementUnitGetMeasurementUnit ()
 Returns the measurement unit of all metrics in the Alto. More...
 
Option< StringUTF8 > GetFilename ()
 Returns the filename of the image described by the Alto. More...
 

Friends

class Root
 

Detailed Description

Alto global description.

Author
Yann LEYDIER

Definition at line 30 of file CRNAltoDescription.hpp.

Member Enumeration Documentation

Enumerator
Undef 
Pixel 
MM 
Inch 

Definition at line 39 of file CRNAltoDescription.hpp.

Constructor & Destructor Documentation

Description::Description ( const Description )
delete
Description::Description ( Description &&  )
default
virtual Description::~Description ( )
inlineoverridevirtual

Definition at line 35 of file CRNAltoDescription.hpp.

Member Function Documentation

Option<StringUTF8> Description::GetFilename ( )

Returns the filename of the image described by the Alto.

Option<MeasurementUnit> Description::GetMeasurementUnit ( )

Returns the measurement unit of all metrics in the Alto.

Description& Description::operator= ( const Description )
delete
Description& Description::operator= ( Description &&  )
default

Friends And Related Function Documentation

friend class Root
friend

Definition at line 51 of file CRNAltoDescription.hpp.


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