Class StructureDataIntegrationClient

Namespace

Sfrep.AppraiseIt.Client.Integration.DataStore

Assembly

Sfrep.AppraiseIt.Client.Integration.dll

Encapsulate's a property's structure (dwelling) in the dynamic data store.

public sealed class StructureDataIntegrationClient : DataStoreIntegrationClientBase, IDisposable

Inheritance

object

DataStoreIntegrationClientBase

StructureDataIntegrationClient

Implements

IDisposable

Inherited Members

DataStoreIntegrationClientBase.Disposed

DataStoreIntegrationClientBase.Dispose()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AduCount

Gets the number of ADUs in this structure.

public int AduCount { get; }

Property Value

int

IsManufacturedHome

Gets a value indicating whether this structure is a manufactured home.

public bool IsManufacturedHome { get; set; }

Property Value

bool

LivingUnitCount

Gets the number of living units in this structure.

public int LivingUnitCount { get; }

Property Value

int

Name

Gets or sets the structure's name.

public string Name { get; set; }

Property Value

string

StructureIndex

Gets the structure's index.

public int StructureIndex { get; }

Property Value

int

Methods

AddAdu(string)

Adds an ADU to this structure.

public StructureAduDataIntegrationClient AddAdu(string name)

Parameters

name string

The ADU's name.

Returns

StructureAduDataIntegrationClient

The newly added ADU.

Remarks

Each call returns a new instance that, to prevent resource leaks, must be disposed by calling the Dispose method once it is no longer needed.

AddLivingUnit(string)

Adds a living unit to this structure.

public StructureLivingUnitDataIntegrationClient AddLivingUnit(string name)

Parameters

name string

The structure's name.

Returns

StructureLivingUnitDataIntegrationClient

The newly added living unit.

Remarks

Each call returns a new instance that, to prevent resource leaks, must be disposed by calling the Dispose method once it is no longer needed.

Dispose(bool)

Frees resources used by this instance.

protected override void Dispose(bool disposing)

Parameters

disposing bool

True if called by the Dispose() method. False if called by the finalizer.

GetAdu(int)

Gets the specified ADU.

public StructureAduDataIntegrationClient GetAdu(int index)

Parameters

index int

The ADU's index.

Returns

StructureAduDataIntegrationClient

The specified ADU.

Remarks

Each call returns a new instance that, to prevent resource leaks, must be disposed by calling the Dispose method once it is no longer needed.

GetFields()

Gets the field data for this structure.

public FieldsIndexIntegrationClient GetFields()

Returns

FieldsIndexIntegrationClient

The field data for this structure.

Remarks

Each call returns a new instance that, to prevent resource leaks, must be disposed by calling the Dispose method once it is no longer needed.

GetLivingUnit(int)

Gets the specified living unit.

public StructureLivingUnitDataIntegrationClient GetLivingUnit(int index)

Parameters

index int

The living unit's index.

Returns

StructureLivingUnitDataIntegrationClient

The living unit.

Remarks

Each call returns a new instance that, to prevent resource leaks, must be disposed by calling the Dispose method once it is no longer needed.

RemoveAdu(int)

Removes the specified ADU from this structure.

public void RemoveAdu(int index)

Parameters

index int

The ADU's index.

RemoveLivingUnit(int)

Removes the specified living unit from this structure.

public void RemoveLivingUnit(int index)

Parameters

index int

The living unit's index.