ModelInfo

Description

sealed class Tinman.Engine.Models.ModelInfo

This is a helper that generates human-readable pseudo code that describes a IModel hierarchy.

public constructor ModelInfo → (3)

stream ⁱⁿ : ITextStream ^own: [not-null]
The text output stream to use.
toConfig ^opt : bool = true: Include result of IConfigurable.ToConfig, where applicable?
toString ^opt : bool = true: Include result of object.ToString, where applicable?

Creates a new instance of ModelInfo.

public method Consume → (1)

Consumes the given model.

public static method For → (3)

model ⁱⁿ : IModel: [not-null]
The model for which to generate pseudo-code.
toConfig ^opt : bool = true: Include result of IConfigurable.ToConfig, where applicable?
toString ^opt : bool = true: Include result of object.ToString, where applicable?
returns → string: The human-readable pseudo-code.

Generates pseudo-code for the given model ⁱⁿ.

The generated code is human-readable and describes the all aspects of a model hierarchy, excluding the following data:

The model info code is supposed to be used during development, for quick inspection and verification.