GridPoint Class Reference

Detailed Description

This class handles the topological information for the modules. Provides a lot of math-only utility functions. All the derived classes use those functions. The derived classes are.

*  |GridPoint
*  |--/scGridPoint
*  |..../AbstractCore
*  |....../XXCore
*  |....../AbstractNeurer
*  |......../Neurer
* 

Inheritance diagram for GridPoint:

Public Member Functions
ClusterAddress_t	ClusterAddress_Get (void)
	< Return the cluster address of the gridpoint, stored in the matrix
void	ClusterAddress_Set (ClusterAddress_t CA)
	Set the cluster address of the gridpoint.
void	ClusterAddressHThread_Set (int H)
	Set the cluster address of the gridpoint.
ClusterStatus	ClusterStatus_Get (void)
	Return the status of the gridpoint.
void	ClusterStatus_Set (ClusterStatus CS)
	Set the cstatus of the gridpoint.
bool	Is2ndNeighborOf (GridPoint *GP)
	Return true if we are a second neighbor of GP. More...
bool	IsInTheSameClusterAs (GridPoint *GP)
	Return true if we and GridPoint GP are in the same cluster. More...
bool	IsNeighborOf (GridPoint *GP)
	Return true if we are an immediate neighbor of GP. More...
bool	IsTheSameAs (GridPoint *GP)
	Return true if GridPoint GP is identical with us. More...
string	StringOfClusterAddressName_Get (void)
	Return the string form of our cluster address. More...
string	StringOfThread_Get ()
	Return the string describing the actual thread. More...

Public Attributes
ClusterAddress_t	mClusterAddress
	The ClusterAddress_t address of the gridpoint.
int8_t	X
	The X index of the gridpont.
int8_t	Y
	The Y index of the gridpont.

Member Function Documentation

Is2ndNeighborOf()

bool GridPoint::Is2ndNeighborOf ( GridPoint *  GP )

inline

Return true if we are a second neighbor of GP.

Parameters

[in]

GP

the other gridpoint

Returns

true if GP is our second neighbor

IsInTheSameClusterAs()

bool GridPoint::IsInTheSameClusterAs ( GridPoint *  GP )

inline

Return true if we and GridPoint GP are in the same cluster.

Parameters

GP	The other gridpoint

Returns

true if this and GP belong to the same cluster

IsNeighborOf()

bool GridPoint::IsNeighborOf ( GridPoint *  GP )

inline

Return true if we are an immediate neighbor of GP.

Parameters

[in]

GP

the other gridpoint

Returns

true if GP is our neighbor

IsTheSameAs()

bool GridPoint::IsTheSameAs ( GridPoint *  GP )

inline

Return true if GridPoint GP is identical with us.

Parameters

GP	The other gridpoint

Returns

true if this and GP are the same gridpoint

StringOfClusterAddressName_Get()

string GridPoint::StringOfClusterAddressName_Get ( void  )

inline

Return the string form of our cluster address.

The string form comprises two parts

• the arguments between {} provide the position coordinates
• the arguments between () provide the clusterized address

StringOfThread_Get()

string GridPoint::StringOfThread_Get ( )

inline

Return the string describing the actual thread.

Returns

the string form of only the HW thread of the gridpoint

---

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

• GridPoint.h