Pylon::CInterfaceInfo#

Class used for storing information about an interface object provided by a transport layer. More…

#include <pylon/InterfaceInfo.h>

Inherits from Pylon::CInfoBase, Pylon::IProperties

Public Functions#

Detailed Description#

class Pylon::CInterfaceInfo;

Class used for storing information about an interface object provided by a transport layer.

Enumerating the available Transport Layer Interface objects returns a list of CInterface objects (Pylon::InterfaceInfoList_t). A CInterfaceInfo object holds information about the enumerated interface.

Public Functions Documentation#

function CInterfaceInfo#

CInterfaceInfo()

Creates an empty interface info.

Error Safety:

Does not throw C++ exceptions.

function CInterfaceInfo#

CInterfaceInfo(
    const CInterfaceInfo &
)

Copy constructor.

function ~CInterfaceInfo#

~CInterfaceInfo()

Destructor.

function operator<#

bool operator<(
    const CInterfaceInfo & rhs
) const

Compares CInterfaceInfo objects by device class and interface ID.

Parameters:

• rhs The right-hand side object of the comparison.

Return: Returns true according to this rule: USB < GigE < CameraLink < Less than compare of device class text < CamEmu. CInterfaceInfo objects of the same transport layer are compared by interface ID using less than text comparison.

Error Safety:

Does not throw C++ exceptions.

function GetInterfaceID#

String_t GetInterfaceID() const

Retrieves the interface ID identifying the interface. This property is identified by Key::InterfaceIDKey.

function SetInterfaceID#

CInterfaceInfo & SetInterfaceID(
    const String_t & InterfaceIDValue
)

Sets the above property.

function IsInterfaceIDAvailable#

bool IsInterfaceIDAvailable() const

Returns true if the above property is available.

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 SetFriendlyName#

CInfoBase & SetFriendlyName(
    const String_t & FriendlyNameValue
)

Sets the above property.

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 SetFullName#

CInfoBase & SetFullName(
    const String_t & FullNameValue
)

Sets the above property.

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 SetVendorName#

CInfoBase & SetVendorName(
    const String_t & VendorNameValue
)

Sets the above property.

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 SetDeviceClass#

CInfoBase & SetDeviceClass(
    const String_t & DeviceClassValue
)

Sets the above property.

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

function SetPropertyValue#

virtual IProperties & SetPropertyValue(
    const String_t & Name,
    const String_t & Value
)

Modifies a property value.

Reimplements: Pylon::IProperties::SetPropertyValue

Reimplemented by: Pylon::CDeviceInfo::SetPropertyValue

function IsSubset#

virtual bool IsSubset(
    const IProperties & Subset
) const

Reimplements: Pylon::IProperties::IsSubset

Reimplemented by: Pylon::CDeviceInfo::IsSubset

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