-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathGXDeviceInfo.h
175 lines (150 loc) · 6.73 KB
/
GXDeviceInfo.h
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
//------------------------------------------------------------------------
/**
\file GXDeviceInfo.h
\brief The device enumeration process creates a list of CGXDeviceInfo objects
(GxIAPICPP::gxdeviceinfo_vector). Each CGXDeviceInfo object stores the information of a device.
The information is retrieved during the device enumeration process (IGXFactory::UpdateDeviceList)
\Date 2016-8-09
\Version 1.1.1608.9091
*/
//------------------------------------------------------------------------
#pragma once
#include "IGXDeviceInfo.h"
#include "GXSmartPtr.h"
#pragma warning(push)
#pragma warning(disable: 4251) // class 'xxx' needs to have dll-interface to be used by clients of class 'yyy'
class IGXDeviceInfoImpl;
typedef GXSmartPtr<IGXDeviceInfoImpl> CGXDeviceInfoImplPointer;
class GXIAPICPP_API CGXDeviceInfo : public IGXDeviceInfo
{
public:
//Constructor
CGXDeviceInfo();
///Constructor
CGXDeviceInfo(CGXDeviceInfoImplPointer& objCGXDeviceInfoImplPointer);
///Destructor
virtual ~CGXDeviceInfo(void);
public:
//----------------------------------------------------------------------------------
/**
\brief Retrieves the vendor name of the device.
\return The vendor name
*/
//----------------------------------------------------------------------------------
virtual GxIAPICPP::gxstring GetVendorName() const;
//----------------------------------------------------------------------------------
/**
\brief Retrieves the model name of the device.
\return The model name
*/
//----------------------------------------------------------------------------------
virtual GxIAPICPP::gxstring GetModelName() const;
//----------------------------------------------------------------------------------
/**
\brief Retrieves the serial number of the device.
\return The serial number
*/
//----------------------------------------------------------------------------------
virtual GxIAPICPP::gxstring GetSN() const;
//----------------------------------------------------------------------------------
/**
\brief Retrieves the display name of the device.
\return The display name
*/
//----------------------------------------------------------------------------------
virtual GxIAPICPP::gxstring GetDisplayName() const;
//----------------------------------------------------------------------------------
/**
\brief Retrieves the device id of the device.
\return The device id
*/
//----------------------------------------------------------------------------------
virtual GxIAPICPP::gxstring GetDeviceID() const;
//----------------------------------------------------------------------------------
/**
\brief Retrieves the user defined name of the device if present.
\return The user defined name
*/
//----------------------------------------------------------------------------------
virtual GxIAPICPP::gxstring GetUserID() const;
//----------------------------------------------------------------------------------
/**
\brief Retrieves the current access status of the device(e.g. read only, read & write, or no access).
\return The current access status
*/
//----------------------------------------------------------------------------------
virtual GX_ACCESS_STATUS GetAccessStatus() const;
//----------------------------------------------------------------------------------
/**
\brief Retrieves the class of the device(e.g. USB2.0\Gige\USB3.0).
\return The device class
*/
//----------------------------------------------------------------------------------
virtual GX_DEVICE_CLASS_LIST GetDeviceClass() const;
//----------------------------------------------------------------------------------
/**
\brief Retrieves the MAC address of the device if present.
\return The MAC address
*/
//----------------------------------------------------------------------------------
virtual GxIAPICPP::gxstring GetMAC() const;
//----------------------------------------------------------------------------------
/**
\brief Retrieves the IP address of the device if present.
\return The IP address
*/
//----------------------------------------------------------------------------------
virtual GxIAPICPP::gxstring GetIP() const;
//----------------------------------------------------------------------------------
/**
\brief Retrieves the subnet mask address of the device if present.
\return The subnet mask
*/
//----------------------------------------------------------------------------------
virtual GxIAPICPP::gxstring GetSubnetMask() const;
//----------------------------------------------------------------------------------
/**
\brief Retrieves the gateway of the device if present.
\return The gateway
*/
//----------------------------------------------------------------------------------
virtual GxIAPICPP::gxstring GetGateway() const;
//----------------------------------------------------------------------------------
/**
\brief Retrieves the NIC's MAC address of the device if present.
\return The NIC's MAC address
*/
//----------------------------------------------------------------------------------
virtual GxIAPICPP::gxstring GetNICMAC() const;
//----------------------------------------------------------------------------------
/**
\brief Retrieves the NIC's IP address of the device if present.
\return The NIC's IP address
*/
//----------------------------------------------------------------------------------
virtual GxIAPICPP::gxstring GetNICIP() const;
//----------------------------------------------------------------------------------
/**
\brief Retrieves the NIC's subnet mask address of the device if present.
\return The NIC's subnet mask
*/
//----------------------------------------------------------------------------------
virtual GxIAPICPP::gxstring GetNICSubnetMask() const;
//----------------------------------------------------------------------------------
/**
\brief Retrieves the NIC's gateway of the device if present.
\return The NIC's gateway
*/
//----------------------------------------------------------------------------------
virtual GxIAPICPP::gxstring GetNICGateway() const;
//----------------------------------------------------------------------------------
/**
\brief Retrieves the NIC's description of the device if present.
\return The NIC's description
*/
//----------------------------------------------------------------------------------
virtual GxIAPICPP::gxstring GetNICDescription() const;
private:
CGXDeviceInfoImplPointer m_CGXDeviceInfoImplPointer; ///< Internal use only
};
#pragma warning(pop)