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.ScalarFunctionScriptDto Class Reference

DTO (data transfer object) for vector interface (IVector). More...

+ Inheritance diagram for IG.Num.ScalarFunctionScriptDto:
+ Collaboration diagram for IG.Num.ScalarFunctionScriptDto:

Public Member Functions

 ScalarFunctionScriptDto ()
 Creates a DTO for storing state of a script based scalar function objects of any type. More...
 
 ScalarFunctionScriptDto (int dimension)
 Creates a DTO for storing a scalar function object of any vector type, with specified dimension. More...
 
override
ScalarFunctionScriptController 
CreateScalarFunctionController (int length)
 Creates and returns a new vector cast to the interface type IVector. More...
 
- Public Member Functions inherited from IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >
 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...
 
override FunctionControllerType CreateObject ()
 Creates and returns a new vector of the specified type and dimension. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >
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 inherited from IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >
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

DTO (data transfer object) for vector interface (IVector).

$A Igor Feb16;

Constructor & Destructor Documentation

IG.Num.ScalarFunctionScriptDto.ScalarFunctionScriptDto ( )
inline

Creates a DTO for storing state of a script based scalar function objects of any type.

IG.Num.ScalarFunctionScriptDto.ScalarFunctionScriptDto ( int  dimension)
inline

Creates a DTO for storing a scalar function object of any vector type, with specified dimension.

Parameters
dimensionVector dimension.

Member Function Documentation

override ScalarFunctionScriptController IG.Num.ScalarFunctionScriptDto.CreateScalarFunctionController ( int  length)
inlinevirtual

Creates and returns a new vector cast to the interface type IVector.

Parameters
lengthVector dimension.

Implements IG.Num.ScalarFunctionScriptDtoBase< FunctionControllerType >.


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