Base Class
#include <rw/thread/RWProductInfo.h> // or #include <rw/thread/RWThreadsProductInfo.h>
RWProductInfo is the abstract base class for the RWThreadsProductInfo class used to retrieve and report information about a particular build or configuration of a product.
virtual ~RWProductInfo(void);
Virtual destructor. Clears the list of product dependencies.
int operator==(const RWProductInfo& second) const;
Required to allow the insertion of RWProductInfo derived objects into various containers. Returns TRUE if this and second are the same object.
virtual RWCString additionalInfo(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to report on additional product information such as compiler options, special releases (test, trace, evaluation), etc.
virtual RWCString buildTimeStamp(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to return a time stamp for the current library build.
RWCString configuration(void) const;
Returns a summary of information about the current build configuration of self. It does this by concatenating the results of calling the virtual members releaseType(), threadSafety(), additionalInfo(), and dependencies().
RWCString dependencies(void) const;
Traverses a list of RWProductInfo derived product objects signifying products upon which self depends. Returns a concatenation of the results of productInfo() calls to each object visited on the dependency list.
const RWProductInfo* dependency(size_t index) const;
Returns a product information object from the dependency list, selected by index.
virtual RWCString maintenanceVersion(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to return a string describing the maintenance version of the current product installation.
virtual RWCString majorVersion(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to return a string describing the major version number of the current product installation.
virtual RWCString minorVersion(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to return a string describing the minor version number of the current product installation.
size_t numberOfDependencies(void) const;
Returns the number of products upon which self depends.
virtual RWCString productCopyright(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to return self's copyright statement.
RWCString productInfo(void) const;
Returns a summary of product information regarding self. It does this by concatenating the results of calling the virtual members productVendorName(), productName(), productType(), productVersion(), productVariant(), and productVersionLabel().
virtual RWCstring productName(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to return self's product name.
virtual RWCString productType(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to return a description of self's product type. Some possible descriptions are "library" or "executable".
RWCString productVariant(void) const;
Returns a summary of information about the self particular to the current build environment. It does this by concatenating the results of calling the virtual members targetPlatform(), targetCompiler(), and configuration().
virtual RWCString productVendorName(void) const
Pure virtual function. This member is intended to be overridden by derived classes to return self's product vendor name.
RWCString productVersion(void) const;
Returns a concatenation of the results of calling the virtual functions majorVersion(), minorVersion(), maintenanceVersion().
virtual RWCString productVersionLabel(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to return self's version label. A version label is a moniker or code name representing the current product version.
virtual RWCString releaseType(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to return the release type of the current build. Examples of release type are: "debug" and "release".
RWCString targetCompiler(void) const;
Returns a summary of information describing the compiler which is the target of the current build. It does this by concatenating the results of calling the virtual members targetCompilerVendorName(), targetCompilerName, and targetCompilerVersion().
virtual RWCString targetCompilerName(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to return the name of the compiler used in the current build of self.
virtual RWCString targetCompilerVendorName(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to return the name of the vendor of the compiler used in the current build of self.
virtual RWCString targetCompilerVersion(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to return a string describing the version number of the compiler used in the current build of self.
RWCString targetPlatform(void) const;
Returns a summary of information describing the platform which is the target of the current build. It does this by concatenating the results of calling the virtual members targetOSVendorName(), targetOSName(), and targetOSVersion().
virtual RWCString targetOSName(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to return the name of the operating system which is the target of the current build of self.
virtual RWCString targetOSVendorName(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to return the name of the vendor of the operating system which is the target of the current build of self.
virtual RWCString targetOSVersion(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to return a string describing the version number of the operating system which is the target of the current build of self.
virtual RWCString threadSafety(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to return a string describing the level of thread safety provided by the current product. Possible results are: N/A, Unsafe, Safe(Level 1), MT-Safe (Level 2).
virtual RWCString variantDescriptor(void) const;
Pure virtual function. This member is intended to be overridden by derived classes to return a string describing variation features of the current build which are not covered by previous member functions.
RWProductInfo(void);
Empty default constructor.
void adoptDependency(RWProductInfo* usesInfo);
Adds a product object to the dependency list of self. This member is only available to derived classes.
©Copyright 2000, Rogue Wave Software, Inc.
Contact Rogue Wave about documentation or support issues.