Class OutbuildingDataIntegrationClient
- Namespace
- Sfrep.AppraiseIt.Client.Integration.DataStore
- Assembly
- Sfrep.AppraiseIt.Client.Integration.dll
Encapsulate's a property's outbuilding in the dynamic data store.
public sealed class OutbuildingDataIntegrationClient : DataStoreIntegrationClientBase, IDisposable
- Inheritance
-
objectOutbuildingDataIntegrationClient
- Implements
- Inherited Members
-
object.Equals(object)object.Equals(object, object)object.GetHashCode()object.GetType()object.ReferenceEquals(object, object)object.ToString()
Properties
AduCount
Gets the number of ADUs associated with this outbuilding.
public int AduCount { get; }
Property Value
- int
OutbuildingIndex
Gets the outbuilding's index.
public int OutbuildingIndex { get; }
Property Value
- int
OutbuildingType
Gets or sets the outbuilding's type.
public string OutbuildingType { get; set; }
Property Value
- string
Remarks
Supported values:
- None
- Barn
- Boathouse
- Bunkhouse
- EnclosedKennel
- Greenhouse
- GuestHouse
- IndoorRidingArena
- ManufacturedHome
- Office
- Other
- PoolHouse
- Shed
- Silo
- Stable
- StandaloneAdu
- Studio
- Workshop
OutbuildingTypeOtherDescription
Gets or sets the outbuilding's description when the outbuilding's type is Other.
public string OutbuildingTypeOtherDescription { get; set; }
Property Value
- string
Methods
AddAdu(string)
Adds an ADU to this outbuilding.
public OutbuildingAduDataIntegrationClient AddAdu(string name)
Parameters
namestringThe ADU's name.
Returns
- OutbuildingAduDataIntegrationClient
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.
Dispose(bool)
Frees resources used by this instance.
protected override void Dispose(bool disposing)
Parameters
disposingboolTrue if called by the Dispose() method. False if called by the finalizer.
GetAdu(int)
Gets the specified ADU associated with this outbuilding.
public OutbuildingAduDataIntegrationClient GetAdu(int index)
Parameters
indexintThe ADU's index.
Returns
- OutbuildingAduDataIntegrationClient
The 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 outbuilding.
public FieldsIndexIntegrationClient GetFields()
Returns
- FieldsIndexIntegrationClient
The field data for this outbuilding.
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 outbuilding.
public void RemoveAdu(int index)
Parameters
indexintThe ADU's index.