DtFixedGridConfiguration loads and processes a DDM fixed grid configuration file. More...

Collaboration diagram for DtFixedGridConfiguration:

Classes
struct	DtGridPartition
	The definition of a subspace partition. More...

Public Types
typedef std::vector < DtGridPartition >	DtGridPartitionVector
	The definition of the fixed grid partition.

Public Member Functions
	DtFixedGridConfiguration ()
	Constructor.
	DtFixedGridConfiguration (DtFixedGridConfiguration const &orig)
	Copy Constructor - not allowed.
virtual	~DtFixedGridConfiguration ()
	Destructor.
DtFixedGridConfiguration &	operator= (DtFixedGridConfiguration const &orig)
	Assignment operator - not allowed.
virtual bool	processFile (MAKRti::DtFilename const &gridConfigFilename)
	Process the fixed grid configuration file.
virtual MAKRti::DtString const &	routingSpaceName () const
	Return the fixed grid routing space name.
virtual MAKRti::DtString const &	subspaceDimensionName () const
	Return the subspace dimension (empty string if not defined)
virtual std::vector < MAKRti::DtString > const &	dimensions () const
	Return the ordered list of dimension names.
virtual int	dimensionIndex (MAKRti::DtString const &dimensionName) const
	Return the dimension index for the given dimension name.
virtual DtGridPartitionVector const &	gridPartition () const
	Return the gird partition configuration.
virtual void	print () const
	Display the contents.

Protected Member Functions
virtual bool	loadFile (MAKRti::DtFilename const &gridConfigFilename)
	Open the file and load the configuration data into the MTL environment Return boolean: file laoding was successful?
virtual void	clear ()
	Clear out any existing configuration data.
virtual MAKRti::DtlObjPtr	parseRoutingSpaceName (MAKRti::DtlObjPtr list)
	Parse the routing space name from the configuration list.
virtual MAKRti::DtlObjPtr	parseSubspace (MAKRti::DtlObjPtr list)
	Parse the subspace definition Return the remaining configuration list.
virtual void	parseDimensions (MAKRti::DtlObjPtr list)
	Parse list of dimensions.
virtual bool	parseSubspacePartitions (MAKRti::DtlObjPtr list)
	Parse the subspace partitions Return bool: parse successful without error?
virtual bool	parsePartitions (MAKRti::DtlObjPtr list)
	Parse the single list of partitions (no subspaces) Return bool: parse successful without error?

Protected Attributes
MAKRti::DtFilename	myConfigurationFile
	The configuration file name.
MAKRti::DtMtlEnvironment *	myMtlEnv
	MTL environment for loading configuration Note: This environment is not copied.
MAKRti::DtlObjPtr	myConfigurationList
	Configuration list from the MTL environment Note: This mtl list is not copied.
MAKRti::DtString	myRoutingSpaceName
	Routing space name for dimensions.
MAKRti::DtString	mySubspaceDimension
	Name of dimension used to partition subspaces.
int	myNumberSubspacePartitions
	The number of subspace partitions.
int	myDefaultNumberPartitions
	The default number of partitions for unspecified dimensions.
std::vector< MAKRti::DtString >	myDimensions
	The ordered list of dimensions.
std::map< MAKRti::DtString, int >	myDimensionIndex
	A map from dimension name to its ordered index.
DtGridPartitionVector	myGridPartitions
	The resulting fixed grid partition configuration.

Detailed Description

DtFixedGridConfiguration loads and processes a DDM fixed grid configuration file.

It can then be used to configure the DDM fixed grid.

Member Typedef Documentation

typedef std::vector<DtGridPartition> DtFixedGridConfiguration::DtGridPartitionVector

The definition of the fixed grid partition.

Constructor & Destructor Documentation

DtFixedGridConfiguration::DtFixedGridConfiguration ( )

Constructor.

DtFixedGridConfiguration::DtFixedGridConfiguration ( DtFixedGridConfiguration const & orig )

Copy Constructor - not allowed.

References DtFixedGridConfiguration::DtGridPartition::dimPartitions, myDimensionIndex, myDimensions, myGridPartitions, and DtFixedGridConfiguration::DtGridPartition::name.

DtFixedGridConfiguration::~DtFixedGridConfiguration ( )

virtual

Destructor.

References myMtlEnv.

Member Function Documentation

void DtFixedGridConfiguration::clear ( )

protectedvirtual

Clear out any existing configuration data.

References myConfigurationFile, myConfigurationList, and myMtlEnv.

Referenced by loadFile().

int DtFixedGridConfiguration::dimensionIndex ( MAKRti::DtString const & dimensionName ) const

virtual

Return the dimension index for the given dimension name.

A value of -1 indicates name is invalid and does not have an index

References myDimensionIndex.

Referenced by parseSubspacePartitions().

std::vector< DtString > const & DtFixedGridConfiguration::dimensions ( ) const

virtual

Return the ordered list of dimension names.

References myDimensions.

DtFixedGridConfiguration::DtGridPartitionVector const & DtFixedGridConfiguration::gridPartition ( ) const

virtual

Return the gird partition configuration.

References myGridPartitions.

bool DtFixedGridConfiguration::loadFile ( MAKRti::DtFilename const & gridConfigFilename )

protectedvirtual

Open the file and load the configuration data into the MTL environment Return boolean: file laoding was successful?

References clear(), DtLocateConfigFile(), myConfigurationFile, myConfigurationList, and myMtlEnv.

Referenced by processFile().

DtFixedGridConfiguration & DtFixedGridConfiguration::operator= ( DtFixedGridConfiguration const & orig )

Assignment operator - not allowed.

References DtFixedGridConfiguration::DtGridPartition::dimPartitions, myConfigurationFile, myConfigurationList, myDefaultNumberPartitions, myDimensionIndex, myDimensions, myGridPartitions, myMtlEnv, myNumberSubspacePartitions, myRoutingSpaceName, mySubspaceDimension, and DtFixedGridConfiguration::DtGridPartition::name.

void DtFixedGridConfiguration::parseDimensions ( MAKRti::DtlObjPtr list )

protectedvirtual

Parse list of dimensions.

References myDimensions.

Referenced by parseSubspace().

bool DtFixedGridConfiguration::parsePartitions ( MAKRti::DtlObjPtr list )

protectedvirtual

Parse the single list of partitions (no subspaces) Return bool: parse successful without error?

References DtFixedGridConfiguration::DtGridPartition::dimPartitions, myDimensions, myGridPartitions, and myNumberSubspacePartitions.

Referenced by processFile().

DtlObjPtr DtFixedGridConfiguration::parseRoutingSpaceName ( MAKRti::DtlObjPtr list )

protectedvirtual

Parse the routing space name from the configuration list.

Return the remaining configuration list.

References myRoutingSpaceName.

Referenced by processFile().

DtlObjPtr DtFixedGridConfiguration::parseSubspace ( MAKRti::DtlObjPtr list )

protectedvirtual

Parse the subspace definition Return the remaining configuration list.

References myDefaultNumberPartitions, myDimensionIndex, myDimensions, myGridPartitions, myNumberSubspacePartitions, mySubspaceDimension, and parseDimensions().

Referenced by processFile().

bool DtFixedGridConfiguration::parseSubspacePartitions ( MAKRti::DtlObjPtr list )

protectedvirtual

Parse the subspace partitions Return bool: parse successful without error?

References dimensionIndex(), DtFixedGridConfiguration::DtGridPartition::dimPartitions, DtIsMember, myGridPartitions, myNumberSubspacePartitions, and DtFixedGridConfiguration::DtGridPartition::name.

Referenced by processFile().

void DtFixedGridConfiguration::print ( ) const

virtual

Display the contents.

References DtFixedGridConfiguration::DtGridPartition::dimPartitions, myConfigurationFile, myDefaultNumberPartitions, myDimensions, myGridPartitions, myNumberSubspacePartitions, myRoutingSpaceName, mySubspaceDimension, and DtFixedGridConfiguration::DtGridPartition::name.

Referenced by DtRIDParameters::initializeFixedGrid().

bool DtFixedGridConfiguration::processFile ( MAKRti::DtFilename const & gridConfigFilename )

virtual

Process the fixed grid configuration file.

Any existing configuration is first cleared. Return boolean: file processing was successful?

References loadFile(), myConfigurationFile, myConfigurationList, parsePartitions(), parseRoutingSpaceName(), parseSubspace(), and parseSubspacePartitions().

Referenced by DtRIDParameters::buildDdmGrid().

DtString const & DtFixedGridConfiguration::routingSpaceName ( ) const

virtual

Return the fixed grid routing space name.

References myRoutingSpaceName.

DtString const & DtFixedGridConfiguration::subspaceDimensionName ( ) const

virtual

Return the subspace dimension (empty string if not defined)

References mySubspaceDimension.

Member Data Documentation

MAKRti::DtFilename DtFixedGridConfiguration::myConfigurationFile

protected

The configuration file name.

Referenced by clear(), loadFile(), operator=(), print(), and processFile().

MAKRti::DtlObjPtr DtFixedGridConfiguration::myConfigurationList

protected

Configuration list from the MTL environment Note: This mtl list is not copied.

Referenced by clear(), loadFile(), operator=(), and processFile().

int DtFixedGridConfiguration::myDefaultNumberPartitions

protected

The default number of partitions for unspecified dimensions.

Referenced by operator=(), parseSubspace(), and print().

std::map<MAKRti::DtString, int> DtFixedGridConfiguration::myDimensionIndex

protected

A map from dimension name to its ordered index.

Referenced by dimensionIndex(), DtFixedGridConfiguration(), operator=(), and parseSubspace().

std::vector<MAKRti::DtString> DtFixedGridConfiguration::myDimensions

protected

The ordered list of dimensions.

Referenced by dimensions(), DtFixedGridConfiguration(), operator=(), parseDimensions(), parsePartitions(), parseSubspace(), and print().

DtGridPartitionVector DtFixedGridConfiguration::myGridPartitions

protected

The resulting fixed grid partition configuration.

Referenced by DtFixedGridConfiguration(), gridPartition(), operator=(), parsePartitions(), parseSubspace(), parseSubspacePartitions(), and print().

MAKRti::DtMtlEnvironment* DtFixedGridConfiguration::myMtlEnv

protected

MTL environment for loading configuration Note: This environment is not copied.

Referenced by clear(), loadFile(), operator=(), and ~DtFixedGridConfiguration().

int DtFixedGridConfiguration::myNumberSubspacePartitions

protected

The number of subspace partitions.

Referenced by operator=(), parsePartitions(), parseSubspace(), parseSubspacePartitions(), and print().

MAKRti::DtString DtFixedGridConfiguration::myRoutingSpaceName

protected

Routing space name for dimensions.

Referenced by operator=(), parseRoutingSpaceName(), print(), and routingSpaceName().

MAKRti::DtString DtFixedGridConfiguration::mySubspaceDimension

protected

Name of dimension used to partition subspaces.

Referenced by operator=(), parseSubspace(), print(), and subspaceDimensionName().

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation