EnumEntry.h
Go to the documentation of this file.
1 /*=============================================================================
2  Copyright (C) 2012 Allied Vision Technologies. All Rights Reserved.
3 
4  Redistribution of this file, in original or modified form, without
5  prior written consent of Allied Vision Technologies is prohibited.
6 
7 -------------------------------------------------------------------------------
8 
9  File: EnumEntry.h
10 
11  Description: Definition of class AVT::VmbAPI::EnumEntry.
12  An EnumEntry consists of
13  Name
14  DisplayName
15  Value
16  of one particular enumeration
17 
18 -------------------------------------------------------------------------------
19 
20  THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
21  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF TITLE,
22  NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23  DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
24  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
28  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 =============================================================================*/
32 
33 #ifndef AVT_VMBAPI_ENUMENTRY_H
34 #define AVT_VMBAPI_ENUMENTRY_H
35 
36 #include <string>
37 
38 #include <VimbaC/Include/VimbaC.h>
41 
42 namespace AVT {
43 namespace VmbAPI {
44 
45 class EnumEntry
46 {
47  public:
48  //
49  // Method: EnumEntry constructor
50  //
51  // Purpose: Creates an instance of class EnumEntry
52  //
53  // Parameters:
54  //
55  // [in ] const char* pName The name of the enum
56  // [in ] const char* pDisplayName The declarative name of the enum
57  // [in ] const char* pDescription The description of the enum
58  // [in ] const char* pTooltip A tooltip that can be used by a GUI
59  // [in ] const char* pSNFCNamespace The SFNC namespace of the enum
60  // [in ] VmbFeatureVisibility_t visibility The visibility of the enum
61  // [in ] VmbInt64_t value The integer value of the enum
62  //
63  EnumEntry( const char *pName,
64  const char *pDisplayName,
65  const char *pDescription,
66  const char *pTooltip,
67  const char *pSNFCNamespace,
68  VmbFeatureVisibility_t visibility,
69  VmbInt64_t value);
70 
71  //
72  // Method: EnumEntry constructor
73  //
74  // Purpose: Creates an instance of class EnumEntry
75  //
76  IMEXPORT EnumEntry();
77  //
78  // Method: EnumEntry copy constructor
79  //
80  // Purpose: Creates a copy of class EnumEntry
81  //
82  IMEXPORT EnumEntry( const EnumEntry &other);
83 
84  //
85  // Method: EnumEntry assignment operator
86  //
87  // Purpose: assigns EnumEntry to existing instance
88  //
89  IMEXPORT EnumEntry& operator=( const EnumEntry&o);
90 
91  //
92  // Method: EnumEntry destructor
93  //
94  // Purpose: Destroys an instance of class EnumEntry
95  //
96  IMEXPORT virtual ~EnumEntry();
97 
98  //
99  // Method: GetName()
100  //
101  // Purpose: Gets the name of an enumeration
102  //
103  // Parameters:
104  //
105  // [out] std::string& name The name of the enumeration
106  //
107  VmbErrorType GetName( std::string &name ) const;
108 
109  //
110  // Method: GetDisplayName()
111  //
112  // Purpose: Gets a more declarative name of an enumeration
113  //
114  // Parameters:
115  //
116  // [out] std::string& displayName The display name of the enumeration
117  //
118  VmbErrorType GetDisplayName( std::string &displayName ) const;
119 
120  //
121  // Method: GetDescription()
122  //
123  // Purpose: Gets the description of an enumeration
124  //
125  // Parameters:
126  //
127  // [out] std::string& description The description of the enumeration
128  //
129  VmbErrorType GetDescription( std::string &description ) const;
130 
131  //
132  // Method: GetTooltip()
133  //
134  // Purpose: Gets a tooltip that can be used as pop up help in a GUI
135  //
136  // Parameters:
137  //
138  // [out] std::string& tooltip The tooltip as string
139  //
140  VmbErrorType GetTooltip( std::string &tooltip ) const;
141 
142  //
143  // Method: GetValue()
144  //
145  // Purpose: Gets the integer value of an enumeration
146  //
147  // Parameters:
148  //
149  // [out] VmbInt64_t& value The integer value of the enumeration
150  //
151  IMEXPORT VmbErrorType GetValue( VmbInt64_t &value ) const;
152 
153  //
154  // Method: GetVisibility()
155  //
156  // Purpose: Gets the visibility of an enumeration
157  //
158  // Parameters:
159  //
160  // [out] VmbFeatureVisibilityType& value The visibility of the enumeration
161  //
162  IMEXPORT VmbErrorType GetVisibility( VmbFeatureVisibilityType &value ) const;
163 
164  //
165  // Method: GetSNFCNamespace()
166  //
167  // Purpose: Gets the standard feature naming convention namespace of the enumeration
168  //
169  // Parameters:
170  //
171  // [out] std::string& sFNCNamespace The feature's SFNC namespace
172  //
173  VmbErrorType GetSFNCNamespace( std::string &sFNCNamespace ) const;
174 
175  private:
176  struct PrivateImpl;
178  // Array functions to pass data across DLL boundaries
179  IMEXPORT VmbErrorType GetName( char * const pName, VmbUint32_t &size ) const;
180  IMEXPORT VmbErrorType GetDisplayName( char * const pDisplayName, VmbUint32_t &size ) const;
181  IMEXPORT VmbErrorType GetTooltip( char * const pStrTooltip, VmbUint32_t &size ) const;
182  IMEXPORT VmbErrorType GetDescription( char * const pStrDescription, VmbUint32_t &size ) const;
183  IMEXPORT VmbErrorType GetSFNCNamespace( char * const pStrNamespace, VmbUint32_t &size ) const;
184 
185 };
186 
188 
189 }} // namespace AVT::VmbAPI
190 
191 #endif
VmbFeatureVisibilityType
Definition: VimbaC.h:181
long long VmbInt64_t
VmbErrorType GetName(std::string &name) const
VmbErrorType GetSFNCNamespace(std::string &sFNCNamespace) const
VmbErrorType GetTooltip(std::string &tooltip) const
VmbErrorType GetDisplayName(std::string &displayName) const
VmbErrorType
IMEXPORT EnumEntry & operator=(const EnumEntry &o)
Definition: EnumEntry.cpp:203
PrivateImpl * m_pImpl
Definition: EnumEntry.h:176
IMEXPORT VmbErrorType GetValue(VmbInt64_t &value) const
Definition: EnumEntry.cpp:276
unsigned int VmbUint32_t
VmbErrorType GetDescription(std::string &description) const
virtual IMEXPORT ~EnumEntry()
Definition: EnumEntry.cpp:222
IMEXPORT VmbErrorType GetVisibility(VmbFeatureVisibilityType &value) const
Definition: EnumEntry.cpp:287
VmbUint32_t VmbFeatureVisibility_t
Definition: VimbaC.h:189


avt_vimba_camera
Author(s): Miquel Massot , Allied Vision Technologies
autogenerated on Wed Jun 5 2019 22:22:40