CDPDataProviderInfo
Functions
~CDPDataProviderInfo |
|
void | setFileDescription |
void | setFileMask |
void | setHasDefaultColors |
void | publishInitOptionBool |
void | publishInitOptionDouble |
void | publishInitOptionString |
Detailed Description
-
class
CDPDataProviderInfo
This class contains information about the data provider.
Public Functions
-
inline virtual
~CDPDataProviderInfo
()
-
virtual void
setFileDescription
(const CDPString &description) = 0 Specifies the description of the files/content the provider supports.
Example: “ANSYS Binary Result File”
-
virtual void
setFileMask
(const CDPString &mask) = 0 Specifies (if applicable) the file mask of the files supported by this provider.
Example: *.rst;*.rth;*.rfl”
-
virtual void
setHasDefaultColors
(bool hasDefaultColors) = 0 Specifies if the provider will specify default colors or not.
This needs to be set to true if the provider will specify default colors for the model using the CDPElementGroupInfo::setPartColor() or CDPGeometryInfo::addElementGroupInfoWithColor() methods.
Default is false (no colors specified)
-
virtual void
publishInitOptionBool
(const CDPString &optionKey, const CDPString &optionDescription, bool defaultValue) = 0 Publishes information about a boolean initialization option for the data provider.
These settings will be available for the host program as ReaderSettings, and user defined values will be provided in the CDPInitOptions passed to init() in the DataProvider.
-
virtual void
publishInitOptionDouble
(const CDPString &optionKey, const CDPString &optionDescription, cdp_double_t defaultValue) = 0 Publishes information about a double initialization option for the data provider.
These settings will be available for the host program as ReaderSettings, and user defined values will be provided in the CDPInitOptions passed to init() in the DataProvider.
-
virtual void
publishInitOptionString
(const CDPString &optionKey, const CDPString &optionDescription, const CDPString &defaultValue) = 0 Publishes information about a string initialization option for the data provider.
These settings will be available for the host program as ReaderSettings, and user defined values will be provided in the CDPInitOptions passed to init() in the DataProvider.
-
inline virtual