DtFixedGridConfiguration Class Reference

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.

virtual DtFixedGridConfiguration::~DtFixedGridConfiguration ( )

virtual

Destructor.

Member Function Documentation

virtual void DtFixedGridConfiguration::clear ( )

protectedvirtual

Clear out any existing configuration data.

virtual 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

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

virtual

Return the ordered list of dimension names.

virtual DtGridPartitionVector const& DtFixedGridConfiguration::gridPartition ( ) const

virtual

Return the gird partition configuration.

virtual 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?

DtFixedGridConfiguration& DtFixedGridConfiguration::operator=

(

DtFixedGridConfiguration const &

orig

)

Assignment operator - not allowed.

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

protectedvirtual

Parse list of dimensions.

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

protectedvirtual

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

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

protectedvirtual

Parse the routing space name from the configuration list.

Return the remaining configuration list.

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

protectedvirtual

Parse the subspace definition Return the remaining configuration list.

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

protectedvirtual

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

virtual void DtFixedGridConfiguration::print ( ) const

virtual

Display the contents.

virtual 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?

virtual MAKRti::DtString const& DtFixedGridConfiguration::routingSpaceName ( ) const

virtual

Return the fixed grid routing space name.

virtual MAKRti::DtString const& DtFixedGridConfiguration::subspaceDimensionName ( ) const

virtual

Return the subspace dimension (empty string if not defined)

Member Data Documentation

MAKRti::DtFilename DtFixedGridConfiguration::myConfigurationFile

protected

The configuration file name.

MAKRti::DtlObjPtr DtFixedGridConfiguration::myConfigurationList

protected

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

int DtFixedGridConfiguration::myDefaultNumberPartitions

protected

The default number of partitions for unspecified dimensions.

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

protected

A map from dimension name to its ordered index.

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

protected

The ordered list of dimensions.

DtGridPartitionVector DtFixedGridConfiguration::myGridPartitions

protected

The resulting fixed grid partition configuration.

MAKRti::DtMtlEnvironment* DtFixedGridConfiguration::myMtlEnv

protected

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

int DtFixedGridConfiguration::myNumberSubspacePartitions

protected

The number of subspace partitions.

MAKRti::DtString DtFixedGridConfiguration::myRoutingSpaceName

protected

Routing space name for dimensions.

MAKRti::DtString DtFixedGridConfiguration::mySubspaceDimension

protected

Name of dimension used to partition subspaces.

---

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

• fixedGridConfiguration.h