Ceetron Data Provider Framework
Public Member Functions | List of all members
CDPDataProviderInfo Class Referenceabstract

Public Member Functions

virtual void setFileDescription (const CDPString &description)=0
 
virtual void setFileMask (const CDPString &mask)=0
 
virtual void publishInitOptionBool (const CDPString &optionKey, const CDPString &optionDescription, bool defaultValue)=0
 
virtual void publishInitOptionDouble (const CDPString &optionKey, const CDPString &optionDescription, cdp_double_t defaultValue)=0
 
virtual void publishInitOptionString (const CDPString &optionKey, const CDPString &optionDescription, const CDPString &defaultValue)=0
 

Detailed Description

This class contains information about the data provider

Member Function Documentation

void CDPDataProviderInfo::publishInitOptionBool ( const CDPString optionKey,
const CDPString optionDescription,
bool  defaultValue 
)
pure virtual

Publish 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.

void CDPDataProviderInfo::publishInitOptionDouble ( const CDPString optionKey,
const CDPString optionDescription,
cdp_double_t  defaultValue 
)
pure virtual

Publish 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.

void CDPDataProviderInfo::publishInitOptionString ( const CDPString optionKey,
const CDPString optionDescription,
const CDPString defaultValue 
)
pure virtual

Publish 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.

void CDPDataProviderInfo::setFileDescription ( const CDPString description)
pure virtual

Specify the desciption of the files/content the provider supports.

Example: "ANSYS Binary Result File"

void CDPDataProviderInfo::setFileMask ( const CDPString mask)
pure virtual

Specify (if applicable) the file mask of the files supported by this provider

Example: *.rst;*.rth;*.rfl"


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