Pylon::CDeviceInfo#
Holds information about an enumerated device. More…
#include <pylon/DeviceInfo.h>
Inherits from Pylon::CInfoBase, Pylon::IProperties
Public Functions#
| Name | |
|---|---|
| CDeviceInfo() | |
| CDeviceInfo(const CDeviceInfo & ) | |
| virtual | ~CDeviceInfo() |
| bool | operator<(const CDeviceInfo & rhs) const Compares CDeviceInfo objects by device class and serial number. |
| 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) |
| String_t | GetInterfaceID() const |
| CDeviceInfo & | SetInterfaceID(const String_t & InterfaceIDValue) Sets the above property. |
| bool | IsInterfaceIDAvailable() const Returns true if the above property is available. |
| String_t | GetAddress() const |
| CDeviceInfo & | SetAddress(const String_t & AddressValue) |
| bool | IsAddressAvailable() const |
| String_t | GetIpAddress() const |
| CDeviceInfo & | SetIpAddress(const String_t & IpAddressValue) |
| bool | IsIpAddressAvailable() const |
| String_t | GetSubnetAddress() const |
| CDeviceInfo & | SetSubnetAddress(const String_t & SubnetAddressValue) |
| bool | IsSubnetAddressAvailable() const |
| String_t | GetDefaultGateway() const |
| CDeviceInfo & | SetDefaultGateway(const String_t & DefaultGatewayValue) |
| bool | IsDefaultGatewayAvailable() const |
| String_t | GetSubnetMask() const |
| CDeviceInfo & | SetSubnetMask(const String_t & SubnetMaskValue) |
| bool | IsSubnetMaskAvailable() const |
| String_t | GetPortNr() const |
| CDeviceInfo & | SetPortNr(const String_t & PortNrValue) |
| bool | IsPortNrAvailable() const |
| String_t | GetMacAddress() const |
| CDeviceInfo & | SetMacAddress(const String_t & MacAddressValue) |
| bool | IsMacAddressAvailable() const |
| String_t | GetInterface() const |
| CDeviceInfo & | SetInterface(const String_t & InterfaceValue) |
| bool | IsInterfaceAvailable() const |
| String_t | GetIpConfigOptions() const |
| CDeviceInfo & | SetIpConfigOptions(const String_t & IpConfigOptionsValue) |
| bool | IsIpConfigOptionsAvailable() const |
| String_t | GetIpConfigCurrent() const |
| CDeviceInfo & | SetIpConfigCurrent(const String_t & IpConfigCurrentValue) |
| bool | IsIpConfigCurrentAvailable() const |
| String_t | GetDeviceGUID() const |
| bool | IsDeviceGUIDAvailable() const |
| String_t | GetManufacturerInfo() const |
| bool | IsManufacturerInfoAvailable() const |
| String_t | GetDeviceIdx() const |
| bool | IsDeviceIdxAvailable() const |
| String_t | GetProductId() const |
| bool | IsProductIdAvailable() const |
| String_t | GetVendorId() const |
| bool | IsVendorIdAvailable() const |
| String_t | GetDriverKeyName() const |
| bool | IsDriverKeyNameAvailable() const |
| String_t | GetUsbDriverType() const |
| bool | IsUsbDriverTypeAvailable() const |
| String_t | GetTransferMode() const Applies to: Usb. |
| bool | IsTransferModeAvailable() const |
| String_t | GetInternalName() const |
| CDeviceInfo & | SetInternalName(const String_t & InternalNameValue) |
| bool | IsInternalNameAvailable() const |
| String_t | GetPortID() const |
| CDeviceInfo & | SetPortID(const String_t & PortIDValue) |
| bool | IsPortIDAvailable() const |
| String_t | GetDeviceID() const |
| CDeviceInfo & | SetDeviceID(const String_t & DeviceIDValue) |
| bool | IsDeviceIDAvailable() const |
| String_t | GetInitialBaudRate() const |
| CDeviceInfo & | SetInitialBaudRate(const String_t & InitialBaudRateValue) |
| bool | IsInitialBaudRateAvailable() const |
| String_t | GetDeviceXMLFileOverride() const |
| CDeviceInfo & | SetDeviceXMLFileOverride(const String_t & DeviceXMLFileOverrideValue) |
| bool | IsDeviceXMLFileOverrideAvailable() const |
| String_t | GetDeviceSpecificString() const |
| CDeviceInfo & | SetDeviceSpecificString(const String_t & DeviceSpecificStringValue) |
| bool | IsDeviceSpecificStringAvailable() const |
| String_t | GetPortSpecificString() const |
| CDeviceInfo & | SetPortSpecificString(const String_t & PortSpecificStringValue) |
| bool | IsPortSpecificStringAvailable() const |
| virtual CDeviceInfo & | SetPropertyValue(const String_t & Name, const String_t & Value) |
| bool | IsPersistentIpActive(void ) const Returns true when the device is configured for a persistent IP address. |
| bool | IsDhcpActive(void ) const Returns true when the device is configured for using DHCP. |
| bool | IsAutoIpActive(void ) const Returns true when the device is configured for using Auto IP (aka LLA) |
| bool | IsPersistentIpSupported(void ) const Returns true when the device supports configuring a persistent IP address. |
| bool | IsDhcpSupported(void ) const Returns true when the device supports DHCP. |
| bool | IsAutoIpSupported(void ) const Returns true when the device supports Auto IP (aka LLA) |
| virtual bool | IsSubset(const IProperties & Subset) const Returns true when subset, applies special knowledge on how to compare GigE specific values. |
| bool | operator==(const CInfoBase & rhs) const compare two info objects |
| bool | operator<(const CInfoBase & rhs) const Compares CInfoBase objects by device class. |
| 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. |
| String_t | GetTLType() const |
| CInfoBase & | SetTLType(const String_t & value) Sets the above property. |
| bool | IsTLTypeAvailable() 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 | IsUserProvided() const |
| const char * | GetPropertyNotAvailable() |
Protected Functions#
| Name | |
|---|---|
| CDeviceInfo & | SetDeviceGUID(const String_t & ) |
| CDeviceInfo & | SetManufacturerInfo(const String_t & ) |
| CDeviceInfo & | SetDeviceIdx(const String_t & ) |
| CDeviceInfo & | SetProductId(const String_t & ) |
| CDeviceInfo & | SetVendorId(const String_t & ) |
| CDeviceInfo & | SetDriverKeyName(const String_t & ) |
| CDeviceInfo & | SetUsbDriverType(const String_t & ) |
| CDeviceInfo & | SetTransferMode(const String_t & ) |
Public Attributes#
| Name | |
|---|---|
| const char *const | PropertyNotAvailable |
Protected Attributes#
| Name | |
|---|---|
| CInfoImpl * | m_pImpl |
Additional inherited members#
Public Functions inherited from Pylon::CInfoBase
| Name | |
|---|---|
| CInfoBase & | operator=(const CInfoBase & ) |
Protected Functions inherited from Pylon::CInfoBase
| Name | |
|---|---|
| CInfoBase() | |
| CInfoBase(const CInfoBase & ) | |
| virtual | ~CInfoBase() |
Detailed Description#
class Pylon::CDeviceInfo;
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)
Public Functions Documentation#
CDeviceInfo#
CDeviceInfo()
CDeviceInfo#
CDeviceInfo(
const CDeviceInfo &
)
~CDeviceInfo#
inline virtual ~CDeviceInfo()
operator<#
bool operator<(
const CDeviceInfo & rhs
) const
Compares CDeviceInfo objects by device class and serial number.
Parameters:
- rhs The right-hand side object of the comparison.
Return: Returns true according to this rule: USB < GigE < CameraLink < 1394 < 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.
GetSerialNumber#
String_t GetSerialNumber() const
Retrieves the serial number if it supported by the underlying implementation This property is identified by Key::SerialNumberKey.
SetSerialNumber#
CDeviceInfo & SetSerialNumber(
const String_t & SerialNumberValue
)
Sets the above property.
IsSerialNumberAvailable#
bool IsSerialNumberAvailable() const
Returns true if the above property is available.
GetUserDefinedName#
String_t GetUserDefinedName() const
Retrieves the user-defined name if present. This property is identified by Key::UserDefinedNameKey.
SetUserDefinedName#
CDeviceInfo & SetUserDefinedName(
const String_t & UserDefinedNameValue
)
Sets the above property.
IsUserDefinedNameAvailable#
bool IsUserDefinedNameAvailable() const
Returns true if the above property is available.
GetModelName#
String_t GetModelName() const
Retrieves the model name of the device. This property is identified by Key::ModelNameKey.
SetModelName#
CDeviceInfo & SetModelName(
const String_t & ModelNameValue
)
Sets the above property.
IsModelNameAvailable#
bool IsModelNameAvailable() const
Returns true if the above property is available.
GetDeviceVersion#
String_t GetDeviceVersion() const
Retrieves the version string of the device. This property is identified by Key::DeviceVersionKey.
SetDeviceVersion#
CDeviceInfo & SetDeviceVersion(
const String_t & DeviceVersionValue
)
Sets the above property.
IsDeviceVersionAvailable#
bool IsDeviceVersionAvailable() const
Returns true if the above property is available.
GetDeviceFactory#
String_t GetDeviceFactory() const
Retrieves the identifier for the transport layer able to create this device. This property is identified by Key::DeviceFactoryKey.
SetDeviceFactory#
CDeviceInfo & SetDeviceFactory(
const String_t & DeviceFactoryValue
)
Sets the above property.
IsDeviceFactoryAvailable#
bool IsDeviceFactoryAvailable() const
Returns true if the above property is available.
GetXMLSource#
String_t 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.
SetXMLSource#
CDeviceInfo & SetXMLSource(
const String_t & XMLSource
)
Sets the above property.
IsXMLSourceAvailable#
bool IsXMLSourceAvailable() const
Returns true if the above property is available.
SetFriendlyName#
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
SetFullName#
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
SetVendorName#
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
SetDeviceClass#
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
GetInterfaceID#
String_t GetInterfaceID() const
Retrieves the ID of the interface that the device is connected to. This property is identified by Key::InterfaceIDKey.
SetInterfaceID#
CDeviceInfo & SetInterfaceID(
const String_t & InterfaceIDValue
)
Sets the above property.
IsInterfaceIDAvailable#
bool IsInterfaceIDAvailable() const
Returns true if the above property is available.
GetAddress#
String_t GetAddress() const
Retrieves the IP address the device IP address in a human-readable representation including the port number. This property is identified by Key::AddressKey. Applies to: GigE
SetAddress#
CDeviceInfo & SetAddress(
const String_t & AddressValue
)
Sets the above property. Applies to: GigE
IsAddressAvailable#
bool IsAddressAvailable() const
Returns true if the above property is available. Applies to: GigE
GetIpAddress#
String_t GetIpAddress() const
Retrieves the IP address the device IP address in a human-readable representation. This property is identified by Key::IpAddressKey. Applies to: GigE
SetIpAddress#
CDeviceInfo & SetIpAddress(
const String_t & IpAddressValue
)
Sets the above property. Applies to: GigE
IsIpAddressAvailable#
bool IsIpAddressAvailable() const
Returns true if the above property is available. Applies to: GigE
GetSubnetAddress#
String_t GetSubnetAddress() const
Retrieves the IP address of the subnet. This property is identified by Key::SubnetAddressKey Applies to: GigE
SetSubnetAddress#
CDeviceInfo & SetSubnetAddress(
const String_t & SubnetAddressValue
)
Sets the above property. Applies to: GigE
IsSubnetAddressAvailable#
bool IsSubnetAddressAvailable() const
Returns true if the above property is available. Applies to: GigE
GetDefaultGateway#
String_t GetDefaultGateway() const
Retrieves the default gateway the device IP address in a human-readable representation. This property is identified by Key::DefaultGatewayKey. Applies to: GigE
SetDefaultGateway#
CDeviceInfo & SetDefaultGateway(
const String_t & DefaultGatewayValue
)
Sets the above property. Applies to: GigE
IsDefaultGatewayAvailable#
bool IsDefaultGatewayAvailable() const
Returns true if the above property is available. Applies to: GigE
GetSubnetMask#
String_t GetSubnetMask() const
Retrieves the subnet mask the device IP address in a human-readable representation. This property is identified by Key::SubnetMaskKey. Applies to: GigE
SetSubnetMask#
CDeviceInfo & SetSubnetMask(
const String_t & SubnetMaskValue
)
Sets the above property. Applies to: GigE
IsSubnetMaskAvailable#
bool IsSubnetMaskAvailable() const
Returns true if the above property is available. Applies to: GigE
GetPortNr#
String_t GetPortNr() const
Retrieves the port number used. This property is identified by Key::PortNrKey. Applies to: GigE
SetPortNr#
CDeviceInfo & SetPortNr(
const String_t & PortNrValue
)
Sets the above property. Applies to: GigE
IsPortNrAvailable#
bool IsPortNrAvailable() const
Returns true if the above property is available. Applies to: GigE
GetMacAddress#
String_t GetMacAddress() const
Retrieves the MAC address of the device the device IP address in a human-readable representation. This property is identified by Key::MacAddressKey. Applies to: GigE
SetMacAddress#
CDeviceInfo & SetMacAddress(
const String_t & MacAddressValue
)
Sets the above property. Applies to: GigE
IsMacAddressAvailable#
bool IsMacAddressAvailable() const
Returns true if the above property is available. Applies to: GigE
GetInterface#
String_t GetInterface() const
Retrieves the address of the network interface the device is connected. This property is identified by Key::InterfaceKey. Applies to: GigE
SetInterface#
CDeviceInfo & SetInterface(
const String_t & InterfaceValue
)
Sets the above property. Applies to: GigE
IsInterfaceAvailable#
bool IsInterfaceAvailable() const
Returns true if the above property is available. Applies to: GigE
GetIpConfigOptions#
String_t GetIpConfigOptions() const
Retrieves the persistent IP configuration options. This property is identified by Key::IpConfigOptionsKey. Applies to: GigE
SetIpConfigOptions#
CDeviceInfo & SetIpConfigOptions(
const String_t & IpConfigOptionsValue
)
Sets the above property. Applies to: GigE
IsIpConfigOptionsAvailable#
bool IsIpConfigOptionsAvailable() const
Returns true if the above property is available. Applies to: GigE
GetIpConfigCurrent#
String_t GetIpConfigCurrent() const
Retrieves the current IP configuration of the device. This property is identified by Key::IpConfigCurrentKey. Applies to: GigE
SetIpConfigCurrent#
CDeviceInfo & SetIpConfigCurrent(
const String_t & IpConfigCurrentValue
)
Sets the above property. Applies to: GigE
IsIpConfigCurrentAvailable#
bool IsIpConfigCurrentAvailable() const
Returns true if the above property is available. Applies to: GigE
GetDeviceGUID#
String_t GetDeviceGUID() const
Retrieves the device GUID. This property is identified by Key::DeviceGUIDKey. Applies to: Usb
IsDeviceGUIDAvailable#
bool IsDeviceGUIDAvailable() const
Returns true if the above property is available. Applies to: Usb
GetManufacturerInfo#
String_t GetManufacturerInfo() const
Retrieves the manufacturer info. This property is identified by Key::ManufacturerInfoKey. Applies to: Usb
IsManufacturerInfoAvailable#
bool IsManufacturerInfoAvailable() const
Returns true if the above property is available. Applies to: Usb
GetDeviceIdx#
String_t GetDeviceIdx() const
Retrieves the device index. For internal use only. This property is identified by Key::DeviceIdxKey. Applies to: Usb
IsDeviceIdxAvailable#
bool IsDeviceIdxAvailable() const
Returns true if the above property is available. Applies to: Usb
GetProductId#
String_t GetProductId() const
Retrieves the product ID. For internal use only. This property is identified by Key::ProductIdKey. Applies to: Usb
IsProductIdAvailable#
bool IsProductIdAvailable() const
Returns true if the above property is available. Applies to: Usb
GetVendorId#
String_t GetVendorId() const
Retrieves the vendor ID. For internal use only. This property is identified by Key::VendorIdKey. Applies to: Usb
IsVendorIdAvailable#
bool IsVendorIdAvailable() const
Returns true if the above property is available. Applies to: Usb
GetDriverKeyName#
String_t GetDriverKeyName() const
Retrieves the driver key name. For internal use only. This property is identified by Key::DriverKeyNameKey. Applies to: Usb
IsDriverKeyNameAvailable#
bool IsDriverKeyNameAvailable() const
Returns true if the above property is available. Applies to: Usb
GetUsbDriverType#
String_t GetUsbDriverType() const
Retrieves the usb driver type. For internal use only. This property is identified by Key::UsbDriverTypeKey. Applies to: Usb
IsUsbDriverTypeAvailable#
bool IsUsbDriverTypeAvailable() const
Returns true if the above property is available. Applies to: Usb
GetTransferMode#
String_t GetTransferMode() const
Applies to: Usb.
Retrieves the transfer mode. For internal use only. This property is identified by Key::TransferModeKey
IsTransferModeAvailable#
bool IsTransferModeAvailable() const
Returns true if the above property is available. Applies to: Usb
GetInternalName#
String_t GetInternalName() const
Retrieves the name of the device used by the underlying device driver. Internal use only. This property is identified by Key::InternalNameKey. Applies to: 1394
SetInternalName#
CDeviceInfo & SetInternalName(
const String_t & InternalNameValue
)
Sets the above property. Applies to: 1394
IsInternalNameAvailable#
bool IsInternalNameAvailable() const
Returns true if the above property is available. Applies to: 1394
GetPortID#
String_t GetPortID() const
Retrieves the ID of the serial port the device is connected to. This property is identified by Key::PortIDKey. Applies to: CameraLink
SetPortID#
CDeviceInfo & SetPortID(
const String_t & PortIDValue
)
Sets the above property. Applies to: CameraLink
IsPortIDAvailable#
bool IsPortIDAvailable() const
Returns true if the above property is available. Applies to: CameraLink
GetDeviceID#
String_t GetDeviceID() const
Retrieves the device ID. This property is identified by Key::DeviceIDKey. Applies to: CameraLink
SetDeviceID#
CDeviceInfo & SetDeviceID(
const String_t & DeviceIDValue
)
Sets the above property. Applies to: CameraLink
IsDeviceIDAvailable#
bool IsDeviceIDAvailable() const
Returns true if the above property is available. Applies to: CameraLink
GetInitialBaudRate#
String_t GetInitialBaudRate() const
Retrieves the initial baud rate of the serial port the device is connected to. This property is identified by Key::InitialBaudRateKey. Applies to: CameraLink
SetInitialBaudRate#
CDeviceInfo & SetInitialBaudRate(
const String_t & InitialBaudRateValue
)
Sets the above property. Applies to: CameraLink
IsInitialBaudRateAvailable#
bool IsInitialBaudRateAvailable() const
Returns true if the above property is available. Applies to: CameraLink
GetDeviceXMLFileOverride#
String_t GetDeviceXMLFileOverride() const
Retrieves the device xml file override used. Internal use only. This property is identified by Key::DeviceXMLFileOverrideKey. Applies to: CameraLink
SetDeviceXMLFileOverride#
CDeviceInfo & SetDeviceXMLFileOverride(
const String_t & DeviceXMLFileOverrideValue
)
Sets the above property. Applies to: CameraLink
IsDeviceXMLFileOverrideAvailable#
bool IsDeviceXMLFileOverrideAvailable() const
Returns true if the above property is available. Applies to: CameraLink
GetDeviceSpecificString#
String_t GetDeviceSpecificString() const
Retrieves the device specific string. Internal use only. This property is identified by Key::DeviceSpecificStringKey. Applies to: CameraLink
SetDeviceSpecificString#
CDeviceInfo & SetDeviceSpecificString(
const String_t & DeviceSpecificStringValue
)
Sets the above property. Applies to: CameraLink
IsDeviceSpecificStringAvailable#
bool IsDeviceSpecificStringAvailable() const
Returns true if the above property is available. Applies to: CameraLink
GetPortSpecificString#
String_t GetPortSpecificString() const
Retrieves the port specific string of the device. Internal use only. This property is identified by Key::PortSpecificStringKey. Applies to: CameraLink
SetPortSpecificString#
CDeviceInfo & SetPortSpecificString(
const String_t & PortSpecificStringValue
)
Sets the above property. Applies to: CameraLink
IsPortSpecificStringAvailable#
bool IsPortSpecificStringAvailable() const
Returns true if the above property is available. Applies to: CameraLink
SetPropertyValue#
inline virtual CDeviceInfo & SetPropertyValue(
const String_t & Name,
const String_t & Value
)
Reimplements: Pylon::CInfoBase::SetPropertyValue
Modifies a property value This method overrides a method of a base class returning a reference to CDeviceInfo
IsPersistentIpActive#
bool IsPersistentIpActive(
void
) const
Returns true when the device is configured for a persistent IP address.
IsDhcpActive#
bool IsDhcpActive(
void
) const
Returns true when the device is configured for using DHCP.
IsAutoIpActive#
bool IsAutoIpActive(
void
) const
Returns true when the device is configured for using Auto IP (aka LLA)
IsPersistentIpSupported#
bool IsPersistentIpSupported(
void
) const
Returns true when the device supports configuring a persistent IP address.
IsDhcpSupported#
bool IsDhcpSupported(
void
) const
Returns true when the device supports DHCP.
IsAutoIpSupported#
bool IsAutoIpSupported(
void
) const
Returns true when the device supports Auto IP (aka LLA)
IsSubset#
virtual bool IsSubset(
const IProperties & Subset
) const
Returns true when subset, applies special knowledge on how to compare GigE specific values.
Reimplements: Pylon::CInfoBase::IsSubset
operator==#
bool operator==(
const CInfoBase & rhs
) const
compare two info objects
operator<#
bool operator<(
const CInfoBase & rhs
) const
Compares CInfoBase objects by device class.
Parameters:
- rhs The right-hand side object of the comparison.
Return: Returns true according to this rule: USB < GigE < CameraLink < 1394 < GenTL (incl. CXP) < unknown device classes < CamEmu.
Error Safety:
Does not throw C++ exceptions.
GetFriendlyName#
String_t GetFriendlyName() const
Retrieves the human readable name of the device. This property is identified by Key::FriendlyNameKey.
IsFriendlyNameAvailable#
bool IsFriendlyNameAvailable() const
Returns true if the above property is available.
GetFullName#
String_t GetFullName() const
Retrieves the full name identifying the device. This property is identified by Key::FullNameKey.
IsFullNameAvailable#
bool IsFullNameAvailable() const
Returns true if the above property is available.
GetVendorName#
String_t GetVendorName() const
Retrieves the vendor name of the device. This property is identified by Key::VendorNameKey.
IsVendorNameAvailable#
bool IsVendorNameAvailable() const
Returns true if the above property is available.
GetDeviceClass#
String_t GetDeviceClass() const
Retrieves the device class device, e.g. Basler1394. This property is identified by Key::DeviceClassKey.
IsDeviceClassAvailable#
bool IsDeviceClassAvailable() const
Returns true if the above property is available.
GetTLType#
String_t GetTLType() const
Retrieves the transport layer type. This property is identified by Key::TLTypeKey.
SetTLType#
CInfoBase & SetTLType(
const String_t & value
)
Sets the above property.
IsTLTypeAvailable#
bool IsTLTypeAvailable() const
Returns true if the above property is available.
GetPropertyNames#
virtual int GetPropertyNames(
StringList_t &
) const
Retrieves a list of property names.
Reimplements: Pylon::IProperties::GetPropertyNames
GetPropertyAvailable#
virtual bool GetPropertyAvailable(
const String_t & Name
) const
Returns true if a property with the provided name is available.
Reimplements: Pylon::IProperties::GetPropertyAvailable
GetPropertyValue#
virtual bool GetPropertyValue(
const String_t & Name,
String_t & Value
) const
Retrieves a property value.
Reimplements: Pylon::IProperties::GetPropertyValue
IsUserProvided#
virtual bool IsUserProvided() const
GetPropertyNotAvailable#
static const char * GetPropertyNotAvailable()
Protected Functions Documentation#
SetDeviceGUID#
CDeviceInfo & SetDeviceGUID(
const String_t &
)
SetManufacturerInfo#
CDeviceInfo & SetManufacturerInfo(
const String_t &
)
SetDeviceIdx#
CDeviceInfo & SetDeviceIdx(
const String_t &
)
SetProductId#
CDeviceInfo & SetProductId(
const String_t &
)
SetVendorId#
CDeviceInfo & SetVendorId(
const String_t &
)
SetDriverKeyName#
CDeviceInfo & SetDriverKeyName(
const String_t &
)
SetUsbDriverType#
CDeviceInfo & SetUsbDriverType(
const String_t &
)
SetTransferMode#
CDeviceInfo & SetTransferMode(
const String_t &
)
Public Attributes Documentation#
PropertyNotAvailable#
static const char *const PropertyNotAvailable;
Protected Attributes Documentation#
m_pImpl#
CInfoImpl * m_pImpl;
Updated on 5 July 2022 at 15:30:01