VolumeSide Class Reference

#include <VolumeSide.h>

Public Types
typedef SurfaceOrientation::GlobalFace	GlobalFace
typedef SurfaceOrientation::Side	Side
typedef ReferenceCountingPointer< Surface >	SurfacePointer

Public Member Functions
GlobalFace	globalFace () const
Surface &	mutableSurface () const
const Surface &	surface () const
Side	surfaceSide () const
	VolumeSide (Surface *surf, GlobalFace gSide, Side sSide)
	VolumeSide (SurfacePointer surf, GlobalFace gSide, Side sSide)

Private Attributes
GlobalFace	theGlobalFace
SurfacePointer	theSurface
Side	theSurfaceSide

Detailed Description

Class for delimiding surface of a volume. The additional information with respect to Surface that is needed to define the volume is
a) which side of the Surface the volume is (enumerator Surface::Side)
b) which face of the volume this surface represents (enumerator GlobalFace). Only 6 possible values for volume face are defined.

Definition at line 15 of file VolumeSide.h.

Member Typedef Documentation

typedef SurfaceOrientation::GlobalFace VolumeSide::GlobalFace

Definition at line 17 of file VolumeSide.h.

typedef SurfaceOrientation::Side VolumeSide::Side

Definition at line 18 of file VolumeSide.h.

typedef ReferenceCountingPointer<Surface> VolumeSide::SurfacePointer

Definition at line 20 of file VolumeSide.h.

Constructor & Destructor Documentation

VolumeSide::VolumeSide ( Surface *  surf, GlobalFace  gSide, Side  sSide  )

inline

Definition at line 22 of file VolumeSide.h.

                                                           : 
    theSurface( surf),  theGlobalFace( gSide), theSurfaceSide( sSide) {}

VolumeSide::VolumeSide ( SurfacePointer  surf, GlobalFace  gSide, Side  sSide  )

inline

Definition at line 25 of file VolumeSide.h.

                      : 
    theSurface( surf),  theGlobalFace( gSide), theSurfaceSide( sSide) {}

Member Function Documentation

GlobalFace VolumeSide::globalFace ( ) const

inline

Definition at line 33 of file VolumeSide.h.

References theGlobalFace.

{ return theGlobalFace;}

Surface& VolumeSide::mutableSurface ( ) const

inline

Definition at line 29 of file VolumeSide.h.

References theSurface.

{return *theSurface;}

const Surface& VolumeSide::surface ( ) const

inline

Definition at line 31 of file VolumeSide.h.

References theSurface.

{return *theSurface;}

Side VolumeSide::surfaceSide ( ) const

inline

Definition at line 35 of file VolumeSide.h.

References theSurfaceSide.

{return theSurfaceSide;}

Member Data Documentation

GlobalFace VolumeSide::theGlobalFace

private

Definition at line 40 of file VolumeSide.h.

Referenced by globalFace().

SurfacePointer VolumeSide::theSurface

private

Definition at line 39 of file VolumeSide.h.

Referenced by mutableSurface(), and surface().

Side VolumeSide::theSurfaceSide

private

Definition at line 41 of file VolumeSide.h.

Referenced by surfaceSide().