All Classes Namespaces Files Functions Pages
TimingModifier.MultiBurst Class Reference

Methods

 BurstSize.Get
 Retrieves the number of frames in one burst. More...
 
 BurstSize.Set burstSize
 Sets the number of frames to send in one burst. More...
 
 Description.Get
 Returns a textual description of the object.
 
 InterBurstGap.Get
 Returns the time (ns) between the end of start of the next burst. More...
 
 InterBurstGap.Set interBurstGap
 Sets the time (ns) between the end of one burst and the start of the next burst. More...
 
 Parent.Get
 Returns the parent object.
 

Class overview

Definition at line 22981 of file api.tcl.

Method documentation

TimingModifier.MultiBurst::BurstSize.Get

Retrieves the number of frames in one burst.

Returns
Returns the number of frames in one burst
Example

retrieve the burstsize

1 $MultipleBurstModifier BurstSize.Get

Returns:

100 

Definition at line 22993 of file api.tcl.

TimingModifier.MultiBurst::BurstSize.Set   burstSize  

Sets the number of frames to send in one burst.

Parameters
burstSize
Example

Set the burstsize to 100

1 $MultipleBurstModifier BurstSize.Set 100

Definition at line 23005 of file api.tcl.

TimingModifier.MultiBurst::InterBurstGap.Get

Returns the time (ns) between the end of start of the next burst.

Example

Get the gap between 2 bursts

1 $MultipleBurstModifier InterBurstGap.Set 1000000

Returns:

1000000 

Definition at line 23020 of file api.tcl.

TimingModifier.MultiBurst::InterBurstGap.Set   interBurstGap  

Sets the time (ns) between the end of one burst and the start of the next burst.

Parameters
interBurstGapThe gap between 2 burst in ns
Example

Set the gap at 1ms

1 $MultipleBurstModifier InterBurstGap.Set 1000000

Set the gap at 10ms

1 $MultipleBurstModifier InterBurstGap.Set 10ms

Definition at line 23032 of file api.tcl.