Class PatternInfo

Namespace

Csra

Assembly

Csra.dll

Class to store information about a pattern.

[Serializable]
public class PatternInfo

Inheritance

object

PatternInfo

Inherited Members

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Constructors

PatternInfo(string, bool)

Construct a new PatternInfo object and load the specified pattern.

public PatternInfo(string pattern, bool threading)

Parameters

pattern string

Specifies the pattern to load. This can be a pattern module name, pattern file, pattern set name, or a combination of these items.

threading bool

Indicate whether threading should be used. Validation will fail if threading is not supported by the pattern.

PatternInfo(Pattern, bool)

Construct a new PatternInfo object and load the specified pattern.

public PatternInfo(Pattern pattern, bool threading)

Parameters

pattern Pattern

Specifies the pattern to load. This can be a pattern module name, pattern file, pattern set name, or a combination of these items.

threading bool

Indicate whether threading should be used. Validation will fail if threading is not supported by the pattern.

Fields

MaxFlags

public const int MaxFlags = 15

Field Value

int

Name

The name of the pattern setup in IGXL.

public readonly string Name

Field Value

string

Properties

ClearFlags

Clear flag value for the pattern, default is all flags (0).

public int ClearFlags { get; set; }

Property Value

int

SetFlags

Set flag value for the pattern, default is cpuA (1).

public int SetFlags { get; set; }

Property Value

int

ThreadingEnabled

Whether or not the pattern can and will use threading.

public bool ThreadingEnabled { get; set; }

Property Value

bool

TimeDomain

Use this property to return a string that lists the time domain names associated with the specified PatternSpecification. If a pattern is not specified, this syntax returns a comma-separated list of all domain names.

public string TimeDomain { get; }

Property Value

string

Methods

Equals(PatternInfo)

Determines whether the specified PatternInfo instance is equal to the current instance.

public bool Equals(PatternInfo other)

Parameters

other PatternInfo

The PatternInfo instance to compare with the current instance.

Returns

bool

true if the specified PatternInfo has the same public properties; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current PatternInfo.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if the specified object is a PatternInfo and has the same public properties; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current PatternInfo.

GetModuleLabelList(string)

Returns the list of labels defined in the specified pattern module. The module must exist in the pattern's module list; otherwise, IGXL will raise an error.

public string[] GetModuleLabelList(string module)

Parameters

module string

The name of the pattern module for which to retrieve the defined labels.

Returns

string[]

A string array of label names defined in the specified pattern module.

ModifyVectorBlockData(Pins, string, string, int, ref string[])

Modifies vector block data for the specified pins in the given pattern module. The data is expected in vector-major order, where each element represents a vector: { "P1P2P3P4", "P1P2P3P4", ... }.

public void ModifyVectorBlockData(Pins pins, string patternModule, string label, int offset, ref string[] pinDataArray)

Parameters

pins Pins

The pins to modify.

patternModule string

The pattern module containing the vector block.

label string

The label identifying the vector block.

offset int

The offset within the vector block.

pinDataArray string[]

Vector-major data array passed by reference.

ModifyVectorBlockDataPinOrder(Pins, string, string, int, ref string)

Modifies vector block data for the specified pins using a single string where each character represents one vector. The string is split into individual characters before being sent to IGXL.

public void ModifyVectorBlockDataPinOrder(Pins pins, string patternModule, string label, int offset, ref string pinData)

Parameters

pins Pins

The pins to modify.

patternModule string

The pattern module containing the vector block.

label string

The label identifying the vector block.

offset int

The offset within the vector block.

pinData string

A string where each character is a vector entry.

ModifyVectorBlockDataPinOrder(Pins, string, string, int, ref string[])

Modifies vector block data for the specified pins using pin-major order. The data is expected as one string per pin, where each string contains that pin's values across all vectors: { "P1P1P1P1", "P2P2P2P2", ... }. The data is transposed to vector-major order before being sent to IGXL.

public void ModifyVectorBlockDataPinOrder(Pins pins, string patternModule, string label, int offset, ref string[] pinDataArray)

Parameters

pins Pins

The pins to modify.

patternModule string

The pattern module containing the vector block.

label string

The label identifying the vector block.

offset int

The offset within the vector block.

pinDataArray string[]

Pin-major data array passed by reference.

Operators

operator ==(PatternInfo, PatternInfo)

Determines whether two PatternInfo instances are equal.

public static bool operator ==(PatternInfo left, PatternInfo right)

Parameters

left PatternInfo

The first PatternInfo to compare.

right PatternInfo

The second PatternInfo to compare.

Returns

bool

true if both instances are equal or both are null; otherwise, false.

operator !=(PatternInfo, PatternInfo)

Determines whether two PatternInfo instances are not equal.

public static bool operator !=(PatternInfo left, PatternInfo right)

Parameters

left PatternInfo

The first PatternInfo to compare.

right PatternInfo

The second PatternInfo to compare.

Returns

bool

true if the instances are not equal; otherwise, false.