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.SimulationComponentDtoBase< Type, BaseType > Class Template Referenceabstract

Interface for all components of simulation DTOs. More...

+ Inheritance diagram for IG.Sim.SimulationComponentDtoBase< Type, BaseType >:
+ Collaboration diagram for IG.Sim.SimulationComponentDtoBase< Type, BaseType >:

Public Member Functions

abstract 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...
 
abstract void RestoreCrossLinks ()
 Restore cross links in the internall structure of the current DTO. More...
 
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...
 
abstract Type 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...
 
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...
 

Protected Member Functions

 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 ()
 

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

Interface for all components of simulation DTOs.

Includes common operations necessary to handle any simulation data prepared for reading/writing in standard formats.

$A Igor Nov11;

Type Constraints
BaseType :class 
Type :class 
Type :BaseType 

Constructor & Destructor Documentation

IG.Sim.SimulationComponentDtoBase< Type, BaseType >.SimulationComponentDtoBase ( )
inlineprotected

Member Function Documentation

abstract void IG.Sim.SimulationComponentDtoBase< Type, BaseType >.NulllifyCrossLinks ( )
pure virtual

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.

Implemented in IG.Sim.SimDomainDto, IG.Sim.SimFieldElemetDto< FieldType >, and IG.Sim.SimFieldBaseDto< FieldType >.

abstract void IG.Sim.SimulationComponentDtoBase< Type, BaseType >.RestoreCrossLinks ( )
pure virtual

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

Implemented in IG.Sim.SimDomainDto, IG.Sim.SimFieldElemetDto< FieldType >, and IG.Sim.SimFieldBaseDto< FieldType >.

virtual string IG.Sim.SimulationComponentDtoBase< Type, BaseType >.GetComponentType ( )
inlinevirtual

Returns type of the current component.


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