Filter Interface Reference

Common interface for all Filters. More...

Inheritance diagram for Filter:

[legend]

List of all members.

Public Member Functions
String	getDefaults ()
	Returns the default parameter String for this Filter.
String	getName ()
	Returns the name of this Filter.
String	getParameters ()
	Returns the current parameters in a comma-separated String of values.
void	setup (String param)
	Sets up this Filter with a given comma-separated String.
Package Functions
Accel3D	filter (Accel3D acc)
	Takes in a sample and returns either the unchanged sample or null depending on the Filter's criteria.

---

Detailed Description

Common interface for all Filters.

Allows FROG to pass the argument String and samples into them.

WARNING! Do not attempt to create a constructor that requires parameters or make the constructor private! FROG must be able to call Class#newInstance() on your Filter to instantiate it!

Author:

Team Better Recognize

---

Member Function Documentation

Accel3D filter

(

Accel3D

acc

)

[package]

Takes in a sample and returns either the unchanged sample or null depending on the Filter's criteria.

Parameters:

acc

data to be filtered out

Returns:

null if the filter removed this Accel3D. Otherwise returns the original Accel3D unmodified.

Implemented in DirectorialEquivalence, and IdleState.

String getDefaults

(

)

Returns the default parameter String for this Filter.

Returns:

the default parameter String that will be used in setup if a blank is given

Implemented in DirectorialEquivalence, and IdleState.

String getName

(

)

Returns the name of this Filter.

Returns:

the name of this Filter

Implemented in DirectorialEquivalence, and IdleState.

String getParameters

(

)

Returns the current parameters in a comma-separated String of values.

The values are returned in exactly the same order and style that they would be passed in through the setup(String) method.

Returns:

the current parameter String for this Filter

Implemented in DirectorialEquivalence, and IdleState.

void setup

(

String

param

)

Sets up this Filter with a given comma-separated String.

This String may contain parameters a user may wish to change about the Filter.

Parameters:

param

Implemented in DirectorialEquivalence, and IdleState.

---

The documentation for this interface was generated from the following file:

• /Users/dev/Documents/SVN brazos.cs.tcu.edu/trunk/FilterTest/src/Filter.java