IGLib  1.7.2
The IGLib base library EXTENDED - with other lilbraries and applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType > Class Template Referenceabstract

Base class for various DTO (Data Transfer Objects) for scalar function controllers. Used to store a state of a scalar function. More...

+ Inheritance diagram for IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >:
+ Collaboration diagram for IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >:

Public Member Functions

 ScalarFunctionScriptDtoBase ()
 Default constructor, sets IsNull to true. More...
 
 ScalarFunctionScriptDtoBase (int spaceDimension)
 Constructor, prepares the current DTO for storing a scalar function of the specified dimension. More...
 
abstract FunctionControllerType CreateScalarFunctionController (int dimension)
 Creates and returns a new scalar function in the space of specific dimension. More...
 
override FunctionControllerType CreateObject ()
 Creates and returns a new vector of the specified type and dimension. More...
 

Protected Member Functions

override void CopyFromPlain (ScalarFunctionScriptController functionController)
 Copies data to the current DTO from a scaalr function object. More...
 
override void CopyToPlain (ref ScalarFunctionScriptController functionContrller)
 Copies data from the current DTO to a scalar function object. More...
 

Properties

virtual int Dimension [get, set]
 Dimension of the parameter space. More...
 
virtual string Name [get, set]
 Scalar function name. More...
 
virtual string Description [get, set]
 Scalar function description. More...
 
virtual string[] ParameterNames [get, set]
 Names of function parameters. More...
 
virtual bool IsValueDefined [get, set]
 Whether function value is defined for the represented function. More...
 
virtual bool IsGradientDefined [get, set]
 Whether function gradient is defined for the represented function. More...
 
virtual string ValueDefinitonString [get, set]
 Definition of function value. More...
 
virtual string[] GradientDefinitionStrings [get, set]
 Gradient definition strings (separately for each gradient component). More...
 
virtual string ZType [get, set]
 
virtual InputOutputDataDefinitonDto ZDataDefinition [get, set]
 

Detailed Description

Base class for various DTO (Data Transfer Objects) for scalar function controllers. Used to store a state of a scalar function.

Beside as data transfer object, this class provides a variety of manipulations that are necessary when defining scalar functions from scripts (user definitions).

Template Parameters
FunctionControllerTypeType parameter specifying the specific scalar function controller type for which concrete DTO is designed.

$A Igor Feb16;

Type Constraints
FunctionControllerType :ScalarFunctionScriptController 

Constructor & Destructor Documentation

IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >.ScalarFunctionScriptDtoBase ( )
inline

Default constructor, sets IsNull to true.

IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >.ScalarFunctionScriptDtoBase ( int  spaceDimension)
inline

Constructor, prepares the current DTO for storing a scalar function of the specified dimension.

Parameters
spaceDimensionDimension of a vector that is stored in the current DTO.

Member Function Documentation

abstract FunctionControllerType IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >.CreateScalarFunctionController ( int  dimension)
pure virtual

Creates and returns a new scalar function in the space of specific dimension.

Parameters
dimensionVector dimension.

Implemented in IG.Num.ScalarFunctionScriptDto.

override FunctionControllerType IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >.CreateObject ( )
inline

Creates and returns a new vector of the specified type and dimension.

override void IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >.CopyToPlain ( ref ScalarFunctionScriptController  functionContrller)
inlineprotected

Copies data from the current DTO to a scalar function object.

Parameters
functionContrllerScalar function object that data is copied to.

Property Documentation

virtual int IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >.Dimension
getset

Dimension of the parameter space.

virtual string IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >.Name
getset

Scalar function name.

virtual string IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >.Description
getset

Scalar function description.

virtual string [] IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >.ParameterNames
getset

Names of function parameters.

virtual bool IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >.IsValueDefined
getset

Whether function value is defined for the represented function.

virtual bool IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >.IsGradientDefined
getset

Whether function gradient is defined for the represented function.

virtual string IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >.ValueDefinitonString
getset

Definition of function value.

virtual string [] IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >.GradientDefinitionStrings
getset

Gradient definition strings (separately for each gradient component).

virtual string IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >.ZType
getset
virtual InputOutputDataDefinitonDto IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >.ZDataDefinition
getset

The documentation for this class was generated from the following file: