TimeSeriesPositionTracker Class Reference

#include <TimeSeriesPositionTracker.h>

Public Member Functions
	TimeSeriesPositionTracker (UINT startIndex=0, UINT endIndex=0, UINT classLabel=0)
	TimeSeriesPositionTracker (const TimeSeriesPositionTracker &rhs)
	~TimeSeriesPositionTracker ()
TimeSeriesPositionTracker &	operator= (const TimeSeriesPositionTracker &rhs)
void	setTracker (UINT startIndex, UINT endIndex, UINT classLabel)
void	setStartIndex (UINT startIndex)
void	setEndIndex (UINT endIndex)
void	setClassLabel (UINT classLabel)
UINT	getStartIndex () const
UINT	getEndIndex () const
UINT	getLength () const
UINT	getClassLabel () const

Protected Attributes
UINT	startIndex
UINT	endIndex
UINT	classLabel

Detailed Description

GRT MIT License Copyright (c) <2012> <Nicholas Gillian, Media Lab, MIT>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Definition at line 36 of file TimeSeriesPositionTracker.h.

Constructor & Destructor Documentation

TimeSeriesPositionTracker::TimeSeriesPositionTracker ( UINT  startIndex = 0, UINT  endIndex = 0, UINT  classLabel = 0  )

inline

Constructor, sets the start index, end index and class label of the timeseries that is to be tracked.

Parameters

startIndex	the index that the tracked timeseries starts in a given dataset. Default value is startIndex=0
endIndex	the index that the tracked timeseries ends in a given dataset. Default value is endIndex=0
classLabel	the class label of the tracked timeseries. Default value is classLabel=0

Definition at line 45 of file TimeSeriesPositionTracker.h.

TimeSeriesPositionTracker::TimeSeriesPositionTracker ( const TimeSeriesPositionTracker &  rhs )

inline

Copy Constructor, copies the TimeSeriesPositionTracker from the rhs instance to this instance

Parameters

rhs	another instance of the TimeSeriesPositionTracker class from which the data will be copied to this instance

Definition at line 56 of file TimeSeriesPositionTracker.h.

TimeSeriesPositionTracker::~TimeSeriesPositionTracker ( )

inline

Default Destructor

Definition at line 65 of file TimeSeriesPositionTracker.h.

Member Function Documentation

UINT TimeSeriesPositionTracker::getClassLabel ( ) const

inline

Gets the class label of the tracked timeseries

Returns

an UINT representing the class label of the tracked timeseries in a given dataset

Definition at line 147 of file TimeSeriesPositionTracker.h.

UINT TimeSeriesPositionTracker::getEndIndex ( ) const

inline

Gets the end index

Returns

an UINT representing the index that the tracked timeseries ends in a given dataset

Definition at line 133 of file TimeSeriesPositionTracker.h.

UINT TimeSeriesPositionTracker::getLength ( ) const

inline

Gets the length of the timeseries

Returns

an UINT representing the length of the tracked timeseries

Definition at line 140 of file TimeSeriesPositionTracker.h.

UINT TimeSeriesPositionTracker::getStartIndex ( ) const

inline

Gets the start index

Returns

an UINT representing the index that the tracked timeseries starts in a given dataset

Definition at line 126 of file TimeSeriesPositionTracker.h.

TimeSeriesPositionTracker& TimeSeriesPositionTracker::operator= ( const TimeSeriesPositionTracker &  rhs )

inline

Sets the equals operator, copies the data from the rhs instance to this instance

Parameters

rhs	another instance of the TimeSeriesPositionTracker class from which the data will be copied to this instance

Returns

a reference to this instance of TimeSeriesPositionTracker

Definition at line 73 of file TimeSeriesPositionTracker.h.

void TimeSeriesPositionTracker::setClassLabel ( UINT  classLabel )

inline

Sets the class label

Parameters

classLabel

the class label of the tracked timeseries

Returns

void

Definition at line 119 of file TimeSeriesPositionTracker.h.

void TimeSeriesPositionTracker::setEndIndex ( UINT  endIndex )

inline

Sets the end index

Parameters

endIndex

the index that the tracked timeseries ends in a given dataset

Returns

void

Definition at line 111 of file TimeSeriesPositionTracker.h.

void TimeSeriesPositionTracker::setStartIndex ( UINT  startIndex )

inline

Sets the start index

Parameters

startIndex

the index that the tracked timeseries starts in a given dataset

Returns

void

Definition at line 103 of file TimeSeriesPositionTracker.h.

void TimeSeriesPositionTracker::setTracker ( UINT  startIndex, UINT  endIndex, UINT  classLabel  )

inline

Sets the tracker values

Parameters

startIndex	the index that the tracked timeseries starts in a given dataset
endIndex	the index that the tracked timeseries ends in a given dataset
classLabel	the class label of the tracked timeseries

Returns

void

Definition at line 91 of file TimeSeriesPositionTracker.h.

---

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

• TimeSeriesPositionTracker.h