Table of Contents

Class StructureDataIntegrationCom

Namespace
Sfrep.AppraiseIt.Client.Integration.Com.DataStore
Assembly
Sfrep.AppraiseIt.Client.Integration.Com.dll

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

[ComVisible(true)]
[Guid("7DD843AC-D62A-4FF3-A563-FD80791F27E1")]
[ClassInterface(ClassInterfaceType.None)]
public sealed class StructureDataIntegrationCom : IStructureDataIntegrationCom, IDisposable
Inheritance
object
StructureDataIntegrationCom
Implements
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()

Constructors

StructureDataIntegrationCom()

This no args constructor is required for COM support and should not be called directly.

public StructureDataIntegrationCom()

Methods

AddAdu(string)

Adds an ADU to this structure.

public IStructureAduDataIntegrationCom AddAdu(string name)

Parameters

name string

The ADU's name.

Returns

IStructureAduDataIntegrationCom

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 IStructureLivingUnitDataIntegrationCom AddLivingUnit(string name)

Parameters

name string

The structure's name.

Returns

IStructureLivingUnitDataIntegrationCom

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.

AduCount()

Gets the number of ADUs in this structure.

public int AduCount()

Returns

int

The number of ADUs in this structure.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

GetAdu(int)

Gets the specified ADU.

public IStructureAduDataIntegrationCom GetAdu(int index)

Parameters

index int

The ADU's index.

Returns

IStructureAduDataIntegrationCom

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

Returns

IFieldsIndexIntegrationCom

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.

GetIsManufacturedHome()

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

public bool GetIsManufacturedHome()

Returns

bool

A value indicating whether this structure is a manufactured home.

GetLivingUnit(int)

Gets the specified living unit.

public IStructureLivingUnitDataIntegrationCom GetLivingUnit(int index)

Parameters

index int

The living unit's index.

Returns

IStructureLivingUnitDataIntegrationCom

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.

GetName()

Gets the structure's name.

public string GetName()

Returns

string

The structure's name.

LivingUnitCount()

Gets the number of living units in this structure.

public int LivingUnitCount()

Returns

int

The number of living units in this structure.

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.

SetIsManufacturedHome(bool)

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

public void SetIsManufacturedHome(bool isManufacturedHome)

Parameters

isManufacturedHome bool

A value indicating whether this structure is a manufactured home.

SetName(string)

Sets the structure's name.

public void SetName(string name)

Parameters

name string

The structure's name.

StructureIndex()

Gets the structure's index.

public int StructureIndex()

Returns

int

The structure's index.