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

A simple pixeltypemapper (maps device specific pixelformats read from device-node map to pylon pixeltypes by their name). More...

#include <pylon/PixelTypeMapper.h>

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

Public Member Functions

 CPixelTypeMapper (void)
 
 CPixelTypeMapper (GenApi::IEnumeration *pEnum)
 create and initialize a mapper by using the enum node passed.
 
virtual ~CPixelTypeMapper (void)
 default d'tor
 
bool IsValid () const
 Checks the objects validity. More...
 
void SetPixelFormatEnumNode (GenApi::IEnumeration *pEnum)
 Lazy initialization of the object. More...
 
EPixelType GetPylonPixelTypeFromNodeValue (int64_t nodeValue) const
 Converts a enumeration node value to a Pylon::EPixelType enum. More...
 

Static Public Member Functions

static EPixelType GetPylonPixelTypeByName (const char *pszSymbolicName)
 Returns a Pylon::EPixelType for a given symbolic name. More...
 
static EPixelType GetPylonPixelTypeByName (const String_t &symbolicName)
 Returns a Pylon::EPixelType for a given symbolic name. More...
 
static const char * GetNameByPixelType (EPixelType pixelType, SFNCVersion sfncVer=SFNCVersion_pre2_0)
 Static function that returns a string representation of the given EPixelType. More...
 

Detailed Description

A simple pixeltypemapper (maps device specific pixelformats read from device-node map to pylon pixeltypes by their name).

Use this mapper to convert a device specifc Pylon::PixelFormat value to a Pylon::EPixelType used for PixelFormatConverters. When passing the symbolic name of the pixeltype you can use the static function CPixelTypeMapper::GetPylonPixelTypeByName(). If you want to convert a nodeValue you must first create a CPixelTypeMapper instance and pass the constructor a pointer the PixelFormat node of the device you want the node value to be converted. Then call CPixelTypeMapper::GetPylonPixelTypeFromNodeValue() to get the corresponding Pylon::EPixelType.

Constructor & Destructor Documentation

Pylon::CPixelTypeMapper::CPixelTypeMapper ( void  )

Create an empty mapper. Before calling any non-static function you must call SetPixelFormatEnumNode to initialize the mapper.

Member Function Documentation

static const char* Pylon::CPixelTypeMapper::GetNameByPixelType ( EPixelType  pixelType,
SFNCVersion  sfncVer = SFNCVersion_pre2_0 
)
static

Static function that returns a string representation of the given EPixelType.

Parameters
pixelTypeThe pixel type to return the name for.
sfncVerSFNC Version to use when doing the mapping. Some names have been changed in SFNC 2.0
Returns
Returns the pointer to a null terminated string representing the symbolic name of the pixel type.

Passing Pylon::PixelType_Mono16 will return "Mono16" will be returned. If the pixel type is not known an empty string is returned.

Note
The returned name cannot be used to parameterize the pixel format of a camera device, because the camera's pixel format name can be different. The camera's pixel format name depends on the used standard feature naming convention (SFNC).
static EPixelType Pylon::CPixelTypeMapper::GetPylonPixelTypeByName ( const char *  pszSymbolicName)
static

Returns a Pylon::EPixelType for a given symbolic name.

Parameters
pszSymbolicNamepointer to the symbolic name. Note: Symbolic names are case sensitive. You can obtain the symbolic name by calling GENAPI_NAMESPACE::IEnumEntry::GetSymbolic()
Returns
Returns the Pylon_PixelType for a given symbolic name.

Static version which does the lookup soley by symbolic string comparison. Passing "Mono16" will return Pylon::PixelType_Mono16. If the name is not found Pylon::PixelType_Undefined will be returned.

static EPixelType Pylon::CPixelTypeMapper::GetPylonPixelTypeByName ( const String_t symbolicName)
inlinestatic

Returns a Pylon::EPixelType for a given symbolic name.

Parameters
symbolicNameThe symbolic name. Note: Symbolic names are case sensitive. You can obtain the symbolic name by calling GENAPI_NAMESPACE::IEnumEntry::GetSymbolic()
Returns
Returns the Pylon_PixelType for a given symbolic name.

Static version which does the lookup solely by symbolic string comparison. Passing "Mono16" will return Pylon::PixelType_Mono16. If the name is not found Pylon::PixelType_Undefined will be returned.

EPixelType Pylon::CPixelTypeMapper::GetPylonPixelTypeFromNodeValue ( int64_t  nodeValue) const

Converts a enumeration node value to a Pylon::EPixelType enum.

Parameters
nodeValuenode value to convert. You can obtain this value by calling GENAPI_NAMESPACE::IEnumeration::GetIntValue.
Returns
Returns the Pylon::EPixelType for a given pixelformat enum value defined in the Enum passed in c'tor

Converts a enumeration node value to a Pylon::EPixelType enum. You must have initialized the mapper before you can call this function.

bool Pylon::CPixelTypeMapper::IsValid ( ) const

Checks the objects validity.

Returns
Returns true if the object is initialized properly.

Essentially this function checks whether you've called SetPixelFormatEnumNode.

void Pylon::CPixelTypeMapper::SetPixelFormatEnumNode ( GenApi::IEnumeration *  pEnum)

Lazy initialization of the object.

Parameters
pEnumPointer to the enumeration node containing the PixelFormats.

Call this function initialize the mapper when using the default c'tor.


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)