Click or drag to resize

cEcospaceASCBaseResultsWriter Class

Base Class for ASC Specific Writers that implement IEcospaceResultsWriter and cEcospaceBaseResultsWriter to write Ecospace output to ESRI ASCII files.
Inheritance Hierarchy
SystemObject
  EwECorecEcospaceBaseResultsWriter
    EwECorecEcospaceASCBaseResultsWriter
      More...

Namespace:  EwECore
Assembly:  EwECore (in EwECore.dll) Version: 6.6.15981.0 (6.6.15981.0)
Syntax
public abstract class cEcospaceASCBaseResultsWriter : cEcospaceBaseResultsWriter

The cEcospaceASCBaseResultsWriter type exposes the following members.

Constructors
  NameDescription
Protected methodcEcospaceASCBaseResultsWriter
Initializes a new instance of the cEcospaceASCBaseResultsWriter class
Top
Properties
  NameDescription
Public propertyDisplayName (Inherited from cEcospaceBaseResultsWriter.)
Protected propertyEcopathData (Inherited from cEcospaceBaseResultsWriter.)
Protected propertyEcospaceData (Inherited from cEcospaceBaseResultsWriter.)
Public propertyEnabled (Inherited from cEcospaceBaseResultsWriter.)
Public propertyFirstOutputTimeStep (Inherited from cEcospaceBaseResultsWriter.)
Public propertyOutputDirectory
Get the full path name of the current output directory.
(Inherited from cEcospaceBaseResultsWriter.)
Public propertyOutputPath (Inherited from cEcospaceBaseResultsWriter.)
Public propertySelectedGroups (Inherited from cEcospaceBaseResultsWriter.)
Top
Methods
  NameDescription
Protected methodCreateOutputDir
Create the time stamped ouput directory.
(Inherited from cEcospaceBaseResultsWriter.)
Public methodEndWrite (Overrides cEcospaceBaseResultsWriterEndWrite.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFileExtension (Overrides cEcospaceBaseResultsWriterFileExtension.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetFileName
Public methodGetFleetFileName
Convert the variable, fleet index, extention and model time step into a valid fleet-based file name.
(Inherited from cEcospaceBaseResultsWriter.)
Public methodGetGroupFileName
Convert the variable, group index, extention and model time step into a valid group-based file name.
(Inherited from cEcospaceBaseResultsWriter.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInit (Inherited from cEcospaceBaseResultsWriter.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodNMaps
Protected methodSaveASCFile
Write an entire ASCII file for a group, time step and variable.
Protected methodScaleValue
Recalculate / rescale a value before it is written to the output file.
(Inherited from cEcospaceBaseResultsWriter.)
Protected methodsetAllFleetsSelected (Inherited from cEcospaceBaseResultsWriter.)
Protected methodsetAllGroupsSelected (Inherited from cEcospaceBaseResultsWriter.)
Protected methodsetCatchSelected (Inherited from cEcospaceBaseResultsWriter.)
Public methodStartWrite (Overrides cEcospaceBaseResultsWriterStartWrite.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodWriteASCIIBody
Write ESRI ASCII body block.
Protected methodWriteASCIIHeader
Write ESRI ASCII header block.
Public methodWriteResults (Overrides cEcospaceBaseResultsWriterWriteResults(Object).)
Protected methodWriteRunInfo (Inherited from cEcospaceBaseResultsWriter.)
Top
Fields
  NameDescription
Protected fieldm_core
Zhe core.
(Inherited from cEcospaceBaseResultsWriter.)
Protected fieldm_FirstStep (Inherited from cEcospaceBaseResultsWriter.)
Protected fieldm_OutputPath
The complete path to the directory containing result files.
(Inherited from cEcospaceBaseResultsWriter.)
Protected fieldm_selGroups (Inherited from cEcospaceBaseResultsWriter.)
Protected fieldvars (Inherited from cEcospaceBaseResultsWriter.)
Top
Extension Methods
  NameDescription
Public Extension MethodValue
Extension method; extract a value from an object by property name.
(Defined by Extensions.)
Top
Remarks
Each ASCII file will contain an Ecospace value for a given group and time step
See Also
Inheritance Hierarchy