generic_samples: getversionsample


Introduction

This sample shows how to obtain all version numbers of the initialized DCA classes and how to print them out.

You may extend the sample simply by initializing more DCA modules.

Then you will get more version information about these additional modules.

It also shows how to use the classes:

Syntax:

        getversionsample <dca-redist-folder> <ticket> <product>
See also:
Samples Main Documentation: Samples

Files

file  generic_samples/getversionsample/main.cpp
 

GetVersion DCA sample.


Defines

#define DCA_BINDIR   "bin/linux"
 DCA subdirectory of the DCA binaries.
#define DCA_INITDIR   "init"
 DCA subdirectory of the DCA initialization data.
#define DCA_LOGDIR   "./logs"
 Relative directory for logfile(s).

Functions

static void SetupInitData (const std::string &redist_folder, InitData &initData)
 Sets up the given initData by substituting the given redist_folder with DCA subdirectories.
static void SetupLicense (const std::string &ticket, const std::string &product, LicenseData &licenseData)
 Sets up the given licenseData by copying the given ticket and product strings.
static void PrintLicenseInfo (const License &aLicense)
 Prints out the information about the provided License.
static void PrintVersion (const VersionInfoResults &aVersionInfoResults)
 Prints out the version information gathered from current DcaInstance.
static void PrintToolHeader ()
 Prints out the name and the version of this sample.
static void PrintUsage (const char *name)
 Prints out the syntax of the sample.
int main (int argc, char *argv[])
 The main routine.

Variables

const std::string S_UsageString
 Usage string, displayed if a parameter is missing.

Function Documentation

static void SetupInitData ( const std::string &  redist_folder,
InitData initData 
) [static]

Sets up the given initData by substituting the given redist_folder with DCA subdirectories.

Parameters:
[in] redist_folder This is the folder where the DCA has been installed to (assuming trailing fileslash)
[out] initData The InitData structure to set up
Note:
Only DCA_BINDIR differs between Windows and Linux
The directory ./logs is used for the logfile(s)

Definition at line 88 of file generic_samples/getversionsample/main.cpp.

static void SetupLicense ( const std::string &  ticket,
const std::string &  product,
LicenseData licenseData 
) [static]

Sets up the given licenseData by copying the given ticket and product strings.

Parameters:
[in] ticket This is the ticket data as provided with your DCA license
[in] product This is the product shortcut e.g. DC oder MS etc
[out] licenseData The LicenseData structure to set up

Definition at line 102 of file generic_samples/getversionsample/main.cpp.

static void PrintLicenseInfo ( const License aLicense  )  [static]

Prints out the information about the provided License.

Parameters:
[in] aLicense The license for which information should be displayed.

Definition at line 114 of file generic_samples/getversionsample/main.cpp.

static void PrintVersion ( const VersionInfoResults aVersionInfoResults  )  [static]

Prints out the version information gathered from current DcaInstance.

Parameters:
[in] aVersionInfoResults The result of a DcaInstance::getVersionInfo() call

Definition at line 141 of file generic_samples/getversionsample/main.cpp.

static void PrintUsage ( const char *  name  )  [static]

Prints out the syntax of the sample.

Parameters:
[in] name The name of the executable

Definition at line 188 of file generic_samples/getversionsample/main.cpp.

int main ( int  argc,
char *  argv[] 
)

The main routine.

Parameters:
[in] argc The count of arguments provided
[in] argv An array of provided arguments
Returns:
5 on usage error, 10 on exception and internal error and 0 on success

Definition at line 201 of file generic_samples/getversionsample/main.cpp.


Variable Documentation

const std::string S_UsageString
Initial value:
        "<dca-redist-folder> <ticket> <product>\n"
        "  dca-redist-folder - the folder where the DCA is installed to\n"
        "  ticket - a valid ticket\n"
        "  product - the product associated with your ticket\n\n"

Usage string, displayed if a parameter is missing.

Definition at line 52 of file generic_samples/getversionsample/main.cpp.


Generated on 26 Sep 2016 for dca_interface by  doxygen 1.6.1