Package org.robwork.sdurw

Class ProximitySetupRule

java.lang.Object

org.robwork.sdurw.ProximitySetupRule

public class ProximitySetupRule
extends java.lang.Object

Rule specifying include/exclude of frame pairs

The rule has two patterns, pattern A and pattern B, to which frames can be matched. A pattern
could contain a fully specified frame name such as "Table". It can also include
wild card characters such a "Robot.*" or regular expressions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProximitySetupRule.RuleType	Include and Exclude identifiers

Constructor Summary

Constructors

Constructor	Description
ProximitySetupRule()	Constuct empty rule
ProximitySetupRule(long cPtr, boolean cMemoryOwn)
ProximitySetupRule(java.lang.String patternA, java.lang.String patternB, ProximitySetupRule.RuleType type)	Constructs rule with patternA and patternB and type

Method Summary

Modifier and Type	Method	Description
void	delete()
boolean	equals(ProximitySetupRule p)	Compares if two rules are the same
static long	getCPtr(ProximitySetupRule obj)
StringPair	getPatterns()	Returns the string patterns used to match
static ProximitySetupRule	makeExclude(java.lang.String patternA, java.lang.String patternB)	Make an exclude rule for the patterns
static ProximitySetupRule	makeExclude(StringPair patterns)	Make an exclude rule for the patterns
static ProximitySetupRule	makeInclude(java.lang.String patternA, java.lang.String patternB)	Make an include rule for the patterns
static ProximitySetupRule	makeInclude(StringPair patterns)	Make an include rule for the patterns
boolean	match(java.lang.String str1, java.lang.String str2)	Check whether str1 and str2 matches the pattern. Success is defined if the first pattern matches str1 and the second matches str2 or the first matches str2 and the second str1.
boolean	match(StringPair pair)	Check whether pair matches the patterns. Success is defined if the first pattern matches pair.first and the second matches pair.second or the first matches pair.second and the second pair.first.
boolean	matchOne(java.lang.String name)	Check whether name matches one of the patterns
boolean	matchPatternA(java.lang.String str)	Check whether str matches pattern A
boolean	matchPatternB(java.lang.String str)	Check whether name matches pattern B
java.lang.String	toString()
ProximitySetupRule.RuleType	type()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProximitySetupRule

public ProximitySetupRule(long cPtr,
                          boolean cMemoryOwn)

ProximitySetupRule

public ProximitySetupRule()

Constuct empty rule

ProximitySetupRule

public ProximitySetupRule(java.lang.String patternA,
                          java.lang.String patternB,
                          ProximitySetupRule.RuleType type)

Constructs rule with patternA and patternB and type

Parameters:

patternA - [in] Pattern identifying first frame in rule

patternB - [in] Pattern identifying second frame in rule

type - documentation missing !

Method Detail

getCPtr

public static long getCPtr(ProximitySetupRule obj)

delete

public void delete()

type

public ProximitySetupRule.RuleType type()

getPatterns

public StringPair getPatterns()

Returns the string patterns used to match

match

public boolean match(java.lang.String str1,
                     java.lang.String str2)

Check whether str1 and str2 matches the pattern.

Success is defined if the first pattern matches str1 and the second
matches str2 or the first matches str2 and the second str1.

match

public boolean match(StringPair pair)

Check whether pair matches the patterns.

Success is defined if the first pattern matches pair.first and the second
matches pair.second or the first matches pair.second and the second pair.first.

matchOne

public boolean matchOne(java.lang.String name)

Check whether name matches one of the patterns

matchPatternA

public boolean matchPatternA(java.lang.String str)

Check whether str matches pattern A

matchPatternB

public boolean matchPatternB(java.lang.String str)

Check whether name matches pattern B

equals

public boolean equals(ProximitySetupRule p)

Compares if two rules are the same

makeExclude

public static ProximitySetupRule makeExclude(StringPair patterns)

Make an exclude rule for the patterns

makeExclude

public static ProximitySetupRule makeExclude(java.lang.String patternA,
                                             java.lang.String patternB)

Make an exclude rule for the patterns

makeInclude

public static ProximitySetupRule makeInclude(StringPair patterns)

Make an include rule for the patterns

makeInclude

public static ProximitySetupRule makeInclude(java.lang.String patternA,
                                             java.lang.String patternB)

Make an include rule for the patterns

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object