cee::ug::DataSourceMerged Class Reference

A data source for an unstructured grid model that enabled merging of additional data sources. More...

Public Member Functions

 DataSourceMerged (int dataSourceId)
 Constructs and initializes an empty merged data source. Specify a unique id. More...
 
 DataSourceMerged (int dataSourceId, cee::ug::DataSourceInterface *mainDataSource)
 Constructs and initializes a merged data source. More...
 
int nextDataSourceId () const
 Gets next unique id. More...
 
bool append (cee::ug::DataSourceInterface *dataSource)
 Appends this data source to the main data source (specified in constructor) More...
 
virtual bool open (const Str &filename, cee::ug::Error *error=NULL)
 Does nothing. Not supported by merged data source. More...
 
virtual void close ()
 Does nothing. Not supported by merged data source. More...
 
- Public Member Functions inherited from cee::ug::DataSourceInterface
 DataSourceInterface (int dataSourceId)
 Constructs an empty data source with the given id. More...
 
virtual bool loadState (int stateId, const DataStateSpec &stateSpec, Error *error)
 Loads the state at the given stateId. Only loads the state if not already present in the DataSource. More...
 
virtual void discardState (int stateId)
 Deletes the state with the given id from the data source. More...
 
virtual bool loadCustomResultBaseDependencies (int stateId, const DataStateSpec &stateSpec)
 Loads custom result bare dependencies. Returns true if success. More...
 
bool createResultCalculator (const Str &calculatorId, const Str &resultIdString, const Str &initString, Str *errorMessage)
 Creates a new result with the given 'resultIdString' by using the result calculator 'calculatorId' configured with the given 'initString'. More...
 
bool recreateResultCalculator (const Str &calculatorId, const Str &resultIdString, const Str &initString, Str *errorMessage)
 Recreates a result calculator with a modified initString. More...
 
bool deleteResultCalculator (const Str &calculatorId, const Str &resultIdString)
 Deletes the result calculator with the given calculatorId and resultIdString. More...
 
bool setResultCalculatorParams (const Str &calculatorId, const Str &resultIdString, const ResultCalculatorParams &calcParams)
 Sets the parameters for the given result calculator instance. More...
 
void getResultCalculatorParams (const Str &calculatorId, const Str &resultIdString, ResultCalculatorParams *calcParams) const
 Gets the current parameters exposed by the given result calculator instance. More...
 
Str primaryFilename () const
 Returns the primary filename for this data source. More...
 
Str description () const
 Returns the description for this data source. More...
 
virtual bool scalarRange (int stateId, int resultId, double *min, double *max)
 Gets the range of the given scalar result for the given state. More...
 
virtual bool vectorRange (int stateId, int resultId, double *min, double *max)
 Gets the range of the given vector result for the given state. More...
 
virtual bool displacementRange (int stateId, int resultId, double *min, double *max)
 Gets the range of the given displacement result for the given state. More...
 
- Public Member Functions inherited from cee::ug::DataSource
int id () const
 Returns the id of the data source. More...
 
size_t stateCount () const
 Returns number of states for the data source. More...
 
size_t stateIndex (int stateId) const
 Returns the index of the state with id stateId. More...
 
size_t geometryCountPerState () const
 Returns the number of geometries (per state) in the Datasource. More...
 
const DataStatestate (size_t stateIndex) const
 Returns the state at the given state index. More...
 
DataStatestate (size_t stateIndex)
 Returns the state at the given state index. More...
 
const DataStatecurrentState (const UnstructGridModel *model) const
 Returns the current state (the state in the current frame) in the given model. More...
 
DataStatecurrentState (const UnstructGridModel *model)
 Returns the current state (the state in the current frame) in the given model. More...
 
const DataSourceDirectorydirectory () const
 Returns the data directory of the data source. More...
 
DataSourceDirectorydirectory ()
 Returns the data directory of the data source. More...
 
const DataElementSetelementSet (size_t setIndex) const
 Returns a const ptr to the element set at the given index. More...
 
DataElementSetelementSet (size_t setIndex)
 Returns the element set at the given index. More...
 
size_t elementSetCount () const
 Returns the number of DataElementSets in this data source. More...
 
size_t elementSetIndex (int setId) const
 Returns the index of the element set with the given id. More...
 
void addElementSet (DataElementSet *elementSet)
 Adds an element set to this data source. More...
 
void removeElementSet (const DataElementSet *elementSet)
 Removes an element set from this data source. More...
 
void removeAllElementSets ()
 Removes all element sets from the data source. More...
 
bool isDataSourceValid (Str *failReason) const
 Validates that the data source contents matches the metadata. More...
 
int defaultDispacementResultId () const
 Returns the current state (the state in the current frame) in the given model. More...
 
bool computeCustomResults (int stateId, const DataStateSpec &stateSpec)
 Computes custom results. More...
 
- Public Member Functions inherited from cee::RefCountedObject
void addRef () const
 Increments the reference count for this object. More...
 
void release () const
 Decrements the reference count for this object. More...
 
int refCount () const
 Returns the reference count for this object. More...
 
void setRefCountZero () const
 Sets the ref count to zero, but DOES NOT delete the object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from cee::ug::DataSourceInterface
static bool supportsResultCalculatorPlugins ()
 Gets if result calculator plugins are supported or not. More...
 
static bool loadResultCalculatorPlugin (const Str &baseFileName)
 Loads the specified result calculator plugin. More...
 
- Protected Member Functions inherited from cee::ug::DataSourceInterface
void updateDirectoryFromDatabase ()
 Updates the directory with synthetic metadata from all states, parts and results in the geometries. More...
 
Inheritance diagram for cee::ug::DataSourceMerged:
cee::ug::DataSourceInterface cee::ug::DataSource cee::RefCountedObject

Detailed Description

A data source for an unstructured grid model that enabled merging of additional data sources.

The main data source (specified upon construction) imposes the geometries on the ones added later on.

Constructor & Destructor Documentation

cee::ug::DataSourceMerged::DataSourceMerged ( int  dataSourceId)

Constructs and initializes an empty merged data source. Specify a unique id.

cee::ug::DataSourceMerged::DataSourceMerged ( int  mergedDataSourceId,
cee::ug::DataSourceInterface mainDataSource 
)

Constructs and initializes a merged data source.

The given main data source imposes the geometries on the ones added later on.

Specify a unique id for the merged data source.

Member Function Documentation

bool cee::ug::DataSourceMerged::append ( cee::ug::DataSourceInterface dataSource)

Appends this data source to the main data source (specified in constructor)

void cee::ug::DataSourceMerged::close ( )
virtual

Does nothing. Not supported by merged data source.

Implements cee::ug::DataSourceInterface.

int cee::ug::DataSourceMerged::nextDataSourceId ( ) const

Gets next unique id.

bool cee::ug::DataSourceMerged::open ( const Str filename,
cee::ug::Error error = NULL 
)
virtual

Does nothing. Not supported by merged data source.

Implements cee::ug::DataSourceInterface.