Pylon::CInterfaceInfo#
#include <pylon/InterfaceInfo.h>
Inherits from Pylon::CInfoBase, Pylon::IProperties
Public Functions#
Name | |
---|---|
CInterfaceInfo() Creates an empty interface info. | |
CInterfaceInfo(const CInterfaceInfo & ) Copy constructor. | |
~CInterfaceInfo() Destructor. | |
bool | operator<(const CInterfaceInfo & rhs) const Compares CInterfaceInfo objects by device class and interface ID. |
String_t | GetInterfaceID() const |
CInterfaceInfo & | SetInterfaceID(const String_t & InterfaceIDValue) Sets the above property. |
bool | IsInterfaceIDAvailable() const Returns true if the above property is available. |
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 |
CInfoBase & | SetFriendlyName(const String_t & FriendlyNameValue) Sets the above property. |
bool | IsFriendlyNameAvailable() const Returns true if the above property is available. |
String_t | GetFullName() const |
CInfoBase & | SetFullName(const String_t & FullNameValue) Sets the above property. |
bool | IsFullNameAvailable() const Returns true if the above property is available. |
String_t | GetVendorName() const |
CInfoBase & | SetVendorName(const String_t & VendorNameValue) Sets the above property. |
bool | IsVendorNameAvailable() const Returns true if the above property is available. |
String_t | GetDeviceClass() const |
CInfoBase & | SetDeviceClass(const String_t & DeviceClassValue) Sets the above property. |
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 IProperties & | SetPropertyValue(const String_t & Name, const String_t & Value) Modifies a property value. |
virtual bool | IsUserProvided() const |
virtual bool | IsSubset(const IProperties & Subset) const |
const char * | GetPropertyNotAvailable() |
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::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#
CInterfaceInfo#
CInterfaceInfo()
Creates an empty interface info.
Error Safety:
Does not throw C++ exceptions.
CInterfaceInfo#
CInterfaceInfo(
const CInterfaceInfo &
)
Copy constructor.
~CInterfaceInfo#
~CInterfaceInfo()
Destructor.
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 < 1394 < 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.
GetInterfaceID#
String_t GetInterfaceID() const
Retrieves the interface ID identifying the interface. This property is identified by Key::InterfaceIDKey.
SetInterfaceID#
CInterfaceInfo & SetInterfaceID(
const String_t & InterfaceIDValue
)
Sets the above property.
IsInterfaceIDAvailable#
bool IsInterfaceIDAvailable() const
Returns true if the above property is available.
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.
SetFriendlyName#
CInfoBase & SetFriendlyName(
const String_t & FriendlyNameValue
)
Sets the above property.
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.
SetFullName#
CInfoBase & SetFullName(
const String_t & FullNameValue
)
Sets the above property.
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.
SetVendorName#
CInfoBase & SetVendorName(
const String_t & VendorNameValue
)
Sets the above property.
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.
SetDeviceClass#
CInfoBase & SetDeviceClass(
const String_t & DeviceClassValue
)
Sets the above property.
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
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
IsUserProvided#
virtual bool IsUserProvided() const
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
GetPropertyNotAvailable#
static const char * GetPropertyNotAvailable()
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:00