TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

class ConfigException in Tinman.Core.Config

sealed class ConfigException extends TinmanException

Public / Attributes

ErrorInfo

The TinmanError object that describes the error that has occurred.

public property ErrorInfo { get }
type TinmanError
value [not-null] The TinmanError object.
inherited TinmanException.ErrorInfo

Message

Returns the human-readable exception message.

[Pure]
public override sealed property Message { get }
type string
value [not-null] The localized exception message.
inherited TinmanException.Message

Source

The error source (see ErrorSource).

public property Source { get }
type string
value The error source tag.
inherited TinmanException.Source

Public / Constants

ErrorMustBeClassType

The given config type is not a class type (see ClassType).

public static readonly field ErrorMustBeClassType
type Label

Public / Constructors

CannotBuildType

An error has occurred while building a new config type.

public static method CannotBuildType (string source, string typeName, string message)
type ConfigException
params source Error source tag.
  typeName Full name of the config type being built.
  message The error message.
returns [not-null] The ready-to-throw exception.

CannotImplement

An external implementation cannot be provided for a script function, because it is already implemented in script code.

public static method CannotImplement (string source, string name)
type ConfigException
params source Error source tag.
  name The function name.
returns [not-null] The ready-to-throw exception.

CannotInstantiateAbstractClass

Abstract classes cannot be instantiated (New).

public static method CannotInstantiateAbstractClass (string source, ClassType type)
type ConfigException
params source Error source tag.
  type The abstract class type.
returns [not-null] The ready-to-throw exception.

CannotResolveName

An identifier cannot be resolved.

public static method CannotResolveName (string source, string name)
type ConfigException
params source Error source tag.
  name The identifier.
returns [not-null] The ready-to-throw exception.

ExternalFunctionError

An unexpected error has occurred while calling an external function.

public static method ExternalFunctionError (string source, string functionName, TinmanError error)
type ConfigException
params source Error source tag.
  functionName Full name of the external config function.
  error The error that has occurred.
returns [not-null] The ready-to-throw exception.

InfiniteLoop

A config expression causes an infinite loop when being evaluated.

public static method InfiniteLoop (string source, ConfigExpression expr)
type ConfigException
params source Error source tag.
  expr The config expression.
returns [not-null] The ready-to-throw exception.

InvalidCall

A function call is invalid.

public static method InvalidCall (string source, ConfigMember function, string message)
type ConfigException
params source Error source tag.
  function The function name.
  message Additional error message.
returns [not-null] The ready-to-throw exception.

MissingConfigurator

The config type must have a configurator object.

public static method MissingConfigurator (string source, ConfigType type)
type ConfigException
params source Error source tag.
  type The config type.
returns [not-null] The ready-to-throw exception.

MustBeArrayType

The config type must be an array type.

public static method MustBeArrayType (string source, ConfigType type)
type ConfigException
params source Error source tag.
  type The config type.
returns [not-null] The ready-to-throw exception.

MustBeClassType

The config type must be a class.

public static method MustBeClassType (string source, ConfigType type)
type ConfigException
params source Error source tag.
  type The config type.
returns [not-null] The ready-to-throw exception.

MustBeEnumType

The config type must be an enum type.

public static method MustBeEnumType (string source, ConfigType type)
type ConfigException
params source Error source tag.
  type The config type.
returns [not-null] The ready-to-throw exception.

MustBeLValue

An assignment target expression is not an L-value.

public static method MustBeLValue (string source, ConfigExpression expr)
type ConfigException
params source Error source tag.
  expr The config expression.
returns [not-null] The ready-to-throw exception.

NoSuchEnumItem

An enum item of the given name does not exist.

public static method NoSuchEnumItem (string source, EnumType enumType, string enumItem)
type ConfigException
params source Error source tag.
  enumType The enum type.
  enumItem The enum item name.
returns [not-null] The ready-to-throw exception.

NoSuchField

A class field of the given name does not exist.

public static method NoSuchField (string source, ConfigType type, string fieldName)
type ConfigException
params source Error source tag.
  type The config type.
  fieldName The field name.
returns [not-null] The ready-to-throw exception.

NoSuchScript

The config domain does not contain a config script of the given name.

public static method NoSuchScript (string source, string scriptName)
type ConfigException
params source Error source tag.
  scriptName The config script name.
returns [not-null] The ready-to-throw exception.

NoSuchType

A config type of the given name does not exist.

public static method NoSuchType (string source, string name)
type ConfigException
params source Error source tag.
  name The config type name.
returns [not-null] The ready-to-throw exception.

NotAssignable

The type a is not assignable to type b.

public static method NotAssignable (string source, ConfigType a, ConfigType b)
type ConfigException
params source Error source tag.
  a The source type.
  b The target type.
returns [not-null] The ready-to-throw exception.

NotConvertible

The type a is not convertible to type b.

public static method NotConvertible (string source, ConfigType a, ConfigType b)
type ConfigException
params source Error source tag.
  a The source type.
  b The target type.
returns [not-null] The ready-to-throw exception.

The given string value is not convertible to type type.

public static method NotConvertible (string source, ConfigType type, string value)
type ConfigException
params source Error source tag.
  type The config type.
  value The inconvertible string value.
returns [not-null] The ready-to-throw exception.

The given number value is not convertible to type type.

public static method NotConvertible (string source, ConfigType type, float64 value)
type ConfigException
params source Error source tag.
  type The config type.
  value The inconvertible number value.
returns [not-null] The ready-to-throw exception.

Null

A config value is null.

public static method Null (string source)
type ConfigException
params source Error source tag.
returns [not-null] The ready-to-throw exception.

OutOfRange

An index is out of range.

public static method OutOfRange (string source, int32 index, int32 minimum, int32 maximum)
type ConfigException
params source Error source tag.
  index The bad index value.
  minimum Minimum allowed index value (inclusive).
  maximum Maximum allowed index value (exclusive).
returns [not-null] The ready-to-throw exception.

TypeAlreadyExists

A config type of the given already exists.

public static method TypeAlreadyExists (string source, string typeName)
type ConfigException
params source Error source tag.
  typeName Full name of the config type.
returns [not-null] The ready-to-throw exception.

VirtualFieldError

An unexpected error has occurred while getting the value of a virtual field.

public static method VirtualFieldError (string source, string typeName, string fieldName, TinmanError error)
type ConfigException
params source Error source tag.
  typeName Full name of the config type that contains the virtual field.
  fieldName The field name.
  error The error that has occurred.
returns [not-null] The ready-to-throw exception.

Public / Methods

ToString

Returns a textual representation of this exception.

[Pure]
public override sealed method ToString ()
type string
returns [not-empty] The localized textual representation.
inherited TinmanException.ToString