CogPMAlignPattern.PCPLoadFromFile Method

CogPMAlignPattern PCPLoadFromFile Method

Cognex VisionPro 9.22 SR1

Customizes this PMAlign pattern using the customization string (PCP) in the file specified by Filename.

Namespace: Cognex.VisionPro.PMAlign
Assembly: Cognex.VisionPro.PMAlign (in Cognex.VisionPro.PMAlign.dll) Version: 87.1.0.0

Syntax

public void PCPLoadFromFile(
	string filename
)

public void PCPLoadFromFile(
	string filename
)

Public Sub PCPLoadFromFile ( 
	filename As String
)

Public Sub PCPLoadFromFile ( 
	filename As String
)

public:
void PCPLoadFromFile(
	String^ filename
)

public:
void PCPLoadFromFile(
	String^ filename
)

Events

Event Type	Reason
CogPMAlignPattern Changed	Fires when the string changes. The following state flag may be affected: SfPCPString
CogPMAlignPattern Changed	Fires when the string changes and the pattern was untrained. The following state flags may be affected: SfPCPString SfGetInfoIDs SfTrained SfCreateGraphicsCoarse SfCreateGraphicsFine SfGetInfoStrings SfGetTrainedPatternImage SfGetTrainedPatternImageMask SfGetTrainedPatternShapeModels
CogPMAlignPattern Changed	Fires when the string was not changed successfully (CogPMAlignInvalidPCPException), but the pattern was untrained. The following state flags may be affected: SfGetInfoIDs SfTrained SfCreateGraphicsCoarse SfCreateGraphicsFine SfGetInfoStrings SfGetTrainedPatternImage SfGetTrainedPatternImageMask SfGetTrainedPatternShapeModels

Event Type

Reason

Fires when the string changes.

The following state flag may be affected:

Fires when the string changes and the pattern was untrained.

The following state flags may be affected:

Fires when the string was not changed successfully (CogPMAlignInvalidPCPException), but the pattern was untrained.

The following state flags may be affected:

Exceptions

Exception	Condition
ArgumentException	filename is an empty string.
CogFileOpenException	filename could not be opened.
CogPMAlignInvalidPCPException	filename contains an invalid PCP string. If this error occurs, any existing PCP string is lost and the contents of the PCPString are undefined.

Remarks

Customizes this PMAlign pattern using the customization string (PCP) in the file specified by Filename.

Note: Calling this function causes this CogPMAlignPattern to become untrained.