BTK Python wrapper  0.3dev.0
Python bindings for the Biomechanical ToolKit library (BTK)
Public Member Functions | List of all members
btk.btkEventCollection Class Reference

Collection of events stored in a list. More...

Public Member Functions

def Begin
 
def Clear
 
def Clone
 
def End
 
def GetIndexOf
 
def GetItem
 
def GetItemNumber
 
def GetTimestamp
 
def InsertItem
 
def IsEmpty
 
def RemoveItem
 
def SetItem
 
def SetItemNumber
 
def TakeItem
 
def Update
 

Detailed Description

Collection of events stored in a list.

Collection of events stored in a list.

Member Function Documentation

def btk.btkEventCollection.Begin (   self )
Begin(self) -> btkEventIterator

Returns an iterator to the beginning of the list of items.
def btk.btkEventCollection.Clear (   self )
Clear(self)

Clear the contents of the collection.
def btk.btkEventCollection.Clone (   self )
Clone(self) -> btkEventCollection

Deep copy of the object
def btk.btkEventCollection.End (   self )
End(self) -> btkEventIterator

Returns an iterator just past the last item.
def btk.btkEventCollection.GetIndexOf (   self,   args  )
GetIndexOf(self, int) -> btkEvent

Returns the index of the given item.
def btk.btkEventCollection.GetItem (   self,   args  )
GetItem(self, int) -> btkEvent

Returns the event for the given index.
def btk.btkEventCollection.GetItemNumber (   self )
GetItemNumber(self) -> int

Returns the number of events
def btk.btkEventCollection.GetTimestamp (   self )
GetTimestamp(self) -> unsigned long

Returns the timestamp of the object.
def btk.btkEventCollection.InsertItem (   self,   args  )
InsertItem(self, btkEventIterator, btkEvent) -> bool
InsertItem(self, int, btkEvent) -> bool
InsertItem(self, btkEvent) -> bool

Inserts an event in the list.
def btk.btkEventCollection.IsEmpty (   self )
IsEmpty(self) -> bool

Returns true if the collection is empty.
def btk.btkEventCollection.RemoveItem (   self,   args  )
RemoveItem(self, btkEventIterator) -> btkEventIterator
RemoveItem(self, int)

Removes an event.
def btk.btkEventCollection.SetItem (   self,   args  )
SetItem(self, int) -> btkEvent

Sets an event.
def btk.btkEventCollection.SetItemNumber (   self,   args  )
SetItemNumber(self, arg2)

Sets the number of events
def btk.btkEventCollection.TakeItem (   self,   args  )
TakeItem(self, btkEventIterator) -> btkEvent
TakeItem(self, int) -> btkEvent

Removes an event and return it.
def btk.btkEventCollection.Update (   self )
Update(self)

Updates the ProcessObject associated with this DataObject.