cee::imp::cae::ReaderSettings Class Reference

Settings manager for the different CAE file formats supported by ImportCae. More...

Public Member Functions

 ReaderSettings ()
 Constructs the reader settings object. More...
 
const ReaderSettingsMarcmarc () const
 Returns Marc reader settings. More...
 
ReaderSettingsMarcmarc ()
 Returns Marc reader settings. More...
 
const ReaderSettingsPtcptc () const
 Returns PTC reader settings. More...
 
ReaderSettingsPtcptc ()
 Returns PTC reader settings. More...
 
const ReaderSettingsOpenFoamopenFoam () const
 Returns OpenFoam settings. More...
 
ReaderSettingsOpenFoamopenFoam ()
 Returns OpenFoam settings. More...
 
size_t dataProviderSettingsCount () const
 Returns the number of data provider settings that are available. More...
 
const ReaderSettingsDataProviderdataProviderSettings (size_t index) const
 Returns DataProvider reader settings for the data provider with the given index. More...
 
ReaderSettingsDataProviderdataProviderSettings (size_t index)
 Returns DataProvider reader settings for the data provider with the given index. More...
 
void addDataProviderSettings (const cee::imp::cae::ReaderSettingsDataProvider &cdpSettings)
 Add reader settings for a data provider. More...
 
void setEnsuresUniqueResultNames (bool ensure)
 Sets to true to ensures that all result names are unique. More...
 
bool ensuresUniqueResultNames () const
 Returns true if all result names are set to be unique. More...
 
void setUsesUndefinedResults (bool use)
 Sets to true if undefined results should be used. More...
 
bool usesUndefinedResults () const
 Returns true if undefined results are used. More...
 
bool isGlobalCoordinateTransformationEnabled () const
 Returns true if results are transformed to the global coordinate system. More...
 
void enableGlobalCoordinateTransformation (bool enable)
 Enable/disable transformation of results to the global coordinate system. More...
 
void excludeElementCategory (cee::ug::Element::Category category)
 Sets given element category to be excluded. More...
 
void clearExcludedElementCategories ()
 Clears existing excluded element categories. More...
 
const std::vector< cee::ug::Element::Category > & excludedElementCategories () const
 Returns all existing excluded element categories. More...
 
int getCategoryBottomSectionId (int categoryId) const
 Return the sectionId chosen for Bottom in the correspondng category. Returns -1 if categoryID not found. More...
 
int getCategoryTopSectionId (int categoryId) const
 Return the sectionId chosen for Top in the correspondng category. Returns -1 if categoryID not found. More...
 
std::vector< int > getSectionCategoryIds () const
 Returns all category ids the user has specified to change the default behavior of sections. More...
 
void setTopAndBottomSectionIdForCategory (int categoryId, int sectionIdTop, int sectionIdBottom)
 Set per categoryId the two sections to be used as Bottom and Top result. More...
 

Detailed Description

Settings manager for the different CAE file formats supported by ImportCae.

Constructor & Destructor Documentation

cee::imp::cae::ReaderSettings::ReaderSettings ( )

Constructs the reader settings object.

Member Function Documentation

void cee::imp::cae::ReaderSettings::addDataProviderSettings ( const cee::imp::cae::ReaderSettingsDataProvider cdpSettings)

Add reader settings for a data provider.

void cee::imp::cae::ReaderSettings::clearExcludedElementCategories ( )

Clears existing excluded element categories.

const ReaderSettingsDataProvider & cee::imp::cae::ReaderSettings::dataProviderSettings ( size_t  index) const

Returns DataProvider reader settings for the data provider with the given index.

ReaderSettingsDataProvider & cee::imp::cae::ReaderSettings::dataProviderSettings ( size_t  index)

Returns DataProvider reader settings for the data provider with the given index.

size_t cee::imp::cae::ReaderSettings::dataProviderSettingsCount ( ) const

Returns the number of data provider settings that are available.

void cee::imp::cae::ReaderSettings::enableGlobalCoordinateTransformation ( bool  enable)

Enable/disable transformation of results to the global coordinate system.

bool cee::imp::cae::ReaderSettings::ensuresUniqueResultNames ( ) const

Returns true if all result names are set to be unique.

const std::vector< cee::ug::Element::Category > & cee::imp::cae::ReaderSettings::excludedElementCategories ( ) const

Returns all existing excluded element categories.

void cee::imp::cae::ReaderSettings::excludeElementCategory ( cee::ug::Element::Category  category)

Sets given element category to be excluded.

int cee::imp::cae::ReaderSettings::getCategoryBottomSectionId ( int  categoryId) const

Return the sectionId chosen for Bottom in the correspondng category. Returns -1 if categoryID not found.

int cee::imp::cae::ReaderSettings::getCategoryTopSectionId ( int  categoryId) const

Return the sectionId chosen for Top in the correspondng category. Returns -1 if categoryID not found.

std::vector< int > cee::imp::cae::ReaderSettings::getSectionCategoryIds ( ) const

Returns all category ids the user has specified to change the default behavior of sections.

bool cee::imp::cae::ReaderSettings::isGlobalCoordinateTransformationEnabled ( ) const

Returns true if results are transformed to the global coordinate system.

const ReaderSettingsMarc & cee::imp::cae::ReaderSettings::marc ( ) const

Returns Marc reader settings.

ReaderSettingsMarc & cee::imp::cae::ReaderSettings::marc ( )

Returns Marc reader settings.

const ReaderSettingsOpenFoam & cee::imp::cae::ReaderSettings::openFoam ( ) const

Returns OpenFoam settings.

ReaderSettingsOpenFoam & cee::imp::cae::ReaderSettings::openFoam ( )

Returns OpenFoam settings.

const ReaderSettingsPtc & cee::imp::cae::ReaderSettings::ptc ( ) const

Returns PTC reader settings.

ReaderSettingsPtc & cee::imp::cae::ReaderSettings::ptc ( )

Returns PTC reader settings.

void cee::imp::cae::ReaderSettings::setEnsuresUniqueResultNames ( bool  ensure)

Sets to true to ensures that all result names are unique.

void cee::imp::cae::ReaderSettings::setTopAndBottomSectionIdForCategory ( int  categoryId,
int  sectionIdTop,
int  sectionIdBottom 
)

Set per categoryId the two sections to be used as Bottom and Top result.

void cee::imp::cae::ReaderSettings::setUsesUndefinedResults ( bool  use)

Sets to true if undefined results should be used.

bool cee::imp::cae::ReaderSettings::usesUndefinedResults ( ) const

Returns true if undefined results are used.