org.fosstrak.llrp.commander.util
Class LLRPPresenceConstraint

java.lang.Object
  org.fosstrak.llrp.commander.util.LLRPPresenceConstraint

public class LLRPPresenceConstraint
extends java.lang.Object

This class represents an LLRP constraint stating that a certain parameter is mandatory.

Author:

Ulrich Etter, ETHZ

Constructor Summary

LLRPPresenceConstraint(java.lang.String messageOrParameterName, java.lang.String subparameterName, java.lang.String preconditionedEnumerationName, java.lang.String preconditionedEnumerationValue)
Creates a new presence constraint.

Method Summary

java.lang.String	getErrorMessage()
java.lang.String	getMessageOrParameterName()
java.lang.String	getPreconditionedEnumerationName()
java.lang.String	getPreconditionedEnumerationValue()
java.lang.String	getSubparameterName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LLRPPresenceConstraint

public LLRPPresenceConstraint(java.lang.String messageOrParameterName,
                              java.lang.String subparameterName,
                              java.lang.String preconditionedEnumerationName,
                              java.lang.String preconditionedEnumerationValue)

Creates a new presence constraint.

Example:
To create a constraint that specifies that the sub-parameter PeriodicTriggerValue of the parameter ROSpecStartTrigger must be present if the enumeration ROSpecStartTriggerType has value Periodic, use the following code:
new LLRPPresenceConstraint( "ROSpecStartTrigger", "PeriodicTriggerValue", "ROSpecStartTriggerType", "Periodic"),

Parameters:

messageOrParameterName - the message/parameter this constraint is defined for

subparameterName - the sub-parameter this constraint is defined for

preconditionedEnumerationName - the name of the enumeration on which this constraint is dependent; use null if this constraint does not depend on any enumeration

preconditionedEnumerationValue - the value of the enumeration on which this constraint is dependent; use null if this constraint does not depend on any enumeration

Method Detail

getErrorMessage

public java.lang.String getErrorMessage()

Returns:

the error message associated with this constraint

getMessageOrParameterName

public java.lang.String getMessageOrParameterName()

Returns:

the message/parameter this constraint is defined for

getSubparameterName

public java.lang.String getSubparameterName()

Returns:

the sub-parameter this constraint is defined for

getPreconditionedEnumerationName

public java.lang.String getPreconditionedEnumerationName()

Returns:

the name of the enumeration on which this constraint is dependent

getPreconditionedEnumerationValue

public java.lang.String getPreconditionedEnumerationValue()

Returns:

the value of the enumeration on which this constraint is dependent