FEI Version of the Day
Public Types | Public Member Functions
fei::SharedIDs< T > Class Template Reference

#include <fei_SharedIDs.hpp>

Inheritance diagram for fei::SharedIDs< T >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef std::map< T, std::set
< int > > 
map_type

Public Member Functions

 SharedIDs ()
 SharedIDs (const SharedIDs< T > &src)
virtual ~SharedIDs ()
void addSharedID (const T &ID, size_t numSharingProcs, const int *sharingProcs)
map_typegetSharedIDs ()
const map_typegetSharedIDs () const
std::vector< int > & getOwningProcs ()
const std::vector< int > & getOwningProcs () const

Detailed Description

template<typename T>
class fei::SharedIDs< T >

Simple container for IDs that are shared among multiple processors.

Definition at line 57 of file fei_SharedIDs.hpp.


Member Typedef Documentation

template<typename T>
typedef std::map<T,std::set<int> > fei::SharedIDs< T >::map_type

typedef for the type of the internal data container

Definition at line 73 of file fei_SharedIDs.hpp.


Constructor & Destructor Documentation

template<typename T>
fei::SharedIDs< T >::SharedIDs ( ) [inline]

constructor

Definition at line 60 of file fei_SharedIDs.hpp.

template<typename T>
fei::SharedIDs< T >::SharedIDs ( const SharedIDs< T > &  src) [inline]

Copy Constructor

Definition at line 65 of file fei_SharedIDs.hpp.

template<typename T>
virtual fei::SharedIDs< T >::~SharedIDs ( ) [inline, virtual]

destructor

Definition at line 70 of file fei_SharedIDs.hpp.


Member Function Documentation

template<typename T>
void fei::SharedIDs< T >::addSharedID ( const T &  ID,
size_t  numSharingProcs,
const int *  sharingProcs 
) [inline]

Associate ID with specified sharing processors. If ID is already present in the sharedIDs table, then this method simply adds the specified sharing processors to that ID's set of sharing processors (if they are not already present).

Definition at line 80 of file fei_SharedIDs.hpp.

template<typename T>
map_type& fei::SharedIDs< T >::getSharedIDs ( ) [inline]

Retrieve the internal container holding shared-ID data.

Definition at line 92 of file fei_SharedIDs.hpp.

template<typename T>
const map_type& fei::SharedIDs< T >::getSharedIDs ( ) const [inline]

Retrieve the internal container holding shared-ID data.

Definition at line 95 of file fei_SharedIDs.hpp.

template<typename T>
std::vector<int>& fei::SharedIDs< T >::getOwningProcs ( ) [inline]

Retrieve a vector holding the owning-processors for the stored shared IDs.

Definition at line 99 of file fei_SharedIDs.hpp.

template<typename T>
const std::vector<int>& fei::SharedIDs< T >::getOwningProcs ( ) const [inline]

Retrieve a vector holding the owning-processors for the stored shared IDs.

Definition at line 103 of file fei_SharedIDs.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends