Skip to content

Commit

Permalink
Finish comments
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastien_popoff committed Nov 13, 2016
1 parent 5bbc5a1 commit 091f4c3
Showing 1 changed file with 33 additions and 7 deletions.
40 changes: 33 additions & 7 deletions src/ALP4.py
Original file line number Diff line number Diff line change
Expand Up @@ -629,7 +629,7 @@ def ProjInquireEx(self, inquireType, SequenceId = None):
inquireType : ctypes c_ulong
Sepcifies the type of value to return.
SequenceId : ctyles c_long, optional
SequenceId : ctypes c_long, optional
Identified of the sequence. If not specified, set the last sequence allocated in the DMD board memory
RETURNS
Expand Down Expand Up @@ -702,8 +702,17 @@ def ProjControl(self, controlType, value):
by the AlpProjHalt function.
Usage: Control(self, controlType, value)
controlType: type of value to set
value: value to set.
PARAMETERS
----------
controlType : attribute flag (ctypes c_ulong)
Specify the paramter to set.
value : c_double
Value of the parameter to set.
SEE ALSO
--------
See AlpProjControl in the ALP API description for control types.
'''
Expand Down Expand Up @@ -740,10 +749,23 @@ def SeqControl(self,controlType,value, SequenceId = None):
It is allowed to change settings of sequences that are currently in use.
However the new settings become effective after restart using AlpProjStart or AlpProjStartCont.
Usage: Control(self, controlType, value, SequenceId = None)
Usage: SeqControl(self, controlType, value, SequenceId = None)
PARAMETERS
----------
inquireType: type of value to return:
controlType : attribute flag (ctypes c_ulong)
Specify the paramter to set.
value : ctypes c_double
Value of the parameter to set.
SequenceId : ctypes c_long, optional
Identified of the sequence. If not specified, set the last sequence allocated in the DMD board memory
SEE ALSO
--------
See AlpSeqControl in the ALP API description for control types.
'''
Expand All @@ -760,9 +782,13 @@ def FreeSeq(self, SequenceId = None):
Frees a previously allocated sequence. The ALP memory reserved for the specified sequence in the device DeviceId is released.
Usage: FreeSeq( SequenceId = None)
Usage: FreeSeq(SequenceId = None)
PARAMETERS
----------
SequenceId: Id of the sequence to free. If not specified, free the last uploaded sequence.
SequenceId : ctypes c_long, optional
Identified of the sequence. If not specified, free the last sequence allocated in the DMD board memory
'''

if ( SequenceId == None) and (self._lastDDRseq):
Expand Down

0 comments on commit 091f4c3

Please sign in to comment.