/// <summary>
/// Creates a new behavior characterization factory based on the given behavior characterization type.
/// </summary>
/// <param name="behaviorCharacterizationType">
/// The behavior charcterization type for which to create a new behavior
/// characterization factory.
/// </param>
/// <param name="minimalCriteria">The minimal criteria to impose upon generated behavior characterizations.</param>
/// <returns>An instantiated behavior characterization factory.</returns>
public static IBehaviorCharacterizationFactory GenerateBehaviorCharacterizationFactory(
BehaviorCharacterizationType behaviorCharacterizationType, IMinimalCriteria minimalCriteria)
{
switch (behaviorCharacterizationType)
{
case BehaviorCharacterizationType.EndPoint:
return(new EndPointBehaviorCharacterizationFactory(minimalCriteria));
default:
return(new TrajectoryBehaviorCharacterizationFactory(minimalCriteria));
}
}
/// <summary>
/// Creates a new behavior characterization factory based on the given string-valued behavior characterization.
/// </summary>
/// <param name="strBehaviorCharacterization">
/// String representation of the behavior charcterization type for which to create a new behavior characterization
/// factory.
/// </param>
/// <param name="minimalCriteria">The minimal criteria to impose upon generated behavior characterizations.</param>
/// <returns>An instantiated behavior characterization factory.</returns>
public static IBehaviorCharacterizationFactory GenerateBehaviorCharacterizationFactory(
String strBehaviorCharacterization, IMinimalCriteria minimalCriteria)
{
switch (ConvertStringToBehavioralCharacterization(strBehaviorCharacterization))
{
case BehaviorCharacterizationType.EndPoint:
return(new EndPointBehaviorCharacterizationFactory(minimalCriteria));
default:
return(new TrajectoryBehaviorCharacterizationFactory(minimalCriteria));
}
}
/// <summary>
/// End-point behavior characterization constructor accepting a minimal criteria definition and a flag indicating
/// whether minimal criteria reversal should be allowed.
/// </summary>
/// <param name="minimalCriteria"></param>
public EndPointBehaviorCharacterization(IMinimalCriteria minimalCriteria, bool allowReverseCriteria)
{
_minimalCriteria = minimalCriteria;
}
/// <summary>
/// Constructs a new end-point behavior characterization with the specified minimal criteria.
/// </summary>
/// <param name="minimalCriteria">The custom minimal criteria to set on the behavior characterization.</param>
/// <returns>Constructed end-point behavior characterization with the custom minimal criteria.</returns>
public IBehaviorCharacterization CreateBehaviorCharacterization(IMinimalCriteria minimalCriteria)
{
return(new EndPointBehaviorCharacterization(minimalCriteria, false));
}
/// <summary>
/// Constructor for end-point behavior characterization factory.
/// </summary>
/// <param name="minimalCriteria">The minimal criteria to set on the constructed end-point behavior characterizations.</param>
public EndPointBehaviorCharacterizationFactory(IMinimalCriteria minimalCriteria)
{
_minimalCriteria = minimalCriteria;
}
/// <summary>
/// End-point behavior characterization constructor accepting a minimal criteria definition and a flag indicating
/// whether minimal criteria reversal should be allowed.
/// </summary>
/// <param name="minimalCriteria"></param>
public EndPointBehaviorCharacterization(IMinimalCriteria minimalCriteria, bool allowReverseCriteria)
{
_minimalCriteria = minimalCriteria;
}
/// <summary>
/// End-point behavior characterization constructor accepting a minimal criteria definition.
/// </summary>
/// <param name="minimalCriteria"></param>
public EndPointBehaviorCharacterization(IMinimalCriteria minimalCriteria)
{
MinimalCriteria = minimalCriteria;
}
/// <summary>
/// Constructs a new trajectory behavior characterization with the specified minimal criteria.
/// </summary>
/// <param name="minimalCriteria">The custom minimal criteria to set on the behavior characterization.</param>
/// <returns>Constructed trajectory behavior characterization with the custom minimal criteria.</returns>
public IBehaviorCharacterization CreateBehaviorCharacterization(IMinimalCriteria minimalCriteria)
{
return(new TrajectoryBehaviorCharacterization(minimalCriteria));
}
/// <summary>
/// The minimal criteria to set on the constructed behavior characterizations (optional).
/// </summary>
/// <param name="minimalCriteria">The minimal criteria to set on the constructed trajectory behavior characterizations.</param>
public TrajectoryBehaviorCharacterizationFactory(IMinimalCriteria minimalCriteria)
{
_minimalCriteria = minimalCriteria;
}
/// <summary>
/// Creates a new behavior characterization factory based on the given behavior characterization type.
/// </summary>
/// <param name="behaviorCharacterizationType">
/// The behavior charcterization type for which to create a new behavior
/// characterization factory.
/// </param>
/// <param name="minimalCriteria">The minimal criteria to impose upon generated behavior characterizations.</param>
/// <returns>An instantiated behavior characterization factory.</returns>
public static IBehaviorCharacterizationFactory GenerateBehaviorCharacterizationFactory(
BehaviorCharacterizationType behaviorCharacterizationType, IMinimalCriteria minimalCriteria)
{
switch (behaviorCharacterizationType)
{
case BehaviorCharacterizationType.EndPoint:
return new EndPointBehaviorCharacterizationFactory(minimalCriteria);
default:
return new TrajectoryBehaviorCharacterizationFactory(minimalCriteria);
}
}
/// <summary>
/// Creates a new behavior characterization factory based on the given string-valued behavior characterization.
/// </summary>
/// <param name="strBehaviorCharacterization">
/// String representation of the behavior charcterization type for which to create a new behavior characterization
/// factory.
/// </param>
/// <param name="minimalCriteria">The minimal criteria to impose upon generated behavior characterizations.</param>
/// <returns>An instantiated behavior characterization factory.</returns>
public static IBehaviorCharacterizationFactory GenerateBehaviorCharacterizationFactory(
String strBehaviorCharacterization, IMinimalCriteria minimalCriteria)
{
switch (ConvertStringToBehavioralCharacterization(strBehaviorCharacterization))
{
case BehaviorCharacterizationType.EndPoint:
return new EndPointBehaviorCharacterizationFactory(minimalCriteria);
default:
return new TrajectoryBehaviorCharacterizationFactory(minimalCriteria);
}
}
/// <summary>
/// Reads behavior characterization parameters from the database.
/// </summary>
/// <param name="experiment">The experiment dictionary entity.</param>
/// <param name="isPrimary">
/// Boolean flag indicating whether this is the primary behavior characterization or the behavior
/// characterization used for experiment initialization.
/// </param>
/// <returns></returns>
public static IBehaviorCharacterizationFactory ReadBehaviorCharacterizationFactory(
ExperimentDictionary experiment,
bool isPrimary)
{
// Read behavior characterization
var behaviorCharacterizationName = isPrimary
? experiment.Primary_BehaviorCharacterizationName
: experiment.Initialization_BehaviorCharacterizationName;
// Ensure that the behavior was specified
if (behaviorCharacterizationName == null)
{
throw new ArgumentException("Missing or invalid BehaviorConfig settings.");
}
IMinimalCriteria minimalCriteria = null;
// Get the appropriate minimal criteria type
var mcType = BehaviorCharacterizationUtil.ConvertStringToMinimalCriteria(isPrimary
? experiment.Primary_MCS_MinimalCriteriaName
: experiment.Initialization_MCS_MinimalCriteriaName);
// Starting location used in most criterias
double xStart, yStart;
switch (mcType)
{
case MinimalCriteriaType.EuclideanLocation:
// TODO: Not implemented at the database layer yet
break;
case MinimalCriteriaType.FixedPointEuclideanDistance:
// Read in the starting coordinates and the minimum required distance traveled
xStart = isPrimary
? experiment.Primary_MCS_MinimalCriteriaStartX ?? default(double)
: experiment.Initialization_MCS_MinimalCriteriaStartX ?? default(double);
yStart = isPrimary
? experiment.Primary_MCS_MinimalCriteriaStartY ?? default(double)
: experiment.Initialization_MCS_MinimalCriteriaStartY ?? default(double);
var minimumDistanceTraveled = isPrimary
? experiment.Primary_MCS_MinimalCriteriaThreshold ?? default(double)
: experiment.Initialization_MCS_MinimalCriteriaThreshold ?? default(double);
// Set the euclidean distance minimal criteria on the behavior characterization
minimalCriteria = new FixedPointEuclideanDistanceCriteria(xStart, yStart,
minimumDistanceTraveled);
break;
case MinimalCriteriaType.Mileage:
// Read in the starting coordinates and minimum required total distance traveled (mileage)
xStart = isPrimary
? experiment.Primary_MCS_MinimalCriteriaStartX ?? default(double)
: experiment.Initialization_MCS_MinimalCriteriaStartX ?? default(double);
yStart = isPrimary
? experiment.Primary_MCS_MinimalCriteriaStartY ?? default(double)
: experiment.Initialization_MCS_MinimalCriteriaStartY ?? default(double);
var minimumMileage = isPrimary
? experiment.Primary_MCS_MinimalCriteriaThreshold ?? default(double)
: experiment.Initialization_MCS_MinimalCriteriaThreshold ?? default(double);
// Set the mileage minimal criteria on the behavior characterization
minimalCriteria = new MileageCriteria(xStart, yStart, minimumMileage);
break;
}
// Parse and generate the appropriate behavior characterization factory
var behaviorCharacterizationFactory =
BehaviorCharacterizationUtil.GenerateBehaviorCharacterizationFactory(behaviorCharacterizationName,
minimalCriteria);
return(behaviorCharacterizationFactory);
}
/// <summary>
/// Reads behavior characterization parameters from the configuration file.
/// </summary>
/// <param name="xmlConfig">The reference to the XML configuration file.</param>
/// <param name="behaviorConfigTagName"></param>
/// <returns>The behavior characterization parameters.</returns>
public static IBehaviorCharacterizationFactory ReadBehaviorCharacterizationFactory(XmlElement xmlConfig,
string behaviorConfigTagName)
{
// Get root of behavior configuration section
var behaviorNodeList = xmlConfig.GetElementsByTagName(behaviorConfigTagName, "");
// Ensure that the behavior node list was found
if (behaviorNodeList.Count != 1)
{
throw new ArgumentException("Missing or invalid BehaviorConfig XML config settings.");
}
var xmlBehaviorConfig = behaviorNodeList[0] as XmlElement;
IMinimalCriteria minimalCriteria = null;
// Try to get the child minimal criteria configuration
var minimalCriteriaNodeList = xmlBehaviorConfig.GetElementsByTagName("MinimalCriteriaConfig", "");
// If a minimal criteria is specified, read in its configuration and add it to the behavior characterization
if (minimalCriteriaNodeList.Count == 1)
{
var xmlMinimalCriteriaConfig = minimalCriteriaNodeList[0] as XmlElement;
// Extract the minimal criteria constraint name
var minimalCriteriaConstraint = XmlUtils.TryGetValueAsString(xmlMinimalCriteriaConfig,
"MinimalCriteriaConstraint");
// Get the appropriate minimal criteria type
var mcType = BehaviorCharacterizationUtil.ConvertStringToMinimalCriteria(minimalCriteriaConstraint);
// Starting location used in most criterias
double xStart, yStart;
switch (mcType)
{
case MinimalCriteriaType.EuclideanLocation:
// Read in the min/max location bounds
var xMin = XmlUtils.GetValueAsDouble(xmlMinimalCriteriaConfig, "XMin");
var xMax = XmlUtils.GetValueAsDouble(xmlMinimalCriteriaConfig, "XMax");
var yMin = XmlUtils.GetValueAsDouble(xmlMinimalCriteriaConfig, "YMin");
var yMax = XmlUtils.GetValueAsDouble(xmlMinimalCriteriaConfig, "YMax");
// Set the euclidean location minimal criteria on the behavior characterization
minimalCriteria = new EuclideanLocationCriteria(xMin, xMax, yMin, yMax);
break;
case MinimalCriteriaType.FixedPointEuclideanDistance:
// Read in the starting coordinates and the minimum required distance traveled
xStart = XmlUtils.GetValueAsDouble(xmlMinimalCriteriaConfig, "XStart");
yStart = XmlUtils.GetValueAsDouble(xmlMinimalCriteriaConfig, "YStart");
var minimumDistanceTraveled = XmlUtils.GetValueAsDouble(xmlMinimalCriteriaConfig,
"MinimumRequiredDistance");
double?maxDistanceUpdateCyclesWithoutChange =
XmlUtils.TryGetValueAsInt(xmlMinimalCriteriaConfig,
"MaxUpdateCyclesWithoutChange");
// Set the fixed point euclidean distance minimal criteria on the behavior characterization
minimalCriteria = new FixedPointEuclideanDistanceCriteria(xStart, yStart,
minimumDistanceTraveled, maxDistanceUpdateCyclesWithoutChange);
break;
case MinimalCriteriaType.PopulationCentroidEuclideanDistance:
// Read in the starting minimum required distance (if applicable)
var minimuCentroidDistance = XmlUtils.GetValueAsDouble(xmlMinimalCriteriaConfig,
"MinimumRequiredDistance");
// Set the population centroid euclidean distance criteria on the behavior characterization
minimalCriteria = new PopulationCentroidEuclideanDistanceCriteria(minimuCentroidDistance);
break;
case MinimalCriteriaType.Mileage:
// Read in the starting coordinates and minimum required total distance traveled (mileage)
xStart = XmlUtils.GetValueAsDouble(xmlMinimalCriteriaConfig, "XStart");
yStart = XmlUtils.GetValueAsDouble(xmlMinimalCriteriaConfig, "YStart");
var minimumMileage = XmlUtils.GetValueAsDouble(xmlMinimalCriteriaConfig, "MinimumMileage");
double?maxMileageUpdateCyclesWithoutChange = XmlUtils.TryGetValueAsInt(
xmlMinimalCriteriaConfig,
"MaxUpdateCyclesWithoutChange");
// Set the mileage minimal criteria on the behavior characterization
minimalCriteria = new MileageCriteria(xStart, yStart, minimumMileage,
maxMileageUpdateCyclesWithoutChange);
break;
}
}
// Parse and generate the appropriate behavior characterization factory
var behaviorCharacterizationFactory =
BehaviorCharacterizationUtil.GenerateBehaviorCharacterizationFactory(
XmlUtils.TryGetValueAsString(xmlBehaviorConfig, "BehaviorCharacterization"), minimalCriteria);
return(behaviorCharacterizationFactory);
}
