Holds information about an enumerated device. More...
#include <pylon/DeviceInfo.h>
Public Member Functions | |
bool | operator< (const CDeviceInfo &rhs) const |
Compares CDeviceInfo objects by device class and serial number. More... | |
String_t | GetSerialNumber () const |
CDeviceInfo & | SetSerialNumber (const String_t &SerialNumberValue) |
Sets the above property. | |
bool | IsSerialNumberAvailable () const |
Returns true if the above property is available. | |
String_t | GetUserDefinedName () const |
CDeviceInfo & | SetUserDefinedName (const String_t &UserDefinedNameValue) |
Sets the above property. | |
bool | IsUserDefinedNameAvailable () const |
Returns true if the above property is available. | |
String_t | GetModelName () const |
CDeviceInfo & | SetModelName (const String_t &ModelNameValue) |
Sets the above property. | |
bool | IsModelNameAvailable () const |
Returns true if the above property is available. | |
String_t | GetDeviceVersion () const |
CDeviceInfo & | SetDeviceVersion (const String_t &DeviceVersionValue) |
Sets the above property. | |
bool | IsDeviceVersionAvailable () const |
Returns true if the above property is available. | |
String_t | GetDeviceFactory () const |
CDeviceInfo & | SetDeviceFactory (const String_t &DeviceFactoryValue) |
Sets the above property. | |
bool | IsDeviceFactoryAvailable () const |
Returns true if the above property is available. | |
String_t | GetXMLSource () const |
CDeviceInfo & | SetXMLSource (const String_t &XMLSource) |
Sets the above property. | |
bool | IsXMLSourceAvailable () const |
Returns true if the above property is available. | |
CDeviceInfo & | SetFriendlyName (const String_t &FriendlyNameValue) |
CDeviceInfo & | SetFullName (const String_t &FullNameValue) |
CDeviceInfo & | SetVendorName (const String_t &VendorNameValue) |
CDeviceInfo & | SetDeviceClass (const String_t &DeviceClassValue) |
virtual CDeviceInfo & | SetPropertyValue (const String_t &Name, const String_t &Value) |
bool | operator== (const CInfoBase &rhs) const |
compare two info objects | |
bool | operator< (const CInfoBase &rhs) const |
Compares CInfoBase objects by device class. More... | |
String_t | GetFriendlyName () const |
bool | IsFriendlyNameAvailable () const |
Returns true if the above property is available. | |
String_t | GetFullName () const |
bool | IsFullNameAvailable () const |
Returns true if the above property is available. | |
String_t | GetVendorName () const |
bool | IsVendorNameAvailable () const |
Returns true if the above property is available. | |
String_t | GetDeviceClass () const |
bool | IsDeviceClassAvailable () const |
Returns true if the above property is available. | |
virtual int | GetPropertyNames (StringList_t &) const |
Retrieves a list of property names. | |
virtual bool | GetPropertyAvailable (const String_t &Name) const |
Returns true if a property with the provided name is available. | |
virtual bool | GetPropertyValue (const String_t &Name, String_t &Value) const |
Retrieves a property value. | |
virtual bool | IsSubset (const IProperties &Subset) const |
Holds information about an enumerated device.
The device enumeration process creates a list of CDeviceInfo objects (Pylon::DeviceInfoList_t). Each CDeviceInfo objects stores information about a device. The information is retrieved during the device enumeration process (ITransportLayer::EnumerateDevices resp. CTlFactory::EnumerateDevices)
|
inherited |
Retrieves the device class device, e.g. Basler1394. This property is identified by Key::DeviceClassKey.
String_t Pylon::CDeviceInfo::GetDeviceFactory | ( | ) | const |
Retrieves the identifier for the transport layer able to create this device. This property is identified by Key::DeviceFactoryKey.
String_t Pylon::CDeviceInfo::GetDeviceVersion | ( | ) | const |
Retrieves the version string of the device. This property is identified by Key::DeviceVersionKey.
|
inherited |
Retrieves the human readable name of the device. This property is identified by Key::FriendlyNameKey.
|
inherited |
Retrieves the full name identifying the device. This property is identified by Key::FullNameKey.
String_t Pylon::CDeviceInfo::GetModelName | ( | ) | const |
Retrieves the model name of the device. This property is identified by Key::ModelNameKey.
String_t Pylon::CDeviceInfo::GetSerialNumber | ( | ) | const |
Retrieves the serial number if it supported by the underlying implementation This property is identified by Key::SerialNumberKey.
String_t Pylon::CDeviceInfo::GetUserDefinedName | ( | ) | const |
Retrieves the user-defined name if present. This property is identified by Key::UserDefinedNameKey.
|
inherited |
Retrieves the vendor name of the device. This property is identified by Key::VendorNameKey.
String_t Pylon::CDeviceInfo::GetXMLSource | ( | ) | const |
Retrieves the location where the XML file was loaded from. This property is identified by Key::XMLSourceKey. You must use the DeviceInfo of an opened IPylonDevice to retrieve this property.
|
virtualinherited |
Returns true if all properties of the subset can be found and the values are equal The implementing container may use special knowledge on how to compare the values For instance for IP adresses, 192.2.3.45 == 192.2.3.0x2D
Implements Pylon::IProperties.
Reimplemented in Pylon::CBaslerGigEDeviceInfo.
bool Pylon::CDeviceInfo::operator< | ( | const CDeviceInfo & | rhs | ) | const |
Compares CDeviceInfo objects by device class and serial number.
[in] | rhs | The right-hand side object of the comparison. |
|
inherited |
Compares CInfoBase objects by device class.
[in] | rhs | The right-hand side object of the comparison. |
CDeviceInfo& Pylon::CDeviceInfo::SetDeviceClass | ( | const String_t & | DeviceClassValue | ) |
Sets the device class device, e.g. Basler1394. This property is identified by Key::DeviceClassKey. This method overrides a method of a base class returning a reference to CDeviceInfo
CDeviceInfo& Pylon::CDeviceInfo::SetFriendlyName | ( | const String_t & | FriendlyNameValue | ) |
Sets the display friendly name of the device. This property is identified by Key::FriendlyNameKey. This method overrides a method of a base class returning a reference to CDeviceInfo
CDeviceInfo& Pylon::CDeviceInfo::SetFullName | ( | const String_t & | FullNameValue | ) |
Sets the full name identifying the device. This property is identified by Key::FullNameKey. This method overrides a method of a base class returning a reference to CDeviceInfo
|
inlinevirtual |
Modifies a property value This method overrides a method of a base class returning a reference to CDeviceInfo
Reimplemented from Pylon::CInfoBase.
CDeviceInfo& Pylon::CDeviceInfo::SetVendorName | ( | const String_t & | VendorNameValue | ) |
Sets the vendor name of the device. This property is identified by Key::VendorNameKey. This method overrides a method of a base class returning a reference to CDeviceInfo