Namespaces
namespace	AdvancedFunctions

namespace	AI

namespace	Base

namespace	Devices

namespace	Foundation

namespace	GUI

namespace	ImageProcessing

namespace	ThreeDim

Classes
class	CResult
	FLImaging module execution result object. More...

Enumerations
enum	EResult { EResult_UnknownError = -1 , EResult_OK = 0 , EResult_PartialOK , EResult_FailedToInitialize , EResult_FailedToTerminate , EResult_NeedToInitialize , EResult_NeedToTerminate , EResult_FailedToCreateThread , EResult_FailedToSuspendThread , EResult_FailedToResumeThread , EResult_FailedToCreateDevice , EResult_FailedToCreateKernelObject , EResult_FailedToCreateObject , EResult_InvalidParameter , EResult_NullPointer , EResult_NotEnoughMemory , EResult_BufferDoesNotExist , EResult_NoData , EResult_OutOfRange , EResult_NoResult , EResult_EmptyElement , EResult_InvalidHandle , EResult_FailedToModify , EResult_InvalidItem , EResult_LackOfBasicData , EResult_ZeroSize , EResult_CountMismatch , EResult_InvalidData , EResult_FailedToOpen , EResult_FailedToRead , EResult_FailedToWrite , EResult_InvalidFile , EResult_FailedToSend , EResult_FailedToReceive , EResult_FailedToBind , EResult_FailedToListen , EResult_FailedToConnect , EResult_FailedToSetParam , EResult_FailedToProcess , EResult_UnsupportedDepth , EResult_UnsupportedChannels , EResult_Timeout , EResult_UnsupportedVersion , EResult_InvalidObject , EResult_DifferentChannel , EResult_DifferentDepth , EResult_UnsupportedRegionOfInterest , EResult_DidNotImplement , EResult_UnsupportedFormat , EResult_FileNotFound , EResult_ClassTypeDoesNotMatch , EResult_CouldNotFindLicense , EResult_DifferentType , EResult_CouldNotFind , EResult_UnsupportedFunction , EResult_TooSmall , EResult_NotEnoughMappingData , EResult_CanBeInaccurate , EResult_FailedToExecute , EResult_FailedToCalculate , EResult_UnsupportedType , EResult_DifferentTemplate , EResult_InvalidElement , EResult_NoCollision , EResult_FailedToFind , EResult_FailedToLoad , EResult_FailedToCreate , EResult_FailedToSearch , EResult_FailedToStop , EResult_LearnedImageDoesNotExist , EResult_UnsupportedTypeOfROI , EResult_ImageDoesNotExist , EResult_InvalidROI , EResult_DoesNotIntersect , EResult_FailedToCreateAlgorithm , EResult_FailedToCreateImage , EResult_FailedToCopyImage , EResult_FailedToLearn , EResult_FailedToDecode , EResult_FailedToEncode , EResult_DifferentFormat , EResult_FailedToAutoDetect , EResult_NeedToStop , EResult_NeedToLoadDLL , EResult_NeedToGrabOrLive , EResult_FailedToReadFromDevice , EResult_FailedToReadParameter , EResult_FailedToWriteToDevice , EResult_FailedToWriteToParameter , EResult_LiveStatus , EResult_FailedToGrab , EResult_FailedToLive , EResult_CouldNotFindModules , EResult_GdiObjectCapacityIsFull , EResult_AlreadyCreated , EResult_DifferentSize , EResult_CouldNotFindFunction , EResult_CouldNotFindVariable , EResult_SyntaxError , EResult_InvalidVariable , EResult_UnsupportedProcessingUnit , EResult_HigherLicenseRequired , EResult_CudaVersionMismatched , EResult_Cancel , EResult_BrokenData , EResult_NotCompressedData , EResult_NotPlainData , EResult_UnsupportedOperatingSystem , EResult_Undefined , EResult_InvalidLabel , EResult_ThereIsNoRegion , EResult_FailedToFindView , EResult_Stop , EResult_Abort , EResult_InvalidSize , EResult_NeedToLearn , EResult_CouldNotFindDevice , EResult_NotSquareImage , EResult_AlreadyRunning , EResult_BroadcastFailure , EResult_InvalidShape , EResult_ShapeMismatched , EResult_InvalidDevice , EResult_InvalidComputationalGraph , EResult_FailedToMeasure , EResult_Busy , EResult_FailedToLogIn , EResult_DoesNotExist , EResult_PermissionDenied , EResult_InvalidKey , EResult_AlreadyExistence , EResult_UndefinedCudaErrorCode , EResult_UnsupportedFigure , EResult_InvalidFigure , EResult_NeedToUpdate , EResult_CudaFailure , EResult_UnsupportedDevice , EResult_AlreadyInitialized , EResult_NeedToRun , EResult_NeedToExecute , EResult_NeedToConnect , EResult_NeedToDisconnect , EResult_NeedToLoad , EResult_NeedToSave , EResult_NeedToModify , EResult_NeedToValidate , EResult_NeedToLogIn , EResult_NeedToLogOut , EResult_NoUpdate , EResult_NotEmpty , EResult_NotReady , EResult_FailedToDelete , EResult_COUNT }
	Result. More...

Functions
bool	IsOK (const EResult eResult)
	Check the success. If the result is `OK` or `PartialOK`, it returns true. otherwise, it returns false.

bool	IsStrictOK (const EResult eResult)
	Check the success. If the result is `OK`, it returns true. otherwise, it returns false.

bool	IsFail (const EResult eResult)
	Check the failure. If the result is not `OK` or `PartialOK`, it returns true. otherwise, it returns false.

bool	IsStrictFail (const EResult eResult)
	Check the failure. If the result is not `OK`, it returns true. otherwise, it returns false.

const wchar_t *	GetResultString (const EResult eResult)
	Get the result string.

Detailed Description

FLImaging namespace

Enumeration Type Documentation

◆ EResult

enum FLImaging::EResult

Result.

Enumerator
EResult_UnknownError	Unknown error.
EResult_OK	OK.
EResult_PartialOK	Partial OK.
EResult_FailedToInitialize	Failed to initialize.
EResult_FailedToTerminate	Failed to terminate.
EResult_NeedToInitialize	Need to initialize.
EResult_NeedToTerminate	Need to terminate.
EResult_FailedToCreateThread	Failed to create thread.
EResult_FailedToSuspendThread	Failed to suspend thread.
EResult_FailedToResumeThread	Failed to resume thread.
EResult_FailedToCreateDevice	Failed to create device.
EResult_FailedToCreateKernelObject	Failed to create kernel object.
EResult_FailedToCreateObject	Failed to create object.
EResult_InvalidParameter	Invalid parameter.
EResult_NullPointer	Null pointer.
EResult_NotEnoughMemory	Not enough memory.
EResult_BufferDoesNotExist	Buffer does not exist.
EResult_NoData	No data.
EResult_OutOfRange	Out of range.
EResult_NoResult	No result.
EResult_EmptyElement	Empty element.
EResult_InvalidHandle	Invalid handle.
EResult_FailedToModify	Failed to modify.
EResult_InvalidItem	Invalid item.
EResult_LackOfBasicData	Lack of basic data.
EResult_ZeroSize	Zero size.
EResult_CountMismatch	Count mismatch.
EResult_InvalidData	Invalid data.
EResult_FailedToOpen	Failed to open.
EResult_FailedToRead	Failed to read.
EResult_FailedToWrite	Failed to write.
EResult_InvalidFile	Invalid file.
EResult_FailedToSend	Failed to send.
EResult_FailedToReceive	Failed to receive.
EResult_FailedToBind	Failed to bind.
EResult_FailedToListen	Failed to listen.
EResult_FailedToConnect	Failed to connect.
EResult_FailedToSetParam	Failed to set param.
EResult_FailedToProcess	Failed to process.
EResult_UnsupportedDepth	Unsupported depth.
EResult_UnsupportedChannels	Unsupported channels.
EResult_Timeout	Timeout.
EResult_UnsupportedVersion	Unsupported version.
EResult_InvalidObject	Invalid object.
EResult_DifferentChannel	Different channel.
EResult_DifferentDepth	Different depth.
EResult_UnsupportedRegionOfInterest	Unsupported region of interest.
EResult_DidNotImplement	Did not implement.
EResult_UnsupportedFormat	Unsupported format.
EResult_FileNotFound	File not found.
EResult_ClassTypeDoesNotMatch	Class type does not match.
EResult_CouldNotFindLicense	Could not find license.
EResult_DifferentType	Different type.
EResult_CouldNotFind	Could not find.
EResult_UnsupportedFunction	Unsupported function.
EResult_TooSmall	Too small.
EResult_NotEnoughMappingData	Not enough mapping data.
EResult_CanBeInaccurate	Can be inaccurate.
EResult_FailedToExecute	Failed to execute.
EResult_FailedToCalculate	Failed to calculate.
EResult_UnsupportedType	Unsupported type.
EResult_DifferentTemplate	Different template.
EResult_InvalidElement	Invalid element.
EResult_NoCollision	No collision.
EResult_FailedToFind	Failed to find.
EResult_FailedToLoad	Failed to load.
EResult_FailedToCreate	Failed to create.
EResult_FailedToSearch	Failed to search.
EResult_FailedToStop	Failed to stop.
EResult_LearnedImageDoesNotExist	Learned image does not exist.
EResult_UnsupportedTypeOfROI	Unsupported type of ROI.
EResult_ImageDoesNotExist	Image does not exist.
EResult_InvalidROI	Invalid ROI.
EResult_DoesNotIntersect	Does not intersect.
EResult_FailedToCreateAlgorithm	Failed to create algorithm.
EResult_FailedToCreateImage	Failed to create image.
EResult_FailedToCopyImage	Failed to copy image.
EResult_FailedToLearn	Failed to learn.
EResult_FailedToDecode	Failed to decode.
EResult_FailedToEncode	Failed to encode.
EResult_DifferentFormat	Different format.
EResult_FailedToAutoDetect	Failed to auot detect.
EResult_NeedToStop	Need to stop.
EResult_NeedToLoadDLL	Need to load dll.
EResult_NeedToGrabOrLive	Need to grab or live.
EResult_FailedToReadFromDevice	Failed to read from device.
EResult_FailedToReadParameter	Failed to read parameter.
EResult_FailedToWriteToDevice	Failed to write to device.
EResult_FailedToWriteToParameter	Failed to write to parameter.
EResult_LiveStatus	Live status.
EResult_FailedToGrab	Failed to grab.
EResult_FailedToLive	Failed to live.
EResult_CouldNotFindModules	Could not find modules.
EResult_GdiObjectCapacityIsFull	Gdi object capacity is full.
EResult_AlreadyCreated	Already created.
EResult_DifferentSize	Different size.
EResult_CouldNotFindFunction	Could not find function.
EResult_CouldNotFindVariable	Could not find variable.
EResult_SyntaxError	Syntax error.
EResult_InvalidVariable	Invalid variable.
EResult_UnsupportedProcessingUnit	Unsupported processing unit.
EResult_HigherLicenseRequired	Higher license required.
EResult_CudaVersionMismatched	Cuda version mismatched.
EResult_Cancel	Cancel.
EResult_BrokenData	Broken data.
EResult_NotCompressedData	Not compressed data.
EResult_NotPlainData	Not plain data.
EResult_UnsupportedOperatingSystem	Unsupported operating system.
EResult_Undefined	Undefined.
EResult_InvalidLabel	Invalid label.
EResult_ThereIsNoRegion	There is no region.
EResult_FailedToFindView	Failed to find view.
EResult_Stop	Stop.
EResult_Abort	Abort.
EResult_InvalidSize	Invalid size.
EResult_NeedToLearn	Need to learn.
EResult_CouldNotFindDevice	Could not find device.
EResult_NotSquareImage	It is not square image.
EResult_AlreadyRunning	Already running.
EResult_BroadcastFailure	Broadcast Failure.
EResult_InvalidShape	Invalid Shape.
EResult_ShapeMismatched	Shape Mismatched.
EResult_InvalidDevice	Invalid Device.
EResult_InvalidComputationalGraph	Invalid Computational Graph.
EResult_FailedToMeasure	Failed to measure.
EResult_Busy	Busy.
EResult_FailedToLogIn	Failed to log in.
EResult_DoesNotExist	Does not exist.
EResult_PermissionDenied	Permission denied.
EResult_InvalidKey	Invalid Key.
EResult_AlreadyExistence	Already Existence.
EResult_UndefinedCudaErrorCode	Cuda error code not defined in the library.
EResult_UnsupportedFigure	Unsupported figure.
EResult_InvalidFigure	Invalid figure.
EResult_NeedToUpdate	Need to update.
EResult_CudaFailure	Cuda failure.
EResult_UnsupportedDevice	Unsupported device.
EResult_AlreadyInitialized	Already Initialized.
EResult_NeedToRun	Need To Run.
EResult_NeedToExecute	Need To Execute.
EResult_NeedToConnect	Need To Connect.
EResult_NeedToDisconnect	Need To Disconnect.
EResult_NeedToLoad	Need To Load.
EResult_NeedToSave	Need To Save.
EResult_NeedToModify	Need To Modify.
EResult_NeedToValidate	Need To Validate.
EResult_NeedToLogIn	Need To Log In.
EResult_NeedToLogOut	Need To Log Out.
EResult_NoUpdate	No Update.
EResult_NotEmpty	Not Empty.
EResult_NotReady	Not Ready.
EResult_FailedToDelete	Failed to delete.
EResult_COUNT	Total result code count.

Function Documentation

◆ GetResultString()

const wchar_t * FLImaging::GetResultString ( const EResult eResult )

inline

Get the result string.

Parameters

[in] eResult Result enum

Return values

const wchar_t* string pointer

See also: FLImaging::EResult

◆ IsFail()

bool FLImaging::IsFail ( const EResult eResult )

inline

Check the failure. If the result is not OK or PartialOK, it returns true. otherwise, it returns false.

Parameters

[in] eResult Result enum

Return values

bool	If the result is not `OK` or `PartialOK`, it returns true. otherwise, it returns false.

See also: FLImaging::EResult

◆ IsOK()

bool FLImaging::IsOK ( const EResult eResult )

inline

Check the success. If the result is OK or PartialOK, it returns true. otherwise, it returns false.

Parameters

[in] eResult Result enum

Return values

bool	If the result is `OK` or `PartialOK`, it returns true. otherwise, it returns false.

See also: FLImaging::EResult

◆ IsStrictFail()

bool FLImaging::IsStrictFail ( const EResult eResult )

inline

Check the failure. If the result is not OK, it returns true. otherwise, it returns false.

Parameters

[in] eResult Result enum

Return values

bool	If the result is not `OK`, it returns true. otherwise, it returns false.

See also: FLImaging::EResult

◆ IsStrictOK()

bool FLImaging::IsStrictOK ( const EResult eResult )

inline

Check the success. If the result is OK, it returns true. otherwise, it returns false.

Parameters

[in] eResult Result enum

Return values

bool	If the result is `OK`, it returns true. otherwise, it returns false.

See also: FLImaging::EResult

Namespaces

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ EResult

Function Documentation

◆ GetResultString()

◆ IsFail()

◆ IsOK()

◆ IsStrictFail()

◆ IsStrictOK()