PHX::ArrayDimTag Class Reference
[Mdarray_module]

Abstract base class for array dimension tags supplied to the Array template class. More...

#include <Phalanx_Array.hpp>

Inheritance diagram for PHX::ArrayDimTag:

Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual const char * name () const =0
 Name of the tag, typically the name of the derived class.
virtual std::string to_string (unsigned dimension, unsigned index) const
 Given a dimension and index produce a string for output. Default to converting index to a string.
virtual unsigned to_index (unsigned dimension, const std::string &label) const
 Given a dimension and input strige produce an index. Default to converting label to an integer.

Protected Member Functions

virtual ~ArrayDimTag ()
 ArrayDimTag ()

Private Member Functions

 ArrayDimTag (const ArrayDimTag &)
ArrayDimTagoperator= (const ArrayDimTag &)


Detailed Description

Abstract base class for array dimension tags supplied to the Array template class.

See also:
Array
A derived array dimension tag class must provide the name method and tag singleton method as in the following example.
  struct MyTag : public PHX::ArrayDimTag {
    const char * name() const ;
    static const MyTag & tag();
  };
  
An example implementation of these methods is as follows.
  const char * MyTag::name() const
  { static const char my_name[] = "MyTag" ; return my_name ; }

  const MyTag & MyTag::tag()
  { static const MyTag my_tag ; return my_tag ; }
  

Constructor & Destructor Documentation

PHX::ArrayDimTag::~ArrayDimTag (  )  [protected, virtual]

PHX::ArrayDimTag::ArrayDimTag (  )  [inline, protected]

PHX::ArrayDimTag::ArrayDimTag ( const ArrayDimTag  )  [private]


Member Function Documentation

virtual const char* PHX::ArrayDimTag::name (  )  const [pure virtual]

Name of the tag, typically the name of the derived class.

Implemented in PHX::ArrayDimension, Dim, QuadPoint, Node, Point, and Cell.

ArrayDimTag& PHX::ArrayDimTag::operator= ( const ArrayDimTag  )  [private]

unsigned PHX::ArrayDimTag::to_index ( unsigned  dimension,
const std::string &  label 
) const [virtual]

Given a dimension and input strige produce an index. Default to converting label to an integer.

References PHX::array_check_index().

Here is the call graph for this function:

std::string PHX::ArrayDimTag::to_string ( unsigned  dimension,
unsigned  index 
) const [virtual]

Given a dimension and index produce a string for output. Default to converting index to a string.

References PHX::array_check_index().

Here is the call graph for this function:


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

Generated on Thu Dec 17 11:06:14 2009 for Phalanx by  doxygen 1.5.9