module xdc.runtime.TimestampStd

Implementation of ITimestampProvider using ANSI C clock()

C synopsis target-domain sourced in xdc/runtime/TimestampStd.xdc
 
TimestampStd_get32()  // module-wide

Return a 32-bit timestamp

C synopsis target-domain
Bits32 TimestampStd_get32();
 
RETURNS
Returns a 32-bit timestamp value. Use getFreq to convert this value into units of real time.
SEE
 
TimestampStd_get64()  // module-wide

Return a 64-bit timestamp

C synopsis target-domain
Void TimestampStd_get64(Types_Timestamp64 *result);
 
ARGUMENTS
result — pointer to 64-bit result
This parameter is a pointer to a structure representing a 64-bit wide timestamp value where the current timestamp is written.
If the underlying hardware does not support 64-bit resolution, the hi field of result is always set to 0; see xdc.runtime.Types.Timestamp64. So, it is possible for the lo field to wrap around without any change to the hi field. Use getFreq to convert this value into units of real time.
SEE
 
TimestampStd_getFreq()  // module-wide

Get the timestamp timer's frequency (in Hz)

C synopsis target-domain
Void TimestampStd_getFreq(Types_FreqHz *freq);
 
ARGUMENTS
freq — pointer to a 64-bit result
This parameter is a pointer to a structure representing a 64-bit wide frequency value where the timer's frequency (in Hz) is written; see xdc.runtime.Types.FreqHz. This function provides a way of converting timestamp values into units of real time.
SEE
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId TimestampStd_Module_id();
// Get this module's unique id
 
Bool TimestampStd_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle TimestampStd_Module_heap();
// The heap from which this module allocates memory
 
Bool TimestampStd_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 TimestampStd_Module_getMask();
// Returns the diagnostics mask for this module
 
Void TimestampStd_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
XDCscript usage meta-domain sourced in xdc/runtime/TimestampStd.xdc
var TimestampStd = xdc.useModule('xdc.runtime.TimestampStd');
module-wide config parameters
 
 
metaonly config TimestampStd.common$  // module-wide

Common module configuration parameters

XDCscript usage meta-domain
TimestampStd.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.
generated on Thu, 01 Mar 2012 16:58:41 GMT