CLASS ndr.time.clocktype¶
CLOCKTYPE - a class for specifying a clock type in the NDR framework
Superclasses¶
none
Properties¶
Property | Description |
---|---|
type | the ndr_clock type; in this class, acceptable values are 'UTC', 'exp_global_time', and 'no_time' |
Methods¶
Method | Description |
---|---|
clocktype | Creates a new ndr.time.clocktype object |
eq | are two ndr.time.clocktype objects equal? |
ndr_clocktype2char | produce the NDR_CLOCKTOP's type as a string |
ne | are two ndr.time.clocktype objects not equal? |
needsepoch | does this clocktype need an epoch for full description? |
setclocktype | Set the type of an ndr.time.clocktype |
Methods help¶
clocktype - Creates a new ndr.time.clocktype object
OBJ = ndr.time.clocktype(TYPE)
Creates a new ndr.time.clocktype object. TYPE can be
any of the following strings (with description):
TYPE string | Description
------------------------------------------------------------------------------
'utc' | Universal coordinated time (within 0.1ms)
'approx_utc' | Universal coordinated time (within 5 seconds)
'exp_global_time' | Experiment global time (within 0.1ms)
'approx_exp_global_time' | Experiment global time (within 5s)
'dev_global_time' | A device keeps its own global time (within 0.1ms)
| (that is, it knows its own clock across recording epochs)
'approx_dev_global_time' | A device keeps its own global time (within 5 s)
| (that is, it knows its own clock across recording epochs)
'dev_local_time' | A device keeps its own local time only within epochs
'no_time' | No timing information
'inherited' | The timing information is inherited from another device.
Documentation for ndr.time.clocktype/clocktype
doc ndr.time.clocktype
eq - are two ndr.time.clocktype objects equal?
B = EQ(NDS_CLOCK_OBJ_A, NDR_CLOCKTYPE_OBJ_B)
Compares two NDR_CLOCKTYPE_objects and returns 1 if they refer to the
same clock type.
ndr_clocktype2char - produce the NDR_CLOCKTOP's type as a string
STR = NDR_CLOCKTYPE2CHAR(NDR_CLOCKTYPE_OBJ)
Return a string STR equal to the ndr.time.clocktype object's type parameter.
ne - are two ndr.time.clocktype objects not equal?
B = EQ(NDS_CLOCK_OBJ_A, NDR_CLOCKTYPE_OBJ_B)
Compares two NDR_CLOCKTYPE_objects and returns 0 if they refer to the
same clock type.
needsepoch - does this clocktype need an epoch for full description?
B = NEEDSEPOCH(NDR_CLOCKTYPE_OBJ)
Does this ndr.time.clocktype object need an epoch in order to specify time?
Returns 1 for 'dev_local_time', 0 otherwise.
setclocktype - Set the type of an ndr.time.clocktype
NDR_CLOCKTYPE_OBJ = SETCLOCKTYPE(NDR_CLOCKTYPE_OBJ, TYPE)
Sets the TYPE property of an ndr.time.clocktype object NDR_CLOCKTYPE_OBJ.
Valid values for the TYPE string are as follows:
TYPE string | Description
------------------------------------------------------------------------------
'utc' | Universal coordinated time (within 0.1ms)
'approx_utc' | Universal coordinated time (within 5 seconds)
'exp_global_time' | Experiment global time (within 0.1ms)
'approx_exp_global_time' | Experiment global time (within 5s)
'dev_global_time' | A device keeps its own global time (within 0.1ms)
| (that is, it knows its own clock across recording epochs)
'approx_dev_global_time' | A device keeps its own global time (within 5 s)
| (that is, it knows its own clock across recording epochs)
'dev_local_time' | A device keeps its own local time only within epochs
'no_time' | No timing information
'inherited' | The timing information is inherited from another device.