wsf::coverage::GridAsset Class Reference

#include <WsfCoverageAsset.hpp>

Public Member Functions
	GridAsset (const std::string &aPlatformName, PointId aPointId, const std::string &aDeviceName)
PointId	GetPointId () const
	Get the ID of the point in the grid to which this grid asset refers.
const std::string &	GetDeviceName () const
	Get the name of the device to which this grid asset refers.
std::string	GetPlatformName () const
	Return the platform name corresponding to this grid asset.
bool	IsValid () const
	Return if this grid asset refers to a valid grid point.
void	SetPlatformName (const std::string &aPlatformName)
	Set the name of the coverage object to which this grid asset refers.
void	SetPointId (PointId aPointId)
	Set the ID of the point in the grid to which this grid asset refers.
void	SetDeviceName (const std::string &aDeviceName)
	Set the name of the device to which this grid asset refers.

Detailed Description

Representation of a grid asset.

Grid assets are defined by a platform name, a PointId for the grid point the asset represents, and the name of a device participating in the coverage calculation. In some cases, the device name can be 'none', indicating that the interactions participating in the coverage computation do not need devices on both interacting platforms.

Constructor & Destructor Documentation

GridAsset()

wsf::coverage::GridAsset::GridAsset ( const std::string & aPlatformName, PointId aPointId, const std::string & aDeviceName )

inline

Member Function Documentation

GetDeviceName()

const std::string & wsf::coverage::GridAsset::GetDeviceName ( ) const

inline

Get the name of the device to which this grid asset refers.

Referenced by std::less< wsf::coverage::GridAsset >::operator()().

GetPlatformName()

std::string wsf::coverage::GridAsset::GetPlatformName ( ) const

inline

Return the platform name corresponding to this grid asset.

Referenced by std::less< wsf::coverage::GridAsset >::operator()().

GetPointId()

PointId wsf::coverage::GridAsset::GetPointId ( ) const

inline

Get the ID of the point in the grid to which this grid asset refers.

Referenced by std::less< wsf::coverage::GridAsset >::operator()().

IsValid()

bool wsf::coverage::GridAsset::IsValid ( ) const

inline

Return if this grid asset refers to a valid grid point.

References wsf::coverage::cINVALID_POINT_ID.

SetDeviceName()

void wsf::coverage::GridAsset::SetDeviceName ( const std::string & aDeviceName )

inline

Set the name of the device to which this grid asset refers.

SetPlatformName()

void wsf::coverage::GridAsset::SetPlatformName ( const std::string & aPlatformName )

inline

Set the name of the coverage object to which this grid asset refers.

SetPointId()

void wsf::coverage::GridAsset::SetPointId ( PointId aPointId )

inline

Set the ID of the point in the grid to which this grid asset refers.

Referenced by wsf::coverage::CompositeGrid::InitializeP().

---

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

• WsfCoverageAsset.hpp