TypeLoaderEvent Class Reference
[Io]

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

List of all members.

Public Member Functions

virtual ~TypeLoaderEvent ()
 Destructor.
sparksee::gdb::type_t GetTypeId () const
 Gets the type identifier.
sparksee::gdb::int64_t GetCount () const
 Gets the current number of objects created.
sparksee::gdb::int32_t GetPhase () const
 Gets the current phase.
sparksee::gdb::int32_t GetTotalPhases () const
 Gets the total number of phases.
sparksee::gdb::int32_t GetPartition () const
 Gets the current partition.
sparksee::gdb::int32_t GetTotalPartitions () const
 Gets the total number of partitions.
sparksee::gdb::int32_t GetTotalPartitionSteps () const
 Gets the total number of steps in the current partition.
sparksee::gdb::bool_t IsLast () const
 Gets if this is the last event or not.

Friends

class TypeLoader


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

sparksee::gdb::type_t TypeLoaderEvent::GetTypeId (  )  const [inline]

Gets the type identifier.

Returns:
The type identifier.

sparksee::gdb::int64_t TypeLoaderEvent::GetCount (  )  const [inline]

Gets the current number of objects created.

Returns:
The current number of objects created.

sparksee::gdb::int32_t TypeLoaderEvent::GetPhase (  )  const [inline]

Gets the current phase.

Returns:
The current phase.

sparksee::gdb::int32_t TypeLoaderEvent::GetTotalPhases (  )  const [inline]

Gets the total number of phases.

Returns:
The total number of phases.

sparksee::gdb::int32_t TypeLoaderEvent::GetPartition (  )  const [inline]

Gets the current partition.

Returns:
The current partition.

sparksee::gdb::int32_t TypeLoaderEvent::GetTotalPartitions (  )  const [inline]

Gets the total number of partitions.

Returns:
The total number of partitions.

sparksee::gdb::int32_t TypeLoaderEvent::GetTotalPartitionSteps (  )  const [inline]

Gets the total number of steps in the current partition.

Returns:
The total number steps in the current partition.

sparksee::gdb::bool_t TypeLoaderEvent::IsLast (  )  const [inline]

Gets if this is the last event or not.

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


The documentation for this class was generated from the following file:

Generated on Fri Feb 7 13:10:12 2014 for Sparksee by  doxygen 1.5.6