CogPMAlignPattern.PCPString Property

CogPMAlignPattern PCPString Property

Cognex VisionPro 9.8

Customization string (PCP) used to customize this PMAlign pattern. The PCP string can be set by either setting the PCPString property directly or calling the PCPLoadFromFile method. An empty string indicates that no PCP is set for this pattern.

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

Syntax

C++

Copy to Clipboard Print

public string PCPString { get; set; }

public string PCPString { get; set; }

Public Property PCPString As String 
	Get 
	Set

Public Property PCPString As String 
	Get 
	Set

public:
property String^ PCPString {
	String^ get ();
	void set (String^ value);
}

public:
property String^ PCPString {
	String^ get ();
	void set (String^ value);
}

Property Value

Type: String

Events

Event Type	Reason
CogPMAlignPattern Changed	Fires when the value of this property changes. The following state flag may be affected: SfPCPString
CogPMAlignPattern Changed	Fires when the value of this property 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

CogPMAlignPattern Changed

Fires when the value of this property changes.

The following state flag may be affected:

SfPCPString

CogPMAlignPattern Changed

Fires when the value of this property changes and the pattern was untrained.

The following state flags may be affected:

CogPMAlignPattern Changed

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

The following state flags may be affected:

Exceptions

Exception	Condition
CogPMAlignInvalidPCPException	An invalid PCP string was supplied. If this error occurs, any existing PCP string is lost and the contents of the CogPMAlignPattern are undefined.

Remarks

Note: Changing this property causes this CogPMAlignPattern to become untrained.

Default Value: NULL (an empty string)