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

Implementation of the GiGE specific device info object. More...

#include <pylon/gige/BaslerGigEDeviceInfo.h>

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

Public Member Functions

String_t GetAddress () const
 
CBaslerGigEDeviceInfoSetAddress (const String_t &AddressValue)
 Sets the above property.
 
bool IsAddressAvailable () const
 Returns true if the above property is available.
 
String_t GetIpAddress () const
 
CBaslerGigEDeviceInfoSetIpAddress (const String_t &IpAddressValue)
 Sets the above property.
 
bool IsIpAddressAvailable () const
 Returns true if the above property is available.
 
String_t GetSubnetAddress () const
 
CBaslerGigEDeviceInfoSetSubnetAddress (const String_t &SubnetAddressValue)
 Sets the above property.
 
bool IsSubnetAddressAvailable () const
 Returns true if the above property is available.
 
String_t GetDefaultGateway () const
 
CBaslerGigEDeviceInfoSetDefaultGateway (const String_t &DefaultGatewayValue)
 Sets the above property.
 
bool IsDefaultGatewayAvailable () const
 Returns true if the above property is available.
 
String_t GetSubnetMask () const
 
CBaslerGigEDeviceInfoSetSubnetMask (const String_t &SubnetMaskValue)
 Sets the above property.
 
bool IsSubnetMaskAvailable () const
 Returns true if the above property is available.
 
String_t GetPortNr () const
 
CBaslerGigEDeviceInfoSetPortNr (const String_t &PortNrValue)
 Sets the above property.
 
bool IsPortNrAvailable () const
 Returns true if the above property is available.
 
String_t GetMacAddress () const
 
CBaslerGigEDeviceInfoSetMacAddress (const String_t &MacAddressValue)
 Sets the above property.
 
bool IsMacAddressAvailable () const
 Returns true if the above property is available.
 
String_t GetInterface () const
 
CBaslerGigEDeviceInfoSetInterface (const String_t &InterfaceValue)
 Sets the above property.
 
bool IsInterfaceAvailable () const
 Returns true if the above property is available.
 
String_t GetIpConfigOptions () const
 
CBaslerGigEDeviceInfoSetIpConfigOptions (const String_t &IpConfigOptionsValue)
 Sets the above property.
 
bool IsIpConfigOptionsAvailable () const
 Returns true if the above property is available.
 
String_t GetIpConfigCurrent () const
 
CBaslerGigEDeviceInfoSetIpConfigCurrent (const String_t &IpConfigCurrentValue)
 Sets the above property.
 
bool IsIpConfigCurrentAvailable () const
 Returns true if the above property is available.
 
bool IsPersistentIpActive (void) const
 Returns true when the device is configured for a persistent IP address.
 
bool IsDhcpActive (void) const
 Returns true when the device is configured for using DHCP.
 
bool IsAutoIpActive (void) const
 Returns true when the device is configured for using Auto IP (aka LLA)
 
bool IsPersistentIpSupported (void) const
 Returns true when the device supports configuring a persistent IP address.
 
bool IsDhcpSupported (void) const
 Returns true when the device supports DHCP.
 
bool IsAutoIpSupported (void) const
 Returns true when the device supports Auto IP (aka LLA)
 
virtual bool IsSubset (const IProperties &Subset) const
 Returns true when subset, applies special knowledge on how to compare GigE specific values.
 
String_t GetSerialNumber () const
 
CDeviceInfoSetSerialNumber (const String_t &SerialNumberValue)
 Sets the above property.
 
bool IsSerialNumberAvailable () const
 Returns true if the above property is available.
 
String_t GetUserDefinedName () const
 
CDeviceInfoSetUserDefinedName (const String_t &UserDefinedNameValue)
 Sets the above property.
 
bool IsUserDefinedNameAvailable () const
 Returns true if the above property is available.
 
String_t GetModelName () const
 
CDeviceInfoSetModelName (const String_t &ModelNameValue)
 Sets the above property.
 
bool IsModelNameAvailable () const
 Returns true if the above property is available.
 
String_t GetDeviceVersion () const
 
CDeviceInfoSetDeviceVersion (const String_t &DeviceVersionValue)
 Sets the above property.
 
bool IsDeviceVersionAvailable () const
 Returns true if the above property is available.
 
String_t GetDeviceFactory () const
 
CDeviceInfoSetDeviceFactory (const String_t &DeviceFactoryValue)
 Sets the above property.
 
bool IsDeviceFactoryAvailable () const
 Returns true if the above property is available.
 
String_t GetXMLSource () const
 
CDeviceInfoSetXMLSource (const String_t &XMLSource)
 Sets the above property.
 
bool IsXMLSourceAvailable () const
 Returns true if the above property is available.
 
CDeviceInfoSetFriendlyName (const String_t &FriendlyNameValue)
 
CDeviceInfoSetFullName (const String_t &FullNameValue)
 
CDeviceInfoSetVendorName (const String_t &VendorNameValue)
 
CDeviceInfoSetDeviceClass (const String_t &DeviceClassValue)
 
virtual CDeviceInfoSetPropertyValue (const String_t &Name, const String_t &Value)
 
bool operator== (const CInfoBase &rhs) const
 compare two info objects
 
String_t GetFriendlyName () const
 
bool IsFriendlyNameAvailable () const
 Returns true if the above property is available.
 
String_t GetFullName () const
 
bool IsFullNameAvailable () const
 Returns true if the above property is available.
 
String_t GetVendorName () const
 
bool IsVendorNameAvailable () const
 Returns true if the above property is available.
 
String_t GetDeviceClass () const
 
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.
 

Detailed Description

Implementation of the GiGE specific device info object.

Enhances the general CDeviceInfo by the attributes Address and Interface. Address is the device IP number, Interface is the IP number of the connected interface.

Member Function Documentation

String_t Pylon::CBaslerGigEDeviceInfo::GetAddress ( ) const

Retrieves the IP address the device IP address in a human-readable representation including the port number. This property is identified by Key::AddressKey.

String_t Pylon::CBaslerGigEDeviceInfo::GetDefaultGateway ( ) const

Retrieves the default gateway the device IP address in a human-readable representation. This property is identified by Key::DefaultGatewayKey.

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::CDeviceInfo::GetDeviceFactory ( ) const
inherited

Retrieves the identifier for the transport layer able to create this device. This property is identified by Key::DeviceFactoryKey.

String_t Pylon::CDeviceInfo::GetDeviceVersion ( ) const
inherited

Retrieves the version string of the device. This property is identified by Key::DeviceVersionKey.

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::CBaslerGigEDeviceInfo::GetInterface ( ) const

Retrieves the address of the network interface the device is connected. This property is identified by Key::InterfaceKey.

String_t Pylon::CBaslerGigEDeviceInfo::GetIpAddress ( ) const

Retrieves the IP address the device IP address in a human-readable representation. This property is identified by Key::IpAddressKey.

String_t Pylon::CBaslerGigEDeviceInfo::GetIpConfigCurrent ( ) const

Retrieves the current IP configuration of the device. This property is identified by Key::IpConfigCurrentKey.

String_t Pylon::CBaslerGigEDeviceInfo::GetIpConfigOptions ( ) const

Retrieves the persistent IP configuration options. This property is identified by Key::IpConfigOptionsKey.

String_t Pylon::CBaslerGigEDeviceInfo::GetMacAddress ( ) const

Retrieves the MAC address of the device the device IP address in a human-readable representation. This property is identified by Key::MacAddressKey.

String_t Pylon::CDeviceInfo::GetModelName ( ) const
inherited

Retrieves the model name of the device. This property is identified by Key::ModelNameKey.

String_t Pylon::CBaslerGigEDeviceInfo::GetPortNr ( ) const

Retrieves the port number used. This property is identified by Key::PortNrKey.

String_t Pylon::CDeviceInfo::GetSerialNumber ( ) const
inherited

Retrieves the serial number if it supported by the underlying implementation This property is identified by Key::SerialNumberKey.

String_t Pylon::CBaslerGigEDeviceInfo::GetSubnetAddress ( ) const

Retrieves the IP address of the subnet. This property is identified by Key::SubnetAddressKey

String_t Pylon::CBaslerGigEDeviceInfo::GetSubnetMask ( ) const

Retrieves the subnet mask the device IP address in a human-readable representation. This property is identified by Key::SubnetMaskKey.

String_t Pylon::CDeviceInfo::GetUserDefinedName ( ) const
inherited

Retrieves the user-defined name if present. This property is identified by Key::UserDefinedNameKey.

String_t Pylon::CInfoBase::GetVendorName ( ) const
inherited

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

String_t Pylon::CDeviceInfo::GetXMLSource ( ) const
inherited

Retrieves the location where the XML file was loaded from. This property is identified by Key::XMLSourceKey. You must use the DeviceInfo of an opened IPylonDevice to retrieve this property.

CDeviceInfo& Pylon::CDeviceInfo::SetDeviceClass ( const String_t DeviceClassValue)
inherited

Sets the device class device, e.g. Basler1394. This property is identified by Key::DeviceClassKey. This method overrides a method of a base class returning a reference to CDeviceInfo

CDeviceInfo& Pylon::CDeviceInfo::SetFriendlyName ( const String_t FriendlyNameValue)
inherited

Sets the display friendly name of the device. This property is identified by Key::FriendlyNameKey. This method overrides a method of a base class returning a reference to CDeviceInfo

CDeviceInfo& Pylon::CDeviceInfo::SetFullName ( const String_t FullNameValue)
inherited

Sets the full name identifying the device. This property is identified by Key::FullNameKey. This method overrides a method of a base class returning a reference to CDeviceInfo

virtual CDeviceInfo& Pylon::CDeviceInfo::SetPropertyValue ( const String_t Name,
const String_t Value 
)
inlinevirtualinherited

Modifies a property value This method overrides a method of a base class returning a reference to CDeviceInfo

Reimplemented from Pylon::CInfoBase.

CDeviceInfo& Pylon::CDeviceInfo::SetVendorName ( const String_t VendorNameValue)
inherited

Sets the vendor name of the device. This property is identified by Key::VendorNameKey. This method overrides a method of a base class returning a reference to CDeviceInfo


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