public class CommunicationLinkConstraint extends MinimumMaximumAccessConstraint implements ILinkConstraint
An access constraint which is based on a communication link parameter defined by a CommunicationLinkScalar.
The ConstrainedLink (get / set) for the ILinkConstraint is simply the
CommunicationLink (get / set) on the ConstraintParameter (get / set).
The tolerances for the MinimumTolerance (get / set) and MaximumTolerance (get / set)
may be in either linear or decibel units, depending on the value of UseLogarithmicSampling (get / set)
specified on the ConstraintParameter (get / set).
Communication constraints are generally sampled in logarithmic units to avoid dealing with extremely small numbers in
cases where the linear units can commonly have values near zero (-200 dB is 1e-20 in linear units).
This is largely due to the large range of values achievable in communications analysis, as gains can
be extremely high near antennas and drop off to zero over the large distances encountered routinely in wireless communications.
The default tolerance is set to Constants.Epsilon8.
Since most of the communications scalars will use logarithmic sampling, this should provide a reasonable tolerance.
If using linear units, this tolerance will need to be set significantly lower.
MinimumMaximumAccessConstraint.MinMaxThresholdEvaluator| Modifier | Constructor and Description |
|---|---|
|
CommunicationLinkConstraint()
Initializes a new instance.
|
protected |
CommunicationLinkConstraint(CommunicationLinkConstraint existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
CommunicationLinkConstraint(CommunicationLinkScalar parameter,
double minimum,
double maximum)
Initialize a new instance with the given scalar communication parameter, minimum threshold, and maximum threshold.
|
| Modifier and Type | Method and Description |
|---|---|
void |
buildQueryEvaluator(ConstraintQueryBuilder builder,
EvaluatorGroup group)
Builds a query evaluator from this constraint.
|
protected boolean |
checkForSameDefinition(CommunicationLinkConstraint other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
protected boolean |
checkForSameDefinition(MinimumMaximumAccessConstraint other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
protected int |
computeCurrentDefinitionHashCode()
Computes a hash code based on the current properties of this object.
|
void |
enumerateDependencies(DependencyEnumerator enumerator)
Enumerates the dependencies of this object by calling
DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. |
IServiceProvider |
getConstrainedLink()
Gets the link to which this constraint applies.
|
LinkRole |
getConstrainedLinkEnd()
Gets the end of the link to which this constraint applies.
|
CommunicationLinkScalar |
getConstraintParameter()
Gets the communication parameter on which to constrain access.
|
void |
setConstrainedLink(IServiceProvider value)
Sets the link to which this constraint applies.
|
void |
setConstrainedLinkEnd(LinkRole value)
Sets the end of the link to which this constraint applies.
|
void |
setConstraintParameter(CommunicationLinkScalar value)
Sets the communication parameter on which to constrain access.
|
String |
toString()
Returns a string representation of the object.
|
checkForSameDefinition, getIsMaximumEnabled, getIsMinimumEnabled, getMaximumTolerance, getMaximumValue, getMinimumTolerance, getMinimumValue, setIsMaximumEnabled, setIsMinimumEnabled, setMaximumTolerance, setMaximumValue, setMinimumTolerance, setMinimumValuecheckForSameDefinition, freezeAggregatedObjects, getApplicability, getEvaluationOrder, getEvaluator, getSampling, setApplicability, setEvaluationOrder, toDisjunctiveNormalFormand, and, anyPath, anyPath, anyPath, anyPath, anyPath, anyPath, atLeastN, atMostN, checkForSameDefinition, exactlyN, fromObject, fromObjectAllowNoConstraints, getDebuggingLogger, getEvaluator, getEvaluator, not, or, or, setDebuggingLoggerareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic CommunicationLinkConstraint()
public CommunicationLinkConstraint(CommunicationLinkScalar parameter, double minimum, double maximum)
parameter - The communication parameter on which to constrain access.minimum - The minimum value allowed for access.maximum - The maximum value allowed for access.protected CommunicationLinkConstraint(@Nonnull CommunicationLinkConstraint existingInstance, @Nonnull CopyContext context)
See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor
in a derived class.
existingInstance - The existing instance to copy.context - A CopyContext that controls the depth of the copy.ArgumentNullException - Thrown when existingInstance or context is null.public Object clone(CopyContext context)
This method should be implemented to call a copy constructor on the class of the
object being cloned. The copy constructor should take the CopyContext as a parameter
in addition to the existing instance to copy. The copy constructor should first call
CopyContext.addObjectMapping(T, T) to identify the newly constructed instance
as a copy of the existing instance. It should then copy all fields, using
CopyContext.updateReference(T) to copy any reference fields.
A typical implementation of ICloneWithContext:
public static class MyClass implements ICloneWithContext {
public MyClass(MyClass existingInstance, CopyContext context) {
context.addObjectMapping(existingInstance, this);
someReference = context.updateReference(existingInstance.someReference);
}
@Override
public final Object clone(CopyContext context) {
return new MyClass(this, context);
}
private Object someReference;
}
In general, all fields that are reference types should be copied with a call to
CopyContext.updateReference(T). There are a couple of exceptions:
If one of these exceptions applies, the CopyContext should be given an opportunity
to update the reference before the reference is copied explicitly. Use
CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns
the original object, indicating that the context does not have a replacement registered,
then copy the object manually by invoking a Clone method, a copy constructor, or by manually
constructing a new instance and copying the values.
alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}
If you are implementing an evaluator (a class that implements IEvaluator), the
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the
copy context constructor. Code duplication can be avoided by doing the following:
CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the
same CopyContext passed to the constructor.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.
public MyClass(MyClass existingInstance, CopyContext context) {
super(existingInstance, context);
someReference = context.updateReference(existingInstance.someReference);
evaluatorReference = existingInstance.evaluatorReference;
updateEvaluatorReferences(context);
}
@Override
public void updateEvaluatorReferences(CopyContext context) {
evaluatorReference = context.updateReference(evaluatorReference);
}
@Override
public Object clone(CopyContext context) {
return new MyClass(this, context);
}
private Object someReference;
private IEvaluator evaluatorReference;clone in interface ICloneWithContextclone in class DefinitionalObjectcontext - The context to use to perform the copy.protected final boolean checkForSameDefinition(MinimumMaximumAccessConstraint other)
true if it does. Derived classes MUST override this method and check
all new fields introduced by the derived class for definitional equivalence. It is NOT necessary
to check base class fields because the base class will already have done that. When overriding this method,
you should NOT call the base implementation because it will return false for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).checkForSameDefinition in class MinimumMaximumAccessConstraintother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(CommunicationLinkConstraint other)
true if it does. Derived classes MUST override this method and check
all new fields introduced by the derived class for definitional equivalence. It is NOT necessary
to check base class fields because the base class will already have done that. When overriding this method,
you should NOT call the base implementation because it will return false for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).other - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected int computeCurrentDefinitionHashCode()
CommunicationLinkConstraint.checkForSameDefinition(agi.foundation.access.MinimumMaximumAccessConstraint) method.computeCurrentDefinitionHashCode in class MinimumMaximumAccessConstraintpublic void enumerateDependencies(DependencyEnumerator enumerator)
DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
Derived classes which contain additional dependencies MUST override this method, call the base
implementation, and enumerate dependencies introduced by the derived class.enumerateDependencies in interface IEnumerateDependenciesenumerateDependencies in class AccessConstraintenumerator - The enumerator that is informed of the dependencies of this object.public final CommunicationLinkScalar getConstraintParameter()
public final void setConstraintParameter(CommunicationLinkScalar value)
public final IServiceProvider getConstrainedLink()
This property gets and sets the CommunicationLink (get / set) property of the underlying CommunicationLinkScalar object returned
from the ConstraintParameter (get / set) property.
getConstrainedLink in interface ILinkConstraintIllegalStateException - Thrown if this property is called and ConstraintParameter (get / set) is null.public final void setConstrainedLink(IServiceProvider value)
This property gets and sets the CommunicationLink (get / set) property of the underlying CommunicationLinkScalar object returned
from the ConstraintParameter (get / set) property.
setConstrainedLink in interface ILinkConstraintIllegalStateException - Thrown if this property is called and ConstraintParameter (get / set) is null.@Nonnull public final LinkRole getConstrainedLinkEnd()
This property gets and sets the LinkEnd (get / set) property of the underlying CommunicationLinkScalar object returned
from the ConstraintParameter (get / set) property.
getConstrainedLinkEnd in interface ILinkConstraintIllegalStateException - Thrown if this property is called and
ConstraintParameter (get / set) is null, or if this property is set and the ConstraintParameter (get / set)
doesn't allow modifying its LinkEnd (get / set).public final void setConstrainedLinkEnd(@Nonnull LinkRole value)
This property gets and sets the LinkEnd (get / set) property of the underlying CommunicationLinkScalar object returned
from the ConstraintParameter (get / set) property.
setConstrainedLinkEnd in interface ILinkConstraintIllegalStateException - Thrown if this property is called and
ConstraintParameter (get / set) is null, or if this property is set and the ConstraintParameter (get / set)
doesn't allow modifying its LinkEnd (get / set).public String toString()
java.lang.ObjecttoString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
public void buildQueryEvaluator(ConstraintQueryBuilder builder, EvaluatorGroup group)
buildQueryEvaluator in class AccessConstraintbuilder - The builder instance to use to build the evaluator.group - The evaluator group in which to create individual constraint function evaluators.