ReadFileAsync Class

Base class for asynchronous file reading.
Public MustInherit Class ReadFileAsync 
Inherits WorkUnit
This language is not supported or no code example is available.
public abstract class ReadFileAsync : WorkUnit
This language is not supported or no code example is available.
Name Description
Protected constructor ReadFileAsync(Stream) Stream constructor.
Protected constructor ReadFileAsync(string) File name constructor.
Top
Name Description
Public property Entities Gets the entities resulting from file reading.
Public property ExecutionTime Gets the (last) work execution time in milliseconds. (inherited from WorkUnit).
Public property FileName Gets the file name.
Public property Log Gets the list of errors and warnings generated during file import.
Public property ParsingEntitiesText Gets or sets the "Parsing entities..." text string.
Public property ParsingText Gets or sets the "Parsing..." text string.
Public property Path Gets input file path.
Public property ReadingText Gets or sets the "Reading..." text string.
Public property Result Gets the result of reading operation (true if the operation succeeded).
Public property Stream Gets current stream.
Public property SupportedLinearUnitsType Gets the supported linear units.
Top
Methods
 
Name Description
Public method AddToScene(Environment, int) Obsolete. Adds the entities loaded from the file to the scene.
Public method AddToScene(Environment, int, Color) Obsolete. Adds the entities loaded from the file to the scene.
Public method AddToScene(Environment, Color) Adds the entities loaded from the file to the scene.
Public method AddToScene(Environment, RegenOptions, bool, string) Adds the entities loaded from the file to the scene.
Public method AddToScene(Environment, string) Adds the entities loaded from the file to the scene.
Public method AddToScene(Environment, string, Color) Adds the entities loaded from the file to the scene.
Public method AddToSceneAsSingleObject(Environment, string, int) Obsolete. Adds to scene putting the entities inside a Block and creating a BlockReference referring to it.
Public method AddToSceneAsSingleObject(Environment, string, int, Color) Obsolete. Adds to scene putting the entities inside a Block and creating a BlockReference referring to it.
Public method AddToSceneAsSingleObject(Environment, string, Color) Adds to scene putting the entities inside a Block and creating a BlockReference referring to it.
Public method AddToSceneAsSingleObject(Environment, string, string) Adds to scene putting the entities inside a Block and creating a BlockReference referring to it.
Public method AddToSceneAsSingleObject(Environment, string, string, Color) Adds to scene putting the entities inside a Block and creating a BlockReference referring to it.
Internal protected (Protected Friend) method Cancelled(BackgroundWorker, DoWorkEventArgs) Checks if the user has requested cancellation of the background operation. (inherited from WorkUnit).
Internal protected (Protected Friend) method CloseStream() Closes the stream. Must be called by all derived classes.
Internal protected (Protected Friend) method DoWork(BackgroundWorker, DoWorkEventArgs) Does the actual work allowing progress bar update and cancellation.
Public method DoWork() Executes the work synchronously. (inherited from WorkUnit).
Public method Equals(Object) Determines whether the specified object is equal to the current object. (inherited from Object).
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (inherited from Object).
Public method GetHashCode Serves as the default hash function. (inherited from Object).
Public method GetType Gets the Type of the current instance. (inherited from Object).
Protected method MemberwiseClone Creates a shallow copy of the current Object. (inherited from Object).
Internal protected (Protected Friend) method ResetProgressParallel() Resets the progress bar for a parallel loop. (inherited from WorkUnit).
Public method RotateEverythingAroundX(double) Rotates geometry around world X axis. If the file was created in a system that orients with Y Axis Up, the models would by default be brought into Eyeshot (a Z axis up system) with a flipped coordinate system. This method is designed to fix the problem.
Internal protected (Protected Friend) method StartContinuousAnimation(string, BackgroundWorker) Start the animation for the continuous progress bar. (inherited from WorkUnit).
Internal protected (Protected Friend) method StopContinuousAnimation(BackgroundWorker) Stop the animation for the continuous progress bar. (inherited from WorkUnit).
Public method ToString Returns a string that represents the current object. (inherited from Object).
Internal protected (Protected Friend) method UpdateProgress(double, double, string, BackgroundWorker, bool) Updates the progress bar value.
Internal protected (Protected Friend) method UpdateProgress(int, int, string, BackgroundWorker, bool) Updates the progress bar value.
Internal protected (Protected Friend) method UpdateProgressAndCheckCancelled(int, int, string, BackgroundWorker, DoWorkEventArgs, bool) Updates the progress bar value and checks if the worker thread has been canceled. (inherited from WorkUnit).
Internal protected (Protected Friend) method UpdateProgressAndCheckCancelledParallel(int, string, BackgroundWorker, DoWorkEventArgs) Updates the progress bar value and checks if the worker thread has been canceled, for a parallel loop. (inherited from WorkUnit).
Internal protected (Protected Friend) method UpdateProgressParallel(double, string, BackgroundWorker) Updates the progress bar value for a parallel loop. (inherited from WorkUnit).
Internal protected (Protected Friend) method UpdateProgressTo100(string, BackgroundWorker) Set the progress bar to 100% and forces screen update. (inherited from WorkUnit).
Internal protected (Protected Friend) method WorkCancelled(Environment) Called when the work is cancelled.
Internal protected (Protected Friend) method WorkCompleted(Environment) Called when the work has completed. In the case you are modeling something, the environment parameter allows you to easily add the model to the entities collection. (inherited from WorkUnit).
Internal protected (Protected Friend) method WorkFailed(Environment) Called when the work has failed. (inherited from WorkUnit).
Top
Events
 
Name Description
Public event ProgressChanged Occurs when the DoWork() is called synchronously and the progress has changed. (inherited from WorkUnit).
Top

.NET Framework

Supported in: 4.5, 4.6, 4.7

In this article

Definition