ICalcAlgorithm

Assembly: Algo;

Description

The ICalcAlgorithm interface is used to work with calculation algorithm.

Inheritance Hierarchy

          ICalcObject

          ICalcAlgorithm

Properties

	Property name	Brief description
	ClipBoard	The ClipBoard property enables the user to work with the clipboard to create copies of calculation algorithm objects in calculation tree.
	EtlTask	The EtlTask property returns ETL task objects settings.
	Included	The Included property determines including or excluding of object from calculation algorithm.
	IsDirty	The IsDirty property returns whether there are changes in calculation algorithm.
	IsRtProblem	The IsRtProblem property determines whether a new calculation mechanism is used.
	Items	The Items property returns the list of calculation algorithm objects.
	ModelFolder	The ModelFolder property returns the folder that stores child metamodels of calculation algorithm.
	MsGenerateFormula	The MsGenerateFormula property returns the modeling problem to create calculation algorithm formulas.
	MsProblem	The MsProblem property returns the modeling problem that is used on algorithm calculation.
	ParamValues	The ParamValues property returns the algorithm calculation period start and end settings and the collection of calculation algorithm parameters.
	Settings	The Settings property returns the settings of algorithm calculation period.
	Stubs	The Stubs property returns the collection of data sources and data consumers of calculation blocks and control blocks.

Properties inherited from ICalcObject

	Property name	Brief description
	Descriptor	The Descriptor property returns the calculation algorithm object as an internal repository object.
	Id	The Id property determines a calculation algorithm object identifier.
	IsEdited	The IsEdited property returns whether calculation algorithm object is edited.
	IsNeedConvert	The IsNeedConvert property returns whether internal metamodels are transformed into the entities that are not repository objects, and vice versa.
	Key	The Key property returns the calculation algorithm object key.
	MetaModel	The MetaModel property returns the metamodel used in calculation algorithm object.
	MetaModelDescriptor	The MetaModelDescriptor property returns metamodel parameters.
	Name	The Name property determines calculation algorithm object name.
	Params	The Params property returns the metamodel parameters collection.
	SelControl	The SelControl property returns settings for controlling dimension opening parameters.
	Type	The Type property determines a calculation algorithm object type.

Methods

	Method name	Brief description
	Calculate	The Calculate method calculates algorithm.
	CalculateAsync	The CalculateAsync method calculates algorithm asynchronously when multithreaded calculation is used.
	CancelEdit	The CancelEdit method cancels calculation algorithm editing.
	CreateFormulasGenerationSettings	The CreateFormulasGenerationSettings method determines settings to create calculation formulas.
	Debug	The Debug method debugs calculation algorithm.
	FindWxShapeByCalcObject	The FindWxShapeByCalcObject method returns the specified calculation algorithm object as a shape.
	ForceIncludeChange	The ForceIncludeChange method includes or excludes the object from the nested calculation algorithm.
	GenerateFormulas	The GenerateFormulas method creates calculation formulas.
	MoveChainEntry	The MoveChainEntry method reorders metamodel calculation chain elements.
	MoveObject	The MoveObject method reorders calculation algorithm objects.
	RestoreStyles	The RestoreStyles method resets calculation algorithm object styles.
	SaveOldStyles	The SaveOldStyles method saves the specified calculation algorithm object styles.
	SetDefaultParamsValue	The SetDefaultParamsValue method sets the specified values of calculation algorithm parameters as default values.

Methods inherited from ICalcObject

	Method name	Brief description
	Convert	The Convert method transforms internal metamodels into the entities that are not repository objects, and vice versa.
	CopyTo	The CopyTo method copies calculation algorithm to the clipboard.
	Delete	The Delete method deletes calculation algorithm object.
	FillSelSetFromParams	The FillSelSetFromParams method passes the dimensions selection used as a calculation algorithm parameter to the parameters panel.
	RefreshMetaModel	The RefreshMetaModel method refreshes metamodel.
	Save	The Save method saves calculation algorithm object.
	ToJson	The ToJson method returns the calculation algorithm object in the JSON format.

See also:

Algo Assembly Interfaces