Field3D
File::Partition Class Reference

#include <Field3DFile.h>

Inheritance diagram for File::Partition:
RefBase RefBase

List of all members.

Public Types

typedef boost::intrusive_ptr
< const Partition
CPtr
typedef boost::intrusive_ptr
< const Partition
CPtr
typedef boost::intrusive_ptr
< Partition
Ptr
typedef boost::intrusive_ptr
< Partition
Ptr
typedef std::vector< LayerScalarLayerList
typedef std::vector< LayerScalarLayerList
typedef std::vector< LayerVectorLayerList
typedef std::vector< LayerVectorLayerList

Public Member Functions

void addScalarLayer (const File::Layer &layer)
 Adds a scalar layer.
void addScalarLayer (const File::Layer &layer)
 Adds a scalar layer.
void addVectorLayer (const File::Layer &layer)
 Adds a vector layer.
void addVectorLayer (const File::Layer &layer)
 Adds a vector layer.
void getScalarLayerNames (std::vector< std::string > &names) const
 Gets all the scalar layer names.
void getScalarLayerNames (std::vector< std::string > &names) const
 Gets all the scalar layer names.
void getVectorLayerNames (std::vector< std::string > &names) const
 Gets all the vector layer names.
void getVectorLayerNames (std::vector< std::string > &names) const
 Gets all the vector layer names.
 Partition ()
 Ctor.
 Partition ()
 Ctor.
const File::LayerscalarLayer (const std::string &name) const
 Finds a scalar layer.
const File::LayerscalarLayer (const std::string &name) const
 Finds a scalar layer.
const File::LayervectorLayer (const std::string &name) const
 Finds a vector layer.
const File::LayervectorLayer (const std::string &name) const
 Finds a vector layer.

Public Attributes

FieldMapping::Ptr mapping
 Pointer to the mapping object.
std::string name
 Name of the partition.

Private Attributes

ScalarLayerList m_scalarLayers
 The scalar-valued layers belonging to this partition.
VectorLayerList m_vectorLayers
 The vector-valued layers belonging to this partition.

Detailed Description

This class represents the partition-level node in a f3D file. The partition contains one "Mapping" and N "Fields" that all share that mapping.

Definition at line 142 of file Field3DFile.h.


Member Typedef Documentation

Definition at line 146 of file Field3DFile.h.

Definition at line 147 of file Field3DFile.h.

typedef boost::intrusive_ptr<Partition> File::Partition::Ptr

Reimplemented from RefBase.

Definition at line 149 of file Field3DFile.h.

typedef boost::intrusive_ptr<const Partition> File::Partition::CPtr

Definition at line 150 of file Field3DFile.h.

Definition at line 146 of file Field3DFile.h.

Definition at line 147 of file Field3DFile.h.

typedef boost::intrusive_ptr<Partition> File::Partition::Ptr

Reimplemented from RefBase.

Definition at line 149 of file Field3DFile.h.

typedef boost::intrusive_ptr<const Partition> File::Partition::CPtr

Definition at line 150 of file Field3DFile.h.


Constructor & Destructor Documentation

File::Partition::Partition ( ) [inline]

Ctor.

Definition at line 155 of file Field3DFile.h.

: RefBase() {}
File::Partition::Partition ( ) [inline]

Ctor.

Definition at line 155 of file Field3DFile.h.

: RefBase() {}

Member Function Documentation

void Partition::addScalarLayer ( const File::Layer layer)

Adds a scalar layer.

Definition at line 207 of file Field3DFile.cpp.

{
  m_scalarLayers.push_back(layer);
}
void Partition::addVectorLayer ( const File::Layer layer)

Adds a vector layer.

Definition at line 215 of file Field3DFile.cpp.

{
  m_vectorLayers.push_back(layer);
}
const Layer * Partition::scalarLayer ( const std::string &  name) const

Finds a scalar layer.

Definition at line 223 of file Field3DFile.cpp.

{
  for (ScalarLayerList::const_iterator i = m_scalarLayers.begin();
       i != m_scalarLayers.end(); ++i) {
    if (i->name == name)
      return &(*i);
  }
  return NULL;
}
const Layer * Partition::vectorLayer ( const std::string &  name) const

Finds a vector layer.

Definition at line 236 of file Field3DFile.cpp.

{
  for (VectorLayerList::const_iterator i = m_vectorLayers.begin();
       i != m_vectorLayers.end(); ++i) {
    if (i->name == name)
      return &(*i);
  }
  return NULL;
}
void Partition::getScalarLayerNames ( std::vector< std::string > &  names) const

Gets all the scalar layer names.

Definition at line 249 of file Field3DFile.cpp.

{
  // We don't want to do names.clear() here, since this gets called
  // inside some loops that want to accumulate names.
  for (ScalarLayerList::const_iterator i = m_scalarLayers.begin();
       i != m_scalarLayers.end(); ++i) {
    names.push_back(i->name);
  }
}
void Partition::getVectorLayerNames ( std::vector< std::string > &  names) const

Gets all the vector layer names.

Definition at line 262 of file Field3DFile.cpp.

{
  // We don't want to do names.clear() here, since this gets called
  // inside some loops that want to accumulate names.
  for (VectorLayerList::const_iterator i = m_vectorLayers.begin();
       i != m_vectorLayers.end(); ++i) {
    names.push_back(i->name);
  }
}
void File::Partition::addScalarLayer ( const File::Layer layer)

Adds a scalar layer.

void File::Partition::addVectorLayer ( const File::Layer layer)

Adds a vector layer.

const File::Layer* File::Partition::scalarLayer ( const std::string &  name) const

Finds a scalar layer.

const File::Layer* File::Partition::vectorLayer ( const std::string &  name) const

Finds a vector layer.

void File::Partition::getScalarLayerNames ( std::vector< std::string > &  names) const

Gets all the scalar layer names.

void File::Partition::getVectorLayerNames ( std::vector< std::string > &  names) const

Gets all the vector layer names.


Member Data Documentation

std::string File::Partition::name

Name of the partition.

Definition at line 177 of file Field3DFile.h.

Pointer to the mapping object.

Definition at line 179 of file Field3DFile.h.

The scalar-valued layers belonging to this partition.

Definition at line 186 of file Field3DFile.h.

The vector-valued layers belonging to this partition.

Definition at line 188 of file Field3DFile.h.


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