interface xdc.runtime.ITimestampClient |
|
|
|
Timestamp Client Interface
This interface defines the methods used by client applications to
get timestamp values. It is implemented by the
Timestamp module.
interface ITimestampClient { ...
interface ITimestampClient {
module-wide config parameters
module-wide functions
}
metaonly config ITimestampClient.common$ // module-wide |
|
Common module configuration parameters
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.
ITimestampClient.get32( ) // module-wide |
|
Return a 32-bit timestamp
RETURNS
Returns a 32-bit timestamp value.
Use
getFreq to convert this value into units of real time.
SEE
ITimestampClient.get64( ) // module-wide |
|
Return a 64-bit timestamp
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
ITimestampClient.getFreq( ) // module-wide |
|
Get the timestamp timer's frequency (in Hz)
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
generated on Wed, 06 Jan 2010 18:40:41 GMT