escript::DataReady Class Reference

#include <DataReady.h>

Inheritance diagram for escript::DataReady:

escript::DataAbstract escript::DataConstant escript::DataEmpty escript::DataExpanded escript::DataTagged

List of all members.

Public Member Functions

 DataReady (const FunctionSpace &what, const ShapeType &shape, bool isDataEmpty=false)
 ~DataReady ()
double * getSampleDataRW (ValueType::size_type sampleNo)
 Return the sample data for the given sample number.
const double * getSampleDataRO (ValueType::size_type sampleNo) const
size_t getSampleBufferSize () const
virtual DataTypes::ValueTypegetVectorRW ()=0
 Provide access to underlying storage. Internal use only!
virtual const
DataTypes::ValueType
getVectorRO () const =0
virtual void setSlice (const DataAbstract *value, const DataTypes::RegionType &region)=0
 Copy the specified region from the given object.
DataTypes::ValueType::const_reference getDataAtOffsetRO (DataTypes::ValueType::size_type i) const
 get a reference to the beginning of a data point
DataTypes::ValueType::reference getDataAtOffsetRW (DataTypes::ValueType::size_type i)
DataReady_ptr resolve ()
 Return a data object with all points resolved.

Private Types

typedef DataAbstract parent


Detailed Description

Base class for Data which do not need to be resolved. Internally this means they have getVectorRO and getVectorRW methods.

Member Typedef Documentation


Constructor & Destructor Documentation

escript::DataReady::DataReady ( const FunctionSpace what,
const ShapeType shape,
bool  isDataEmpty = false 
)

escript::DataReady::~DataReady (  )  [inline]


Member Function Documentation

DataAbstract::ValueType::value_type * escript::DataReady::getSampleDataRW ( ValueType::size_type  sampleNo  )  [inline]

Return the sample data for the given sample number.

References escript::DataAbstract::getPointOffset(), and getVectorRW().

Referenced by escript::Data::getSampleDataRW().

const double * escript::DataReady::getSampleDataRO ( ValueType::size_type  sampleNo  )  const [inline]

size_t escript::DataReady::getSampleBufferSize (  )  const [inline, virtual]

This function is required primarily for LazyData. For ReadyData it returns 1. (Behaviour subject to change).

Implements escript::DataAbstract.

virtual DataTypes::ValueType& escript::DataReady::getVectorRW (  )  [pure virtual]

Provide access to underlying storage. Internal use only!

Implemented in escript::DataConstant, escript::DataEmpty, escript::DataExpanded, and escript::DataTagged.

Referenced by escript::Data::copyWithMask(), getDataAtOffsetRW(), and getSampleDataRW().

virtual const DataTypes::ValueType& escript::DataReady::getVectorRO (  )  const [pure virtual]

virtual void escript::DataReady::setSlice ( const DataAbstract value,
const DataTypes::RegionType region 
) [pure virtual]

Copy the specified region from the given object.

Parameters:
value - Input - Data to copy from
region - Input - Region to copy.

Implemented in escript::DataConstant, escript::DataEmpty, escript::DataExpanded, and escript::DataTagged.

Referenced by escript::Data::setSlice().

DataTypes::ValueType::const_reference escript::DataReady::getDataAtOffsetRO ( DataTypes::ValueType::size_type  i  )  const [inline]

get a reference to the beginning of a data point

References getVectorRO().

Referenced by escript::Data::getDataAtOffsetRO(), and escript::Data::getDataPointRO().

DataTypes::ValueType::reference escript::DataReady::getDataAtOffsetRW ( DataTypes::ValueType::size_type  i  )  [inline]

DataReady_ptr escript::DataReady::resolve (  )  [virtual]

Return a data object with all points resolved.

Implements escript::DataAbstract.

References escript::DataAbstract::getPtr().


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

Generated on Mon Aug 10 10:04:45 2009 for ESYS13 by  doxygen 1.5.6