iso::space::SpaceObjectsAnalyzer Class Reference

abstract base class for analyzing space object distributions More...

#include <iso_space_objects_analyzer.h>

Inherited by iso::space::SpaceClusterAnalyzer.

Inheritance diagram for iso::space::SpaceObjectsAnalyzer:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 SpaceObjectsAnalyzer ()
 default constructor
 SpaceObjectsAnalyzer (base::String pName)
 parameter based constructor
virtual ~SpaceObjectsAnalyzer ()
 destructor
const base::String & name () const
 return name
bool modifiable () const
 check whether the analyzer is modifiable
bool checkObjectGroup (const base::String &pGroupName) const
 check whether object group exists
virtual void addObjectGroup (const base::String &pGroupName)
 add space object group
virtual void removeObjectGroup (unsigned int pGroupIndex)
 remove space object group
virtual void removeObjectGroup (const base::String &pGroupName)
 remove space object group
virtual void addObject (unsigned int pGroupIndex, const SpaceObject *pSpaceObject)
 add space object
virtual void addObjects (unsigned int pGroupIndex, QVector< const SpaceObject * > &pSpaceObjects)
 add space objects
virtual void addObject (const base::String &pGroupName, const SpaceObject *pSpaceObject)
 add space object
virtual void addObjects (const base::String &pGroupName, QVector< const SpaceObject * > &pSpaceObjects)
 add space objects
virtual void addObject (unsigned int pDataGroupIndex, const NeighborGroup *pNeighborGroup)
 add space object
virtual void addObjects (unsigned int pDataGroupIndex, QVector< const NeighborGroup * > &pNeighborGroups)
 add space objects
virtual void addObject (const base::String &pGroupName, const NeighborGroup *pNeighborGroup)
 add space object
virtual void addObjects (const base::String &pGroupName, QVector< const NeighborGroup * > &pNeighborGroups)
 add space objects
void removeObject (unsigned int pGroupIndex, const SpaceObject *pSpaceObject)
 remove space object
void removeObject (const base::String &pGroupName, const SpaceObject *pSpaceObject)
 remove space object
void removeObject (unsigned int pGroupIndex, const NeighborGroup *pNeighborGroup)
 remove space object
void removeObject (const base::String &pGroupName, const NeighborGroup *pNeighborGroup)
 remove space object
void removeObjects (unsigned int pDataGroupIndex)
 remove space objects
void removeObjects (const base::String &pGroupName)
 remove space objects
const math::Vector< real > & result (unsigned int pResultIndex) const
 return analysis result
const math::Vector< real > & result (const base::String &pResultName) const
 return analysis result
const data::IndexHash< base::String,
math::Vector< real > > & 
results () const
 return analysis results
virtual void analyze ()
 perform analysis

Protected Attributes

data::IndexHash< base::String,
SpaceProxyObjectGroup
mSpaceObjectGroups
data::IndexHash< base::String,
math::Vector< real > > 
mResults
 space data groups
base::String mName
 analysis results
bool mModifiable
 name of analyzer
QMutex mLock
 flag whether number of data groups can be modified or not

Detailed Description

abstract base class for analyzing space object distributions

class for analyzing space object distributions

Created by Daniel Bisig on 5/30/08.


Constructor & Destructor Documentation

SpaceObjectsAnalyzer::SpaceObjectsAnalyzer (  ) 

default constructor

SpaceObjectsAnalyzer::SpaceObjectsAnalyzer ( base::String  pName  ) 

parameter based constructor

Parameters:
pName of space data analyzer

SpaceObjectsAnalyzer::~SpaceObjectsAnalyzer (  )  [virtual]

destructor


Member Function Documentation

const base::String & SpaceObjectsAnalyzer::name (  )  const

return name

Returns:
name

bool SpaceObjectsAnalyzer::modifiable (  )  const

check whether the analyzer is modifiable

Returns:
true if it is, false otherwise

bool SpaceObjectsAnalyzer::checkObjectGroup ( const base::String &  pGroupName  )  const

check whether object group exists

Parameters:
pGroupName name of object group
Returns:
true if it does, false otherwise

void SpaceObjectsAnalyzer::addObjectGroup ( const base::String &  pGroupName  )  [virtual]

add space object group

Parameters:
pGroupName name of object group

Reimplemented in iso::space::SpaceClusterAnalyzer.

void SpaceObjectsAnalyzer::removeObjectGroup ( unsigned int  pGroupIndex  )  [virtual]

remove space object group

Parameters:
pGroupIndex index of object group

void SpaceObjectsAnalyzer::removeObjectGroup ( const base::String &  pGroupName  )  [virtual]

remove space object group

Parameters:
pGroupName name of object group

void SpaceObjectsAnalyzer::addObject ( unsigned int  pGroupIndex,
const SpaceObject pSpaceObject 
) [virtual]

add space object

Parameters:
pGroupIndex space object group index
pSpaceObject space object

Reimplemented in iso::space::SpaceClusterAnalyzer.

void SpaceObjectsAnalyzer::addObjects ( unsigned int  pGroupIndex,
QVector< const SpaceObject * > &  pSpaceObjects 
) [virtual]

add space objects

Parameters:
pGroupIndex space object group index
pSpaceObjects vector of space objects

Reimplemented in iso::space::SpaceClusterAnalyzer.

void SpaceObjectsAnalyzer::addObject ( const base::String &  pGroupName,
const SpaceObject pSpaceObject 
) [virtual]

add space object

Parameters:
pGroupName space object group name
pSpaceObject space objects

Reimplemented in iso::space::SpaceClusterAnalyzer.

void SpaceObjectsAnalyzer::addObjects ( const base::String &  pGroupName,
QVector< const SpaceObject * > &  pSpaceObjects 
) [virtual]

add space objects

Parameters:
pGroupName space object group name
pSpaceObjects vector of space objects

Reimplemented in iso::space::SpaceClusterAnalyzer.

void SpaceObjectsAnalyzer::addObject ( unsigned int  pDataGroupIndex,
const NeighborGroup pNeighborGroup 
) [virtual]

add space object

Parameters:
pDataGroupIndex space object group index
pNeighborGroup neighbor group

void SpaceObjectsAnalyzer::addObjects ( unsigned int  pDataGroupIndex,
QVector< const NeighborGroup * > &  pNeighborGroups 
) [virtual]

add space objects

Parameters:
pDataGroupIndex space object group index
pNeighborGroups vector of neighbor groups

void SpaceObjectsAnalyzer::addObject ( const base::String &  pGroupName,
const NeighborGroup pNeighborGroup 
) [virtual]

add space object

Parameters:
pGroupName space object group name
pNeighborGroup neighbor group

void SpaceObjectsAnalyzer::addObjects ( const base::String &  pGroupName,
QVector< const NeighborGroup * > &  pNeighborGroups 
) [virtual]

add space objects

Parameters:
pGroupName space object group name
pNeighborGroups vector of neighbor groups

void SpaceObjectsAnalyzer::removeObject ( unsigned int  pGroupIndex,
const SpaceObject pSpaceObject 
)

remove space object

Parameters:
pGroupIndex space object group index
pSpaceObject space object

void SpaceObjectsAnalyzer::removeObject ( const base::String &  pGroupName,
const SpaceObject pSpaceObject 
)

remove space object

Parameters:
pGroupName space object group name
pSpaceObject space object

void SpaceObjectsAnalyzer::removeObject ( unsigned int  pGroupIndex,
const NeighborGroup pNeighborGroup 
)

remove space object

Parameters:
pGroupIndex space object group index
pNeighborGroup neighbor group

void SpaceObjectsAnalyzer::removeObject ( const base::String &  pGroupName,
const NeighborGroup pNeighborGroup 
)

remove space object

Parameters:
pGroupName space object group name
pNeighborGroup neighbor group

void SpaceObjectsAnalyzer::removeObjects ( unsigned int  pDataGroupIndex  ) 

remove space objects

Parameters:
pDataGroupIndex space object group index

void SpaceObjectsAnalyzer::removeObjects ( const base::String &  pGroupName  ) 

remove space objects

Parameters:
pGroupName space object group name

const math::Vector< space::real > & SpaceObjectsAnalyzer::result ( unsigned int  pResultIndex  )  const

return analysis result

Parameters:
pResultIndex result index
Returns:
result as vector

const math::Vector< space::real > & SpaceObjectsAnalyzer::result ( const base::String &  pResultName  )  const

return analysis result

Parameters:
pResultName result name
Returns:
result as vector

const data::IndexHash< base::String, math::Vector< space::real > > & SpaceObjectsAnalyzer::results (  )  const

return analysis results

Returns:
QVector of all vector results

void SpaceObjectsAnalyzer::analyze (  )  [virtual]

perform analysis

Reimplemented in iso::space::SpaceClusterAnalyzer.


Member Data Documentation

data::IndexHash< base::String, SpaceProxyObjectGroup > iso::space::SpaceObjectsAnalyzer::mSpaceObjectGroups [protected]

data::IndexHash< base::String, math::Vector<real> > iso::space::SpaceObjectsAnalyzer::mResults [protected]

space data groups

base::String iso::space::SpaceObjectsAnalyzer::mName [protected]

analysis results

bool iso::space::SpaceObjectsAnalyzer::mModifiable [protected]

name of analyzer

QMutex iso::space::SpaceObjectsAnalyzer::mLock [protected]

flag whether number of data groups can be modified or not


The documentation for this class was generated from the following files:
Generated on Fri Feb 25 14:08:15 2011 for iso_space by  doxygen 1.5.1