Pylon::CDeviceInfo#

Module: Transport Layer

Holds information about an enumerated device. More…

#include <pylon/DeviceInfo.h>

Inherits from Pylon::CInfoBase, Pylon::IProperties

Public Functions#

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#

function 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 < GenTL (incl. CXP) < 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.

function GetSerialNumber#

String_t GetSerialNumber() const

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

function SetSerialNumber#

CDeviceInfo & SetSerialNumber(
    const String_t & SerialNumberValue
)

Sets the above property.

function IsSerialNumberAvailable#

bool IsSerialNumberAvailable() const

Returns true if the above property is available.

function GetUserDefinedName#

String_t GetUserDefinedName() const

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

function SetUserDefinedName#

CDeviceInfo & SetUserDefinedName(
    const String_t & UserDefinedNameValue
)

Sets the above property.

function IsUserDefinedNameAvailable#

bool IsUserDefinedNameAvailable() const

Returns true if the above property is available.

function GetModelName#

String_t GetModelName() const

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

function SetModelName#

CDeviceInfo & SetModelName(
    const String_t & ModelNameValue
)

Sets the above property.

function IsModelNameAvailable#

bool IsModelNameAvailable() const

Returns true if the above property is available.

function GetDeviceVersion#

String_t GetDeviceVersion() const

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

function SetDeviceVersion#

CDeviceInfo & SetDeviceVersion(
    const String_t & DeviceVersionValue
)

Sets the above property.

function IsDeviceVersionAvailable#

bool IsDeviceVersionAvailable() const

Returns true if the above property is available.

function GetDeviceFactory#

String_t GetDeviceFactory() const

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

function SetDeviceFactory#

CDeviceInfo & SetDeviceFactory(
    const String_t & DeviceFactoryValue
)

Sets the above property.

function IsDeviceFactoryAvailable#

bool IsDeviceFactoryAvailable() const

Returns true if the above property is available.

function 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.

function SetXMLSource#

CDeviceInfo & SetXMLSource(
    const String_t & XMLSource
)

Sets the above property.

function IsXMLSourceAvailable#

bool IsXMLSourceAvailable() const

Returns true if the above property is available.

function 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

function 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

function 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

function SetDeviceClass#

CDeviceInfo & SetDeviceClass(
    const String_t & DeviceClassValue
)

Sets the device class device, e.g. BaslerUsb. This property is identified by Key::DeviceClassKey. This method overrides a method of a base class returning a reference to CDeviceInfo

function GetInterfaceID#

String_t GetInterfaceID() const

Retrieves the ID of the interface that the device is connected to. This property is identified by Key::InterfaceIDKey.

function SetInterfaceID#

CDeviceInfo & SetInterfaceID(
    const String_t & InterfaceIDValue
)

Sets the above property.

function IsInterfaceIDAvailable#

bool IsInterfaceIDAvailable() const

Returns true if the above property is available.

function 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

function SetAddress#

CDeviceInfo & SetAddress(
    const String_t & AddressValue
)

Sets the above property. Applies to: GigE

function IsAddressAvailable#

bool IsAddressAvailable() const

Returns true if the above property is available. Applies to: GigE

function 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

function SetIpAddress#

CDeviceInfo & SetIpAddress(
    const String_t & IpAddressValue
)

Sets the above property. Applies to: GigE

function IsIpAddressAvailable#

bool IsIpAddressAvailable() const

Returns true if the above property is available. Applies to: GigE

function GetSubnetAddress#

String_t GetSubnetAddress() const

Retrieves the IP address of the subnet. This property is identified by Key::SubnetAddressKey Applies to: GigE

function SetSubnetAddress#

CDeviceInfo & SetSubnetAddress(
    const String_t & SubnetAddressValue
)

Sets the above property. Applies to: GigE

function IsSubnetAddressAvailable#

bool IsSubnetAddressAvailable() const

Returns true if the above property is available. Applies to: GigE

function 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

function SetDefaultGateway#

CDeviceInfo & SetDefaultGateway(
    const String_t & DefaultGatewayValue
)

Sets the above property. Applies to: GigE

function IsDefaultGatewayAvailable#

bool IsDefaultGatewayAvailable() const

Returns true if the above property is available. Applies to: GigE

function 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

function SetSubnetMask#

CDeviceInfo & SetSubnetMask(
    const String_t & SubnetMaskValue
)

Sets the above property. Applies to: GigE

function IsSubnetMaskAvailable#

bool IsSubnetMaskAvailable() const

Returns true if the above property is available. Applies to: GigE

function GetPortNr#

String_t GetPortNr() const

Retrieves the port number used. This property is identified by Key::PortNrKey. Applies to: GigE

function SetPortNr#

CDeviceInfo & SetPortNr(
    const String_t & PortNrValue
)

Sets the above property. Applies to: GigE

function IsPortNrAvailable#

bool IsPortNrAvailable() const

Returns true if the above property is available. Applies to: GigE

function 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

function SetMacAddress#

CDeviceInfo & SetMacAddress(
    const String_t & MacAddressValue
)

Sets the above property. Applies to: GigE

function IsMacAddressAvailable#

bool IsMacAddressAvailable() const

Returns true if the above property is available. Applies to: GigE

function 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

function SetInterface#

CDeviceInfo & SetInterface(
    const String_t & InterfaceValue
)

Sets the above property. Applies to: GigE

function IsInterfaceAvailable#

bool IsInterfaceAvailable() const

Returns true if the above property is available. Applies to: GigE

function GetIpConfigOptions#

String_t GetIpConfigOptions() const

Retrieves the persistent IP configuration options. This property is identified by Key::IpConfigOptionsKey. Applies to: GigE

function SetIpConfigOptions#

CDeviceInfo & SetIpConfigOptions(
    const String_t & IpConfigOptionsValue
)

Sets the above property. Applies to: GigE

function IsIpConfigOptionsAvailable#

bool IsIpConfigOptionsAvailable() const

Returns true if the above property is available. Applies to: GigE

function GetIpConfigCurrent#

String_t GetIpConfigCurrent() const

Retrieves the current IP configuration of the device. This property is identified by Key::IpConfigCurrentKey. Applies to: GigE

function SetIpConfigCurrent#

CDeviceInfo & SetIpConfigCurrent(
    const String_t & IpConfigCurrentValue
)

Sets the above property. Applies to: GigE

function IsIpConfigCurrentAvailable#

bool IsIpConfigCurrentAvailable() const

Returns true if the above property is available. Applies to: GigE

function GetDeviceGUID#

String_t GetDeviceGUID() const

Retrieves the device GUID. This property is identified by Key::DeviceGUIDKey. Applies to: Usb

function IsDeviceGUIDAvailable#

bool IsDeviceGUIDAvailable() const

Returns true if the above property is available. Applies to: Usb

function GetManufacturerInfo#

String_t GetManufacturerInfo() const

Retrieves the manufacturer info. This property is identified by Key::ManufacturerInfoKey. Applies to: Usb

function IsManufacturerInfoAvailable#

bool IsManufacturerInfoAvailable() const

Returns true if the above property is available. Applies to: Usb

function GetDeviceIdx#

String_t GetDeviceIdx() const

Retrieves the device index. For internal use only. This property is identified by Key::DeviceIdxKey. Applies to: Usb

function IsDeviceIdxAvailable#

bool IsDeviceIdxAvailable() const

Returns true if the above property is available. Applies to: Usb

function GetProductId#

String_t GetProductId() const

Retrieves the product ID. For internal use only. This property is identified by Key::ProductIdKey. Applies to: Usb

function IsProductIdAvailable#

bool IsProductIdAvailable() const

Returns true if the above property is available. Applies to: Usb

function GetVendorId#

String_t GetVendorId() const

Retrieves the vendor ID. For internal use only. This property is identified by Key::VendorIdKey. Applies to: Usb

function IsVendorIdAvailable#

bool IsVendorIdAvailable() const

Returns true if the above property is available. Applies to: Usb

function GetDriverKeyName#

String_t GetDriverKeyName() const

Retrieves the driver key name. For internal use only. This property is identified by Key::DriverKeyNameKey. Applies to: Usb

function IsDriverKeyNameAvailable#

bool IsDriverKeyNameAvailable() const

Returns true if the above property is available. Applies to: Usb

function GetUsbDriverType#

String_t GetUsbDriverType() const

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

function IsUsbDriverTypeAvailable#

bool IsUsbDriverTypeAvailable() const

Returns true if the above property is available. Applies to: Usb

function GetTransferMode#

String_t GetTransferMode() const

Applies to: Usb.

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

function IsTransferModeAvailable#

bool IsTransferModeAvailable() const

Returns true if the above property is available. Applies to: Usb

function 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

function SetPortID#

CDeviceInfo & SetPortID(
    const String_t & PortIDValue
)

Sets the above property. Applies to: CameraLink

function IsPortIDAvailable#

bool IsPortIDAvailable() const

Returns true if the above property is available. Applies to: CameraLink

function GetDeviceID#

String_t GetDeviceID() const

Retrieves the device ID. This property is identified by Key::DeviceIDKey. Applies to: CameraLink

function SetDeviceID#

CDeviceInfo & SetDeviceID(
    const String_t & DeviceIDValue
)

Sets the above property. Applies to: CameraLink

function IsDeviceIDAvailable#

bool IsDeviceIDAvailable() const

Returns true if the above property is available. Applies to: CameraLink

function 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

function SetInitialBaudRate#

CDeviceInfo & SetInitialBaudRate(
    const String_t & InitialBaudRateValue
)

Sets the above property. Applies to: CameraLink

function IsInitialBaudRateAvailable#

bool IsInitialBaudRateAvailable() const

Returns true if the above property is available. Applies to: CameraLink

function 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

function SetDeviceXMLFileOverride#

CDeviceInfo & SetDeviceXMLFileOverride(
    const String_t & DeviceXMLFileOverrideValue
)

Sets the above property. Applies to: CameraLink

function IsDeviceXMLFileOverrideAvailable#

bool IsDeviceXMLFileOverrideAvailable() const

Returns true if the above property is available. Applies to: CameraLink

function GetDeviceSpecificString#

String_t GetDeviceSpecificString() const

Retrieves the device specific string. Internal use only. This property is identified by Key::DeviceSpecificStringKey. Applies to: CameraLink

function SetDeviceSpecificString#

CDeviceInfo & SetDeviceSpecificString(
    const String_t & DeviceSpecificStringValue
)

Sets the above property. Applies to: CameraLink

function IsDeviceSpecificStringAvailable#

bool IsDeviceSpecificStringAvailable() const

Returns true if the above property is available. Applies to: CameraLink

function 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

function SetPortSpecificString#

CDeviceInfo & SetPortSpecificString(
    const String_t & PortSpecificStringValue
)

Sets the above property. Applies to: CameraLink

function IsPortSpecificStringAvailable#

bool IsPortSpecificStringAvailable() const

Returns true if the above property is available. Applies to: CameraLink

function 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

function IsPersistentIpActive#

bool IsPersistentIpActive(
    void
) const

Returns true when the device is configured for a persistent IP address.

function IsDhcpActive#

bool IsDhcpActive(
    void
) const

Returns true when the device is configured for using DHCP.

function IsAutoIpActive#

bool IsAutoIpActive(
    void
) const

Returns true when the device is configured for using Auto IP (aka LLA)

function IsPersistentIpSupported#

bool IsPersistentIpSupported(
    void
) const

Returns true when the device supports configuring a persistent IP address.

function IsDhcpSupported#

bool IsDhcpSupported(
    void
) const

Returns true when the device supports DHCP.

function IsAutoIpSupported#

bool IsAutoIpSupported(
    void
) const

Returns true when the device supports Auto IP (aka LLA)

function 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

function operator==#

bool operator==(
    const CInfoBase & rhs
) const

compare two info objects

function 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 < GenTL (incl. CXP) < unknown device classes < CamEmu.

Error Safety:

Does not throw C++ exceptions.

function GetFriendlyName#

String_t GetFriendlyName() const

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

function IsFriendlyNameAvailable#

bool IsFriendlyNameAvailable() const

Returns true if the above property is available.

function GetFullName#

String_t GetFullName() const

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

function IsFullNameAvailable#

bool IsFullNameAvailable() const

Returns true if the above property is available.

function GetVendorName#

String_t GetVendorName() const

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

function IsVendorNameAvailable#

bool IsVendorNameAvailable() const

Returns true if the above property is available.

function GetDeviceClass#

String_t GetDeviceClass() const

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

function IsDeviceClassAvailable#

bool IsDeviceClassAvailable() const

Returns true if the above property is available.

function GetTLType#

String_t GetTLType() const

Retrieves the transport layer type. This property is identified by Key::TLTypeKey.

function SetTLType#

CInfoBase & SetTLType(
    const String_t & value
)

Sets the above property.

function IsTLTypeAvailable#

bool IsTLTypeAvailable() const

Returns true if the above property is available.

function GetPropertyNames#

virtual int GetPropertyNames(
    StringList_t &
) const

Retrieves a list of property names.

Reimplements: Pylon::IProperties::GetPropertyNames

function GetPropertyAvailable#

virtual bool GetPropertyAvailable(
    const String_t & Name
) const

Returns true if a property with the provided name is available.

Reimplements: Pylon::IProperties::GetPropertyAvailable

function GetPropertyValue#

virtual bool GetPropertyValue(
    const String_t & Name,
    String_t & Value
) const

Retrieves a property value.

Reimplements: Pylon::IProperties::GetPropertyValue