Skip to content

Pylon::CInfoBase#

Base implementation for PYLON info container. More…

#include <pylon/Info.h>

Inherits from Pylon::IProperties

Inherited by Pylon::CDeviceInfo, Pylon::CInterfaceInfo, Pylon::CTlInfo

Public Functions#

Name
CInfoBase & operator=(const CInfoBase & )
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()

Protected Functions#

Name
CInfoBase()
CInfoBase(const CInfoBase & )
virtual ~CInfoBase()

Public Attributes#

Name
const char *const PropertyNotAvailable

Protected Attributes#

Name
CInfoImpl * m_pImpl

Detailed Description#

class Pylon::CInfoBase;

Base implementation for PYLON info container.

Info container allow a generic access to implemented properties. All Properties and their values can be accessed without knowing them in advance. It is possible to enumerate all properties available and corresponding values. Properties and values are represented as String_t. The normal usage is to have enumerators that create the info objects and clients that read only.

If the type of the info object is known before client can use specific accessor function to retrieve the property values

Public Functions Documentation#

operator=#

CInfoBase & operator=(
    const CInfoBase & 
)

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()

Protected Functions Documentation#

CInfoBase#

CInfoBase()

CInfoBase#

CInfoBase(
    const CInfoBase & 
)

~CInfoBase#

virtual ~CInfoBase()

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