module xdais_6_26_00_02.Version

Version for the xdais_6_26_00_02 package

XDCspec summary sourced in xdais_6_26_00_02/Version.xdc
module Version {  ...
    // inherits xdc.runtime.IModule
C synopsis target-domain
XDCscript usage meta-domain
var Version = xdc.useModule('xdais_6_26_00_02.Version');
module-wide constants & types
    const Version.PATCH// Patch level = 00;
module-wide config parameters
module-wide functions
 
XDCspec declarations sourced in xdais_6_26_00_02/Version.xdc
package xdais_6_26_00_02;
 
module Version inherits IVersion {
module-wide constants & types
    override const UInt16 MAJOR// Major version number = 6;
    override const UInt16 MINOR// Minor version number = 26;
    override const UInt16 PATCH// Patch level = 00;
    override const UInt16 WIDTH// Minimum width of print fields = 2;
module-wide config parameters
module-wide functions
}
 
const Version.MAJOR

Major version number

XDCscript usage meta-domain
const Version.MAJOR = 6;
C synopsis target-domain
#define Version_MAJOR (UInt16)6
 
DETAILS
This number should be changed when major changes in the package occur. Examples include adding new modules, adding substantial new features to the algorithm(s).
 
const Version.MINOR

Minor version number

XDCscript usage meta-domain
const Version.MINOR = 26;
C synopsis target-domain
#define Version_MINOR (UInt16)26
 
DETAILS
This number should be changed when minor changes in the package occur. Examples include minor changes to the existing APIs, adding minor features to the algorithms(s) including expanding the configuration options.
 
const Version.PATCH

Patch level

XDCscript usage meta-domain
const Version.PATCH = 00;
C synopsis target-domain
#define Version_PATCH (UInt16)00
 
DETAILS
This number should be changed when bug fixes or performance improvements are introduced. There should be no changes in the APIs in this case.
 
const Version.WIDTH

Minimum width of print fields

XDCscript usage meta-domain
const Version.WIDTH = 2;
C synopsis target-domain
#define Version_WIDTH (UInt16)2
 
DETAILS
When denoting version numbers using '.' to separate fields there is a danger of confusing version "6.1" and version "6.10"; because, in decimal notation 6.1 == 6.10. To avoid this confusion, it is common practice to adopt a fixed minimum field width that's when printing version dimensions (other than MAJOR); e.g., rather than printing "6.1", if WIDTH == 2 then the version would be displayed as "6.01".
 
metaonly config Version.common$  // module-wide

Common module configuration parameters

XDCscript usage meta-domain
Version.common$ = Types.Common$ undefined;
 
DETAILS
All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.
 
metaonly Version.getString( )  // module-wide

Returns a string representation of the version

XDCscript usage meta-domain
Version.getString( Any separator ) returns Any
 
DETAILS
This method return a string of the form:
      MAJOR<sep>MINOR<sep>PATCH
where MAJOR, MINOR, and PATCH are the values sepcified in this interface and <sep> is the (optional) argument to this method. If separator is not supplied (or is null), <sep> defaults to '.'.
 
module-wide built-ins

C synopsis target-domain
Types_ModuleId Version_Module_id( );
// Get this module's unique id
 
Bool Version_Module_startupDone( );
// Test if this module has completed startup
 
IHeap_Handle Version_Module_heap( );
// The heap from which this module allocates memory
 
Bool Version_Module_hasMask( );
// Test whether this module has a diagnostics mask
 
Bits16 Version_Module_getMask( );
// Returns the diagnostics mask for this module
 
Void Version_Module_setMask( Bits16 mask );
// Set the diagnostics mask for this module
generated on Sun, 29 Aug 2010 18:57:24 GMT