sparksee.TypeLoaderEvent Class Reference

Provides information about the progress of a TypeLoader instance. More...

List of all members.

Public Member Functions

def get_total_phases
 Gets the total number of phases.
def get_count
 Gets the current number of objects created.
def get_total_partition_steps
 Gets the total number of steps in the current partition.
def is_last
 Gets if this is the last event or not.
def get_partition
 Gets the current partition.
def get_type_id
 Gets the type identifier.
def get_total_partitions
 Gets the total number of partitions.
def get_phase
 Gets the current phase.


Detailed Description

Provides information about the progress of a TypeLoader instance.

Check out the 'Data import' section in the SPARKSEE User Manual for more details on this.

Author:
Sparsity Technologies http://www.sparsity-technologies.com

Member Function Documentation

def sparksee.TypeLoaderEvent.get_total_phases (   self  ) 

Gets the total number of phases.

Returns:
The total number of phases.

def sparksee.TypeLoaderEvent.get_count (   self  ) 

Gets the current number of objects created.

Returns:
The current number of objects created.

def sparksee.TypeLoaderEvent.get_total_partition_steps (   self  ) 

Gets the total number of steps in the current partition.

Returns:
The total number steps in the current partition.

def sparksee.TypeLoaderEvent.is_last (   self  ) 

Gets if this is the last event or not.

Returns:
TRUE if this is the last event, FALSE otherwise.

def sparksee.TypeLoaderEvent.get_partition (   self  ) 

Gets the current partition.

Returns:
The current partition.

def sparksee.TypeLoaderEvent.get_type_id (   self  ) 

Gets the type identifier.

Returns:
The type identifier.

def sparksee.TypeLoaderEvent.get_total_partitions (   self  ) 

Gets the total number of partitions.

Returns:
The total number of partitions.

def sparksee.TypeLoaderEvent.get_phase (   self  ) 

Gets the current phase.

Returns:
The current phase.


Generated on Fri Feb 7 13:22:13 2014 for SparkseePython by  doxygen 1.5.6