Pointwise Plugin SDK
Public Member Functions | List of all members
CaeStrCustomIndexHandler Class Referenceabstract
The Fidelity Pointwise Grid Model API » Using C++ » Fidelity Pointwise C++ Unstructured Grid Model Classes

The structured grid model index mapper handler class. More...

#include <CaeStrGridModel.h>

Public Member Functions

virtual PWGM_INDEX3 mapIndex (const PWGM_INDEX3 pwgmNdx)=0
 Pure virtual index mapping method. More...
 
virtual ~CaeStrCustomIndexHandler ()
 Destructor. More...
 

Detailed Description

The structured grid model index mapper handler class.

Handler objects passed to CaeStrGridModel::customIndexSchemeReady() must inherit the CaeStrCustomIndexHandler class and implement the mapIndex() pure virtual method.

Index mapping is only needed if the plugin's IndexScheme is set to Custom and MeshLinkSupported is true.

See also
meshLinkSupported(), useZeroBasedIndexing(), useOneBasedIndexing(), useCustomIndexing()

Definition at line 36 of file CaeStrGridModel.h.

Constructor & Destructor Documentation

◆ ~CaeStrCustomIndexHandler()

virtual CaeStrCustomIndexHandler::~CaeStrCustomIndexHandler ( )
inlinevirtual

Destructor.

Definition at line 39 of file CaeStrGridModel.h.

Member Function Documentation

◆ mapIndex()

virtual PWGM_INDEX3 CaeStrCustomIndexHandler::mapIndex ( const PWGM_INDEX3  pwgmNdx)
pure virtual

Pure virtual index mapping method.

This method is called as needed by the pointwise export framework (by way of CaeStrGridModel::customIndexSchemeReady()) to map indices.

Subclasses are required to implement this virtual method.

Parameters
pwgmNdxThe index as defined in the PWGM.
Returns
The exported index that corresponds to pwgmNdx.

Referenced by ndxMapperCB().

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