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

Base implementation for PYLON info container. More...

#include <pylon/Info.h>

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

Public Member Functions

bool operator== (const CInfoBase &rhs) const
 compare two info objects
 
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

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

Member Function Documentation

String_t Pylon::CInfoBase::GetDeviceClass ( ) const

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

String_t Pylon::CInfoBase::GetFriendlyName ( ) const

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

String_t Pylon::CInfoBase::GetFullName ( ) const

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

String_t Pylon::CInfoBase::GetVendorName ( ) const

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

virtual bool Pylon::CInfoBase::IsSubset ( const IProperties Subset) const
virtual

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.


The documentation for this class was generated from the following file:

pylon 5.0.5
Copyright © 2006-2016 Basler AG (Thu Aug 11 2016 18:01:28)