Initializing help system before first use

xpressinsight.EntitiesContainer

Purpose

Abstract base class used for classes that contain scenario entities (such as AppBase and ScenarioData), providing a standard way to query entity definitions.

The ScenarioData decorator will automatically add the EntitiesContainer as a superclass of the class being defined, but it can also be added explicitly if required by static code analysis tools.


Synopsis
class xpressinsight.EntitiesContainer
Example
Example of decorating a class with ScenarioData and explicitly declaring the EntitiesContainer superclass: 
>>> @xi.ScenarioData
... class EntitiesToRead(xi.EntitiesContainer):
...     my_integer: xi.data.Scalar()
...     my_array: xi.data.Series()
Related topics
EntitiesContainer.entities_cfg,
EntitiesContainer.get_entities_cfg,
ScenarioData

Parent Topic App Configuration Classes

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.