Pattern


LXsTYPE_PATTERN

The Pattern Value type presents an ILxValue object, allowing the pattern to be set from a string, as well as String Conversion and String Conversion Nice to allow the value to be encoded and decoded as a string. A StreamIO interface allows the pattern to be written to an external file format, and a ValueArray interface is provided, allowing elements in the pattern to be accessed as booleans. Finally, the object provides an ILxPattern interface, allowing the pattern to be tested, and converted into a sequence.

ILxPattern

class ILxPattern

The ILxPattern interface is used by the Pattern ExoType. Patterns can be used to mask a sequence when iterating over some entity. Patterns are defined as a sequence of True/False values, seperated by a comma. The user can enter 0 or 1, True or False, T or F, and Yes or No, to determine if an element in a sequence is masked by a pattern.

Public Functions

LxResult Test(LXtObjectID self, int index, int offset)

The Test method returns LXe_TRUE or LXe_FALSE for the specified index in the pattern. The offset for the index can be specified. For example, if the pattern True, False, True, True, False, and the index is 1 and the offset is 0, the return value would be LXe_FALSE. However, if the offset is 2, the returned value would match the fourth element in the pattern and return LXe_TRUE.

LxResult GenerateSequenceString(LXtObjectID self, int start, int end, char *buf, unsigned int len)

Given a start index and an end index, this method will return a comma seperated string populated with any number between the start and end index, masked by the filter. For example if the pattern is True, False, True, True, False, and the start and end of the range is 0 and 9 respectively, the returned string will be “0,2,3,5,7,8”. Similar to the Test method, the offset argument allows the pattern to be offset.