aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/lipi-toolkit/3rdparty/lipi-toolkit/src/reco/shaperec/featureextractor/pointfloat/PointFloat.h
blob: 91ee5e6b43873cfbb1bb115976694036a68a9eb6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/*****************************************************************************************
* Copyright (c) 2006 Hewlett-Packard Development Company, L.P.
* Permission is hereby granted, free of charge, to any person obtaining a copy of 
* this software and associated documentation files (the "Software"), to deal in 
* the Software without restriction, including without limitation the rights to use, 
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the 
* Software, and to permit persons to whom the Software is furnished to do so, 
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE 
* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
*****************************************************************************************/

/************************************************************************
 * SVN MACROS
 *
 * $LastChangedDate: 2008-07-18 15:00:39 +0530 (Fri, 18 Jul 2008) $
 * $Revision: 561 $
 * $Author: sharmnid $
 *
 ************************************************************************/
/************************************************************************
* FILE DESCR: Definitions for PointFloat dll exporting functions.
*
* CONTENTS:   
*
* AUTHOR:     Vijayakumara M.
*
* DATE:       28-July-2005
* CHANGE HISTORY:
* Author		Date			Description
************************************************************************/
#ifndef __POINTFLOAT_H__
#define __POINTFLOAT_H__

// The following ifdef block is the standard way of creating macros which make exporting 
// from a DLL simpler. All files within this DLL are compiled with the POINTFLOAT_EXPORTS
// symbol defined on the command line. this symbol should not be defined on any project
// that uses this DLL. This way any other project whose source files include this file see 
// POINTFLOAT_API functions as being imported from a DLL, wheras this DLL sees symbols
// defined with this macro as being exported.
#ifdef _WIN32
#ifdef POINTFLOAT_EXPORTS
#define POINTFLOAT_API __declspec(dllexport)
#else
#define POINTFLOAT_API __declspec(dllimport)
#endif  //ifdef POINTFLOAT_EXPORTS
#else
#define POINTFLOAT_API
#endif	//#ifdef _WIN32


#include "LTKTypes.h"
#include "LTKLoggerUtil.h"

class LTKShapeFeatureExtractor;
class LTKShapeFeature;

/** @defgroup PointFloatShapeFeatureExtractor
*@brief The PointFloatShapeFeatureExtractor
*/

/**
* @ingroup PointFloatShapeFeatureExtractor
* @file PointFloat.cpp
* <p>
* The functions exported by the DLL
*   - ::createShapeFeatureExtractor
*   - ::deleteShapeFeatureExtractor
*   - ::getCurrentVersion
*   - ::deleteShapeFeaturePtr
*/

/**
*  @brief Returns a pointer to the instance of PointFloatShapeFeatureExtractor
*
* <p>
* This function is based on run-time polymorphism. It creates an instance of 
* PointFloatShapeFeatureExtractor at run-time and returns it as a pointer to the base class <i>LTKShapeFeatureExtractor</i>
* </p>
*
* @param  none
*
* @return  Pointer to LTKShapeFeatureExtractor
*/
extern "C" POINTFLOAT_API int createShapeFeatureExtractor(
                                    const LTKControlInfo& controlInfo,
                                    LTKShapeFeatureExtractor** outFeatureExtractor);

/**
* @brief Deletes the feature extractor instance.
*
* <p> 
* This function cleans up all the memory allocations done by the feature extractor by calling it's destructor.
* </p>
*
* @param  featureExtractorPtr - Pointer to LTKShapeFeatureExtractor.
*
* @return  0 on Success
*/
extern "C" POINTFLOAT_API int deleteShapeFeatureExtractor(LTKShapeFeatureExtractor *featureExtractorPtr);

#endif //#ifndef __POINTFLOAT_H__