Aimsun Next Scripting  22
Public Member Functions | List of all members
GKRealDataSetFilter Class Reference

Public Member Functions

 GKRealDataSetFilter ()
 
 ~GKRealDataSetFilter ()
 
bool filterByTime () const
 
void setTimes (const QDateTime &afrom, const QDateTime &ato)
 
const QDateTime & getFromTime () const
 
const QDateTime & getToTime () const
 
bool filterByArea () const
 
void setPolygon (GKPolygon *pol)
 
GKPolygongetPolygon () const
 
bool isValid (const QDateTime &atime) const
 
bool isValid (const GKGeoObject *obj) const
 

Detailed Description

This class is used to filter the data available in a real data set to load in memory the relevant information.

A filter can be set by time and/or geographical area.

Constructor & Destructor Documentation

◆ GKRealDataSetFilter()

GKRealDataSetFilter::GKRealDataSetFilter ( )

◆ ~GKRealDataSetFilter()

GKRealDataSetFilter::~GKRealDataSetFilter ( )

Member Function Documentation

◆ filterByArea()

bool GKRealDataSetFilter::filterByArea ( ) const

Returns true if the data is filtered by area.

◆ filterByTime()

bool GKRealDataSetFilter::filterByTime ( ) const

Returns true if the data is filtered by date.

◆ getFromTime()

const QDateTime & GKRealDataSetFilter::getFromTime ( ) const

Get the filter from time.

◆ getPolygon()

GKPolygon * GKRealDataSetFilter::getPolygon ( ) const

The filter polygon.

◆ getToTime()

const QDateTime & GKRealDataSetFilter::getToTime ( ) const

Get the filter to time.

◆ isValid() [1/2]

bool GKRealDataSetFilter::isValid ( const GKGeoObject obj) const

Returns true if the obj is inside the filtered area. It returns true is we are not filtering by area (any location is OK then).

◆ isValid() [2/2]

bool GKRealDataSetFilter::isValid ( const QDateTime &  atime) const

Returns true if the data is between the from a to times. It returns true is we are not filtering by data (any date is OK then).

◆ setPolygon()

void GKRealDataSetFilter::setPolygon ( GKPolygon pol)

The filter polygon.

◆ setTimes()

void GKRealDataSetFilter::setTimes ( const QDateTime &  afrom,
const QDateTime &  ato 
)

Set the filter times.

© Aimsun SLU
Aimsun ®