Product Class Reference
Detailed Description
Get the product name, version, cut-id, change set used to build it, etc.
We have a company name (e.g. Autodesk), name (e.g., Showcase), model year (e.g., 2007), version (e.g., 2007.10), flavour (e.g., professional).
Some places we want to use "company name + name + model year". This is the "full name no flavour". Preference location is a good example where you may want to use this.
Some places we want to use "company name + name + flavour + model year". This is the "full name flavoured". Title bar is a good example where you may want to use this.
#include <Product.h>
Public Member Functions |
|
| awString::IString | getProductVersion () const |
| awString::IString | getFullName (bool flavour, bool revision) const |
| Full name is Name + Model Year + . |
|
| awString::IString | getFullNameFlavoured () const |
| awString::IString | getFullNameNoFlavour () const |
| awString::IString | getFullNameNoModelYearRevisionAndNoFlavour () const |
| awString::IString | getSimpleName () const |
| const awString::IString & | getCompanyName () const |
| const awString::IString & | getCutId () const |
| const awString::IString & | getChangeSet () const |
| awString::IString | getVersionString () const |
| This is ModelYear . MinorVersion. |
|
| void | setName (const awString::IString &) |
| const awString::IString & | getJustName () const |
| void | setFlavour (const awString::IString &) |
| const awString::IString & | getFlavour () const |
| void | setWantedFlavour (const awString::IString &) |
| const awString::IString & | getWantedFlavour () const |
| void | setModelYear (const awString::IString &) |
| const awString::IString & | getModelYear () const |
| void | setModelYearRevision (const awString::IString &) |
| void | appendToModelYearRevision (const awString::IString &) |
| const awString::IString & | getModelYearRevision () const |
| void | setInternalVersion (const awString::IString &) |
| const awString::IString & | getInternalVersion () const |
| void | setMinorVersion (const awString::IString &) |
| const awString::IString & | getMinorVersion () const |
| void | setPlatformInfo (const awString::IString &) |
| const awString::IString & | getPlatformInfo () const |
| void | setFullCopyright (const awString::IString &) |
| const awString::IString & | getFullCopyright () const |
| void | setSkipModelYear (bool skipYear) |
| bool | getSkipModelYear () const |
| const awString::IString & | getBrandingSuite () const |
| void | setBrandingSuite (const awString::IString &) |
| const awString::IString & | getBrandingResourceFile () const |
| The location that contains the extra
branding resources. |
|
| void | setBrandingResourceFile (const awString::IString &) |
| int | getBrandingIndexProductName () const |
| Some of the resources that we may need to
access. |
|
| void | setBrandingIndexProductName (int) |
| int | getBrandingIndexProductRevision () const |
| void | setBrandingIndexProductRevision (int) |
| int | getBrandingIndexSplashImage () const |
| void | setBrandingIndexSplashImage (int) |
| int | getBrandingIndexAboutImage () const |
| void | setBrandingIndexAboutImage (int) |
| int | getBrandingIndexProductSuite () const |
| void | setBrandingIndexProductSuite (int) |
Static Public Member Functions |
|
| static Product & | instance () |
| static void | destruct () |
| static int | forceCrash (int) |
Member Function Documentation
| static Product& instance | ( | ) | [static] |
| static void destruct | ( | ) | [static] |
| static int forceCrash | ( | int | ) | [static] |
| awString::IString getProductVersion | ( | ) | const |
| awString::IString getFullName | ( | bool | flavour, |
| bool | revision | ||
| ) | const |
Full name is Name + Model Year + .
Full flavoured name is Name + Flavour + Model Year.
| awString::IString getFullNameFlavoured | ( | ) | const |
| awString::IString getFullNameNoFlavour | ( | ) | const |
| awString::IString getFullNameNoModelYearRevisionAndNoFlavour | ( | ) | const |
| awString::IString getSimpleName | ( | ) | const |
| const awString::IString& getCompanyName | ( | ) | const |
| const awString::IString& getCutId | ( | ) | const |
| const awString::IString& getChangeSet | ( | ) | const |
| awString::IString getVersionString | ( | ) | const |
This is ModelYear . MinorVersion.
| void setName | ( | const awString::IString & | ) |
| const awString::IString& getJustName | ( | ) | const |
| void setFlavour | ( | const awString::IString & | ) |
| const awString::IString& getFlavour | ( | ) | const |
| void setWantedFlavour | ( | const awString::IString & | ) |
| const awString::IString& getWantedFlavour | ( | ) | const |
| void setModelYear | ( | const awString::IString & | ) |
| const awString::IString& getModelYear | ( | ) | const |
| void setModelYearRevision | ( | const awString::IString & | ) |
| void appendToModelYearRevision | ( | const awString::IString & | ) |
| const awString::IString& getModelYearRevision | ( | ) | const |
| void setInternalVersion | ( | const awString::IString & | ) |
| const awString::IString& getInternalVersion | ( | ) | const |
| void setMinorVersion | ( | const awString::IString & | ) |
| const awString::IString& getMinorVersion | ( | ) | const |
| void setPlatformInfo | ( | const awString::IString & | ) |
| const awString::IString& getPlatformInfo | ( | ) | const |
| void setFullCopyright | ( | const awString::IString & | ) |
| const awString::IString& getFullCopyright | ( | ) | const |
| void setSkipModelYear | ( | bool | skipYear | ) |
| bool getSkipModelYear | ( | ) | const |
| const awString::IString& getBrandingSuite | ( | ) | const |
| void setBrandingSuite | ( | const awString::IString & | ) |
| const awString::IString& getBrandingResourceFile | ( | ) | const |
The location that contains the extra branding resources.
On Windows, this is the path to the DLL, but, otherwise, there is nothing in this class that makes it implementation dependent. This isn't quite what OSX uses, but we will start with this.
| void setBrandingResourceFile | ( | const awString::IString & | ) |
| int getBrandingIndexProductName | ( | ) | const |
Some of the resources that we may need to access.
| void setBrandingIndexProductName | ( | int | ) |
| int getBrandingIndexProductRevision | ( | ) | const |
| void setBrandingIndexProductRevision | ( | int | ) |
| int getBrandingIndexSplashImage | ( | ) | const |
| void setBrandingIndexSplashImage | ( | int | ) |
| int getBrandingIndexAboutImage | ( | ) | const |
| void setBrandingIndexAboutImage | ( | int | ) |
| int getBrandingIndexProductSuite | ( | ) | const |
| void setBrandingIndexProductSuite | ( | int | ) |
