ForgeDocs
Documentation for the forge framework
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Pages
Forge.Entities.DataAccessor Struct Reference

Provides a convenient and efficient way to access a type of Data. More...

Public Member Functions

 DataAccessor (Data.IData data)
 Helper constructor for DataAccessor(Type). This merely forwards the call with the type parameter being data.GetType(). More...
 
 DataAccessor (Type dataType)
 Creates a new DataAccessor that accesses the specified Data type. More...
 
override bool Equals (Object obj)
 Indicates whether this instance and a specified object are equal. More...
 
override int GetHashCode ()
 Returns a hash code for this instance. More...
 

Static Public Member Functions

static bool operator== (DataAccessor x, DataAccessor y)
 Indicates whether this instance and a specified object are equal. More...
 
static bool operator!= (DataAccessor x, DataAccessor y)
 Indicates whether this instance and a specified object are not equal. More...
 

Public Attributes

readonly int Id
 Returns the mapped id for this accessor. More...
 

Properties

Type DataType [get]
 Helper method to get the type of data that this given DataAccessor maps back to. More...
 

Detailed Description

Provides a convenient and efficient way to access a type of Data.

Constructor & Destructor Documentation

Forge.Entities.DataAccessor.DataAccessor ( Data.IData  data)

Helper constructor for DataAccessor(Type). This merely forwards the call with the type parameter being data.GetType().

Forge.Entities.DataAccessor.DataAccessor ( Type  dataType)

Creates a new DataAccessor that accesses the specified Data type.

Parameters
dataTypeThe type of Data to retrieve; note that this parameter must be a subtype of Data

Member Function Documentation

override bool Forge.Entities.DataAccessor.Equals ( Object  obj)

Indicates whether this instance and a specified object are equal.

override int Forge.Entities.DataAccessor.GetHashCode ( )

Returns a hash code for this instance.

static bool Forge.Entities.DataAccessor.operator!= ( DataAccessor  x,
DataAccessor  y 
)
static

Indicates whether this instance and a specified object are not equal.

static bool Forge.Entities.DataAccessor.operator== ( DataAccessor  x,
DataAccessor  y 
)
static

Indicates whether this instance and a specified object are equal.

Member Data Documentation

readonly int Forge.Entities.DataAccessor.Id

Returns the mapped id for this accessor.

Property Documentation

Type Forge.Entities.DataAccessor.DataType
get

Helper method to get the type of data that this given DataAccessor maps back to.


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