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

Class used for storing the result of the transport layer enumeration process. More...

#include <pylon/TlInfo.h>

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

Public Member Functions

bool operator== (const CInfoBase &rhs) const
 compare two info objects
 
bool operator< (const CInfoBase &rhs) const
 Compares CInfoBase objects by device class. More...
 
String_t GetFriendlyName () const
 
CInfoBaseSetFriendlyName (const String_t &FriendlyNameValue)
 Sets the above property.
 
bool IsFriendlyNameAvailable () const
 Returns true if the above property is available.
 
String_t GetFullName () const
 
CInfoBaseSetFullName (const String_t &FullNameValue)
 Sets the above property.
 
bool IsFullNameAvailable () const
 Returns true if the above property is available.
 
String_t GetVendorName () const
 
CInfoBaseSetVendorName (const String_t &VendorNameValue)
 Sets the above property.
 
bool IsVendorNameAvailable () const
 Returns true if the above property is available.
 
String_t GetDeviceClass () const
 
CInfoBaseSetDeviceClass (const String_t &DeviceClassValue)
 Sets the above property.
 
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 IPropertiesSetPropertyValue (const String_t &Name, const String_t &Value)
 Modifies a property value.
 
virtual bool IsSubset (const IProperties &Subset) const
 

Detailed Description

Class used for storing the result of the transport layer enumeration process.

Enumerating the available Transport Layer objects returns a list of CTlInfo objects (Pylon::TlInfoList_t). A CTlInfo object holds information about the enumerated transport layer.

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::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::CInfoBase::GetVendorName ( ) const
inherited

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

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

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:58)