All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
Pylon::CBaslerUsbDeviceInfo Class Reference

PylonUsb specific Device Info object. More...

#include <pylon/usb/BaslerUsbDeviceInfo.h>

Inheritance diagram for Pylon::CBaslerUsbDeviceInfo:
Inheritance graph
[legend]

Public Member Functions

String_t GetDeviceGUID () const
 
bool IsDeviceGUIDAvailable () const
 Returns true if the above property is available.
 
String_t GetManufacturerInfo () const
 
bool IsManufacturerInfoAvailable () const
 Returns true if the above property is available.
 
String_t GetDeviceIdx () const
 
bool IsDeviceIdxAvailable () const
 Returns true if the above property is available.
 
String_t GetProductId () const
 
bool IsProductIdAvailable () const
 Returns true if the above property is available.
 
String_t GetVendorId () const
 
bool IsVendorIdAvailable () const
 Returns true if the above property is available.
 
String_t GetDriverKeyName () const
 
bool IsDriverKeyNameAvailable () const
 Returns true if the above property is available.
 
String_t GetUsbDriverType () const
 
bool IsUsbDriverTypeAvailable () const
 Returns true if the above property is available.
 
String_t GetTransferMode () const
 
bool IsTransferModeAvailable () const
 Returns true if the above property is available.
 
bool operator< (const CDeviceInfo &rhs) const
 Compares CDeviceInfo objects by device class and serial number. More...
 
bool operator< (const CInfoBase &rhs) const
 Compares CInfoBase objects by device class. More...
 
String_t GetSerialNumber () const
 
CDeviceInfoSetSerialNumber (const String_t &SerialNumberValue)
 Sets the above property.
 
bool IsSerialNumberAvailable () const
 Returns true if the above property is available.
 
String_t GetUserDefinedName () const
 
CDeviceInfoSetUserDefinedName (const String_t &UserDefinedNameValue)
 Sets the above property.
 
bool IsUserDefinedNameAvailable () const
 Returns true if the above property is available.
 
String_t GetModelName () const
 
CDeviceInfoSetModelName (const String_t &ModelNameValue)
 Sets the above property.
 
bool IsModelNameAvailable () const
 Returns true if the above property is available.
 
String_t GetDeviceVersion () const
 
CDeviceInfoSetDeviceVersion (const String_t &DeviceVersionValue)
 Sets the above property.
 
bool IsDeviceVersionAvailable () const
 Returns true if the above property is available.
 
String_t GetDeviceFactory () const
 
CDeviceInfoSetDeviceFactory (const String_t &DeviceFactoryValue)
 Sets the above property.
 
bool IsDeviceFactoryAvailable () const
 Returns true if the above property is available.
 
String_t GetXMLSource () const
 
CDeviceInfoSetXMLSource (const String_t &XMLSource)
 Sets the above property.
 
bool IsXMLSourceAvailable () const
 Returns true if the above property is available.
 
CDeviceInfoSetFriendlyName (const String_t &FriendlyNameValue)
 
CDeviceInfoSetFullName (const String_t &FullNameValue)
 
CDeviceInfoSetVendorName (const String_t &VendorNameValue)
 
CDeviceInfoSetDeviceClass (const String_t &DeviceClassValue)
 
virtual CDeviceInfoSetPropertyValue (const String_t &Name, const String_t &Value)
 
bool operator== (const CInfoBase &rhs) const
 compare two info objects
 
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
 

Detailed Description

PylonUsb specific Device Info object.

Member Function Documentation

String_t Pylon::CInfoBase::GetDeviceClass ( ) const
inherited

Retrieves the device class device, e.g. Basler1394. This property is identified by Key::DeviceClassKey.

String_t Pylon::CDeviceInfo::GetDeviceFactory ( ) const
inherited

Retrieves the identifier for the transport layer able to create this device. This property is identified by Key::DeviceFactoryKey.

String_t Pylon::CBaslerUsbDeviceInfo::GetDeviceGUID ( ) const

Retrieves the device GUID. This property is identified by Key::DeviceGUID.

String_t Pylon::CBaslerUsbDeviceInfo::GetDeviceIdx ( ) const

Retrieves the device index. For internal use only. This property is identified by Key::DeviceIdx.

String_t Pylon::CDeviceInfo::GetDeviceVersion ( ) const
inherited

Retrieves the version string of the device. This property is identified by Key::DeviceVersionKey.

String_t Pylon::CBaslerUsbDeviceInfo::GetDriverKeyName ( ) const

Retrieves the driver key name. For internal use only. This property is identified by Key::DriverKeyName.

String_t Pylon::CInfoBase::GetFriendlyName ( ) const
inherited

Retrieves the human readable name of the device. This property is identified by Key::FriendlyNameKey.

String_t Pylon::CInfoBase::GetFullName ( ) const
inherited

Retrieves the full name identifying the device. This property is identified by Key::FullNameKey.

String_t Pylon::CBaslerUsbDeviceInfo::GetManufacturerInfo ( ) const

Retrieves the manufacturer info. This property is identified by Key::ManufacturerInfo.

String_t Pylon::CDeviceInfo::GetModelName ( ) const
inherited

Retrieves the model name of the device. This property is identified by Key::ModelNameKey.

String_t Pylon::CBaslerUsbDeviceInfo::GetProductId ( ) const

Retrieves the product ID. For internal use only. This property is identified by Key::DeviceIdx.

String_t Pylon::CDeviceInfo::GetSerialNumber ( ) const
inherited

Retrieves the serial number if it supported by the underlying implementation This property is identified by Key::SerialNumberKey.

String_t Pylon::CBaslerUsbDeviceInfo::GetTransferMode ( ) const

Retrieves the transfer mode. For internal use only. This property is identified by Key::TransferModeKey

String_t Pylon::CBaslerUsbDeviceInfo::GetUsbDriverType ( ) const

Retrieves the usb driver type. For internal use only. This property is identified by Key::UsbDriverTypeKey.

String_t Pylon::CDeviceInfo::GetUserDefinedName ( ) const
inherited

Retrieves the user-defined name if present. This property is identified by Key::UserDefinedNameKey.

String_t Pylon::CBaslerUsbDeviceInfo::GetVendorId ( ) const

Retrieves the vendor ID. For internal use only. This property is identified by Key::DeviceIdx.

String_t Pylon::CInfoBase::GetVendorName ( ) const
inherited

Retrieves the vendor name of the device. This property is identified by Key::VendorNameKey.

String_t Pylon::CDeviceInfo::GetXMLSource ( ) const
inherited

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.

virtual bool Pylon::CInfoBase::IsSubset ( const IProperties Subset) const
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
inherited

Compares CDeviceInfo objects by device class and serial number.

Parameters
[in]rhsThe right-hand side object of the comparison.
Returns
Returns true according to this rule: USB < GigE < CameraLink < 1394 < Bcon < Less than compare of device class text < CamEmu. CDeviceInfo objects of the same transport layer are compared by serial number. Numeric serial numbers are less than alphanumeric serial numbers. Two alphanumeric serial numbers return the result of a less than text comparison.
Error Safety:
Does not throw C++ exceptions.
bool Pylon::CInfoBase::operator< ( const CInfoBase rhs) const
inherited

Compares CInfoBase objects by device class.

Parameters
[in]rhsThe right-hand side object of the comparison.
Returns
Returns true according to this rule: USB < GigE < CameraLink < 1394 < Bcon < Less than compare of device class text < CamEmu.
Error Safety:
Does not throw C++ exceptions.
CDeviceInfo& Pylon::CDeviceInfo::SetDeviceClass ( const String_t DeviceClassValue)
inherited

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)
inherited

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)
inherited

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

virtual CDeviceInfo& Pylon::CDeviceInfo::SetPropertyValue ( const String_t Name,
const String_t Value 
)
inlinevirtualinherited

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)
inherited

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


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

pylon 5.0.9
Copyright © 2006-2017 Basler AG (Tue May 30 2017 17:24:59)