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

Collection of wrenches 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 wrenches stored in a list.

Collection of wrenchs stored in a list.

Member Function Documentation

def btk.btkWrenchCollection.Begin (   self )
Begin(self) -> btkWrenchIterator

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

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

Deep copy of the object
def btk.btkWrenchCollection.End (   self )
End(self) -> btkWrenchIterator

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

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

Returns the wrench for the given index.
def btk.btkWrenchCollection.GetItemNumber (   self )
GetItemNumber(self) -> int

Returns the number of wrenches
def btk.btkWrenchCollection.GetTimestamp (   self )
GetTimestamp(self) -> unsigned long

Returns the timestamp of the object.
def btk.btkWrenchCollection.InsertItem (   self,   args  )
InsertItem(self, btkWrenchIterator, btkWrench) -> bool
InsertItem(self, int, btkWrench) -> bool
InsertItem(self, btkWrench) -> bool

Inserts a wrench in the list.
def btk.btkWrenchCollection.IsEmpty (   self )
IsEmpty(self) -> bool

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

Removes a wrench.
def btk.btkWrenchCollection.SetItem (   self,   args  )
SetItem(self, int) -> btkWrench

Sets a wrench.
def btk.btkWrenchCollection.SetItemNumber (   self,   args  )
SetItemNumber(self, arg2)

Sets the number of wrenches
def btk.btkWrenchCollection.TakeItem (   self,   args  )
TakeItem(self, btkWrenchIterator) -> btkWrench
TakeItem(self, int) -> btkWrench

Removes a wrench and return it.
def btk.btkWrenchCollection.Update (   self )
Update(self)

Updates the ProcessObject associated with this DataObject.