TimeFeature Class Reference

#include <TimeFeature.h>

Inheritance diagram for TimeFeature:

List of all members.

Public Types
enum	FeatureKind {   Timestamp, Second, Minute, Hour,   Day, Weekday, Yearday, Month,   Year }
Public Member Functions
virtual double	getPosition () const
virtual double	getDistance (Feature *f) const
virtual void	moveTowards (Feature *f, double factor)
virtual string	serialize () const
virtual void	unserialize (string value)
virtual featureparams	write () const
virtual void	read (featureparams *param)
virtual Feature *	clone () const
virtual void	aggregate (aggregatelist samples)
virtual FeatureType	getType () const
virtual const string	getName () const
virtual time_t	getVal () const
const time_t	getMin () const
const time_t	getMax () const
virtual string	toString () const
Protected Member Functions
	TimeFeature (FeatureKind kind, time_t *minval, time_t *maxval)
	TimeFeature (FeatureKind kind, time_t *minval, time_t *maxval, time_t timestamp)
Friends
class	TimeFeatureProvider

---

Detailed Description

Todo:

documentation

---

Member Enumeration Documentation

enum TimeFeature::FeatureKind

Possible kinds of time features

---

Constructor & Destructor Documentation

TimeFeature::TimeFeature (  FeatureKind  kind, time_t *  minval, time_t *  maxval )  [protected]

Todo: documentation

TimeFeature::TimeFeature (  FeatureKind  kind, time_t *  minval, time_t *  maxval, time_t  timestamp )  [protected]

Todo: documentation

---

Member Function Documentation

void TimeFeature::aggregate (  aggregatelist  samples  )  [virtual]

Aggregate a sample values from other sources Parameters: samples  A list of <timestamp, sample> tuples. Implements Feature.

Feature * TimeFeature::clone (   )  const [virtual]

Clone a feature A feature must be able to clone itself. This is typically implemented with a copy constructor, but should return a new object. Implements Feature.

double TimeFeature::getDistance (  Feature *  f  )  const [virtual]

Calculates the distance between two features Parameters: f  Feature used for distance measurement. Returns: Distance between the two samples. The return value has to be in the interval [0; 1] to guarantee comparability among samples of different features. Implements Feature.

const string TimeFeature::getName (   )  const [virtual]

Query a features name Returns: Name of the Feature in the format "Featureprovider.Feature" Implements Feature.

double TimeFeature::getPosition (   )  const [virtual]

Query a features position Returns: The distance to the origin. Every implementation must take care that only values in the interval [0; 1] are returned. Remarks: This function is only for the purpose of internal search operations and visualisation and should not be used in any other context. Implements Feature.

virtual FeatureType TimeFeature::getType (   )  const [inline, virtual]

Query a features type Returns: The type of the Feature. Implements Feature.

virtual time_t TimeFeature::getVal (   )  const [inline, virtual]

Returns: The value of the feature.

void TimeFeature::moveTowards (  Feature *  f, double  factor )  [virtual]

Move feature Moves the feature towards a given sample value by the specified factor (factor times the distance). If the factor is 0, the old feature value must not change. If the factor is 1, the new feature value should be equivalent to the sample s. Parameters: f  Feature used for distance measurement. factor  Distance weight. Implements Feature.

void TimeFeature::read (  featureparams *  param  )  [virtual]

Load feature from persistant data Initializes the persistant feature data from the given representation. Parameters: param  Persistant feature data. See also: write Implements PersistantFeature.

string TimeFeature::serialize (   )  const [virtual]

Serialize a samples data to a string Returns: String representation of the samples data. Implements Feature.

string TimeFeature::toString (   )  const [virtual]

This is only for testing. Implements Feature.

void TimeFeature::unserialize (  string  value  )  [virtual]

Unserialize a samples data from a string Parameters: value  String representation of the samples data. Implements Feature.

featureparams TimeFeature::write (   )  const [virtual]

Externalize feature Returns: Persistant feature data. See also: read Implements PersistantFeature.

---

The documentation for this class was generated from the following files:

• amw/src/cpp/cross/contextprediction/framework/Features/Time/TimeFeature.h
• amw/src/cpp/cross/contextprediction/framework/Features/Time/Time.cpp

---