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.Sim.SimFieldElemetDto< FieldType > Class Template Reference

Base class for a DTO that holds node values of a single element (component) of a specific simulation field. More...

+ Inheritance diagram for IG.Sim.SimFieldElemetDto< FieldType >:
+ Collaboration diagram for IG.Sim.SimFieldElemetDto< FieldType >:

Public Member Functions

 SimFieldElemetDto (string fieldName, string fieldElementExtension, int[] elementIndices)
 Constructs a new simulation field element DTO. More...
 
virtual string GetFieldElementName ()
 Returns full name of hte field element, composed of the field name and component name (e.g. strain_xy, velocity_z). More...
 
int GetRank ()
 Returns the rank of the current field element, which coincides with number of indices that define the current elemet. More...
 
int GetIndex (int whichIndex)
 Returns the specified index of the current element (applies for fields of rank 1 or more). More...
 
override SimFieldElemetDto
< FieldType > 
CreateObject ()
 Creates and returns a new object of the type whose data is represented by the current DTO (Data Transfer Object). WARNING: Implement thread locking in overriding functions! More...
 
override void NulllifyCrossLinks ()
 Sets all cross links in the internall structure of the current DTO (data transfer object) to null. Cross links facilitate traversing of teh internal structure. More...
 
override void RestoreCrossLinks ()
 Restore cross links in the internall structure of the current DTO. More...
 
- Public Member Functions inherited from IG.Sim.SimulationComponentDtoBase< Type, BaseType >
virtual string GetComponentType ()
 Returns type of the current component. More...
 
- Public Member Functions inherited from IG.Lib.SerializationDtoBase< Type, BaseType >
 SerializationDtoBase ()
 
virtual bool GetNull ()
 Returns a flag indicating whether the object represented by the current DTO is null. More...
 
virtual void SetNull (bool isNull)
 Sets a flag indicating whether the object represented by the current DTO is null. More...
 
virtual void CopyFromBase (BaseType obj)
 Copies data to the current DTO from an object of type BaseType. More...
 
virtual void CopyToBase (ref BaseType obj)
 Copies data from the current DTO to an object of the base type. Object is created anew if necessary by using the CreateObject() method. More...
 
virtual void CopyFrom (Type obj)
 Copies data to the current DTO from an object of type Type. More...
 
virtual void CopyTo (ref Type obj)
 Copies data from the current DTO to an object of type Type. Object is created anew if necessary by using the CreateObject() method. More...
 
virtual void CopyFromObject (object obj)
 Copies data to the current DTO from an object of type object. The necessary casts are performed. More...
 
virtual void CopyToObject (ref object obj)
 Copies data from the current DTO to an object of type object. Object is created anew if necessary by using the CreateObject() method. The necessary casts are performed. More...
 
override string ToString ()
 Creates and returns string representation of the current DTO (data transfer object). More...
 
- Public Member Functions inherited from IG.Sim.ISimulationComponentDto
string GetComponentType ()
 Returns type of the current component. More...
 

Public Attributes

string FieldName
 Name of the field whose component is represented by the current object. More...
 
string FieldElementExtension
 Extension of the field element name that specifies which field component is represented (applies to vector and tensor fields). More...
 
int[] ElementIndices
 Indices of the current field element. More...
 
double[] Values
 Nodal values of the current field elemet. More...
 

Protected Member Functions

override void CopyFromPlain (SimFieldElemetDto< FieldType > obj)
 
override void CopyToPlain (ref SimFieldElemetDto< FieldType > obj)
 
- Protected Member Functions inherited from IG.Sim.SimulationComponentDtoBase< Type, BaseType >
 SimulationComponentDtoBase ()
 
- Protected Member Functions inherited from IG.Lib.SerializationDtoBase< Type, BaseType >
abstract void CopyFromPlain (BaseType obj)
 Copies contents of the specified object to the current DTO (Data Transfer Object). More...
 
abstract void CopyToPlain (ref BaseType obj)
 Copies contents of the current DTO (Data Transfer Object) to the specified object. More...
 
- Protected Member Functions inherited from IG.Lib.SerializationDto
 SerializationDto ()
 

Private Member Functions

 SimFieldElemetDto ()
 

Additional Inherited Members

- Static Public Member Functions inherited from IG.Lib.SerializationDto
static ObjectType CopyToObjectReturned< DtoType, ObjectType > (DtoType dto, ObjectType obj)
 Replacement for CopyToObject for cases where object can not be passed by reference. The returned object must be assigned to object (property, list element, etc.) to which object state is copied. More...
 
static void CopyToObject< DtoType, ObjectType > (DtoType dto, ref ObjectType obj)
 Copies object state form the specified DTO (data transfer object) to the specified object. More...
 
static DtoType CopyFromObjectReturned< DtoType, ObjectType > (ObjectType obj, DtoType dto)
 Replacement for CopyFromObject for cases where object can not be passed by reference. The returned object must be assigned to object (property, list element, etc.) to which object state is copied. More...
 
static void CopyFromObject< DtoType, ObjectType > (ObjectType obj, ref DtoType dto)
 Copies object state form the specified object to the corresponding DTO (data transfer object). More...
 
static ObjectType[] CopyArrayToObjectReturned< DtoType, ObjectType > (DtoType[] tabDto, ObjectType[] tabObj)
 Replacement for CopyArrayToObject for cases where object can not be passed by reference. The returned object must be assigned to object (property, list element, etc.) to which data is copied. More...
 
static void CopyArrayToObject< DtoType, ObjectType > (DtoType[] tabDto, ref ObjectType[] tabObj)
 Copies array of DTOs (Data Transfer Objects) to an array of appropriate objects. More...
 
static DtoType[] CopyArrayFromObjectReturned< DtoType, ObjectType > (ObjectType[] tabObj, DtoType[] tabDto)
 Replacement for CopyArrayFromObject for cases where object can not be passed by reference. The returned object must be assigned to object (property, list element, etc.) to which data is copied. More...
 
static void CopyArrayFromObject< DtoType, ObjectType > (ObjectType[] tabObj, ref DtoType[] tabDto)
 Copies array of objects to an array of DTOs. More...
 
static List< ObjectType > CopyListToObjectReturned< DtoType, ObjectType > (DtoType[] tabDto, List< ObjectType > listObj)
 Replacement for CopyListToObject for cases where object can not be passed by reference. The returned object must be assigned to object (property, list element, etc.) to which data is copied. More...
 
static void CopyListToObject< DtoType, ObjectType > (DtoType[] tabDto, ref List< ObjectType > listObj)
 Copies array of DTOs (Data Transfer Objects) to a list of appropriate objects. More...
 
static DtoType[] CopyListFromObjectReturned< DtoType, ObjectType > (List< ObjectType > tabObj, DtoType[] tabDto)
 Replacement for CopyArrayFromObject for cases where object can not be passed by reference. The returned object must be assigned to object (property, list element, etc.) to which data is copied. More...
 
static void CopyListFromObject< DtoType, ObjectType > (List< ObjectType > tabObj, ref DtoType[] tabDto)
 Copies array of objects to a list of DTOs. More...
 
- Protected Attributes inherited from IG.Lib.SerializationDtoBase< Type, BaseType >
bool _isNull = false
 
- Properties inherited from IG.Lib.SerializationDtoBase< Type, BaseType >
object Lock [get]
 This object's central lock object to be used by other object. Do not use this object for locking in class' methods, for this you should use InternalLock. More...
 
- Properties inherited from IG.Lib.ILockable
object Lock [get]
 

Detailed Description

Base class for a DTO that holds node values of a single element (component) of a specific simulation field.

Template Parameters
FieldTypeType of the field DTO whose component is carried by the current DTO.

$A Igor Aug11 Nov11;

Type Constraints
FieldType :SimFieldBaseDto<FieldType> 

Constructor & Destructor Documentation

IG.Sim.SimFieldElemetDto< FieldType >.SimFieldElemetDto ( )
inlineprivate
IG.Sim.SimFieldElemetDto< FieldType >.SimFieldElemetDto ( string  fieldName,
string  fieldElementExtension,
int[]  elementIndices 
)
inline

Constructs a new simulation field element DTO.

Parameters
fieldNameName of the field.
fieldElementExtensionEventual Extension of the field indicating which field element is in question.
elementIndicesIndices of the field element.

Member Function Documentation

virtual string IG.Sim.SimFieldElemetDto< FieldType >.GetFieldElementName ( )
inlinevirtual

Returns full name of hte field element, composed of the field name and component name (e.g. strain_xy, velocity_z).

Returns
int IG.Sim.SimFieldElemetDto< FieldType >.GetRank ( )
inline

Returns the rank of the current field element, which coincides with number of indices that define the current elemet.

int IG.Sim.SimFieldElemetDto< FieldType >.GetIndex ( int  whichIndex)
inline

Returns the specified index of the current element (applies for fields of rank 1 or more).

Parameters
whichIndexSpecifies which index to return.
Returns
override void IG.Sim.SimFieldElemetDto< FieldType >.CopyFromPlain ( SimFieldElemetDto< FieldType >  obj)
inlineprotected
override void IG.Sim.SimFieldElemetDto< FieldType >.CopyToPlain ( ref SimFieldElemetDto< FieldType >  obj)
inlineprotected
override SimFieldElemetDto<FieldType> IG.Sim.SimFieldElemetDto< FieldType >.CreateObject ( )
inlinevirtual

Creates and returns a new object of the type whose data is represented by the current DTO (Data Transfer Object). WARNING: Implement thread locking in overriding functions!

Therad locking should be performed in overriding functions!

Implements IG.Lib.SerializationDtoBase< Type, BaseType >.

override void IG.Sim.SimFieldElemetDto< FieldType >.NulllifyCrossLinks ( )
inlinevirtual

Sets all cross links in the internall structure of the current DTO (data transfer object) to null. Cross links facilitate traversing of teh internal structure.

Implements IG.Sim.SimulationComponentDtoBase< Type, BaseType >.

override void IG.Sim.SimFieldElemetDto< FieldType >.RestoreCrossLinks ( )
inlinevirtual

Restore cross links in the internall structure of the current DTO.

Implements IG.Sim.SimulationComponentDtoBase< Type, BaseType >.

Member Data Documentation

string IG.Sim.SimFieldElemetDto< FieldType >.FieldName

Name of the field whose component is represented by the current object.

string IG.Sim.SimFieldElemetDto< FieldType >.FieldElementExtension

Extension of the field element name that specifies which field component is represented (applies to vector and tensor fields).

int [] IG.Sim.SimFieldElemetDto< FieldType >.ElementIndices

Indices of the current field element.

double [] IG.Sim.SimFieldElemetDto< FieldType >.Values

Nodal values of the current field elemet.


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