A simple pixeltypemapper (maps device specific pixelformats read from device-node map to pylon pixeltypes by their name). More...
#include <pylon/PixelTypeMapper.h>
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... | |
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.
Pylon::CPixelTypeMapper::CPixelTypeMapper | ( | void | ) |
Create an empty mapper. Before calling any non-static function you must call SetPixelFormatEnumNode to initialize the mapper.
|
static |
Static function that returns a string representation of the given EPixelType.
pixelType | The pixel type to return the name for. |
sfncVer | SFNC Version to use when doing the mapping. Some names have been changed in SFNC 2.0 |
Passing Pylon::PixelType_Mono16 will return "Mono16" will be returned. If the pixel type is not known an empty string is returned.
|
static |
Returns a Pylon::EPixelType for a given symbolic name.
pszSymbolicName | pointer to the symbolic name. Note: Symbolic names are case sensitive. You can obtain the symbolic name by calling GENAPI_NAMESPACE::IEnumEntry::GetSymbolic() |
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.
|
inlinestatic |
Returns a Pylon::EPixelType for a given symbolic name.
symbolicName | The symbolic name. Note: Symbolic names are case sensitive. You can obtain the symbolic name by calling GENAPI_NAMESPACE::IEnumEntry::GetSymbolic() |
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.
nodeValue | node value to convert. You can obtain this value by calling GENAPI_NAMESPACE::IEnumeration::GetIntValue. |
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.
Essentially this function checks whether you've called SetPixelFormatEnumNode.
void Pylon::CPixelTypeMapper::SetPixelFormatEnumNode | ( | GenApi::IEnumeration * | pEnum | ) |
Lazy initialization of the object.
pEnum | Pointer to the enumeration node containing the PixelFormats. |
Call this function initialize the mapper when using the default c'tor.