Retrieves all Touchstone®
Hazard Analyses in a given
Project,
Business Unit, and
SQL Server Instance.
Syntax
Public Function GetHazardAnalyses( _
ByVal As GetHazardAnalysesRequest _
) As GetHazardAnalysesResponse
Dim instance As HazardAnalysisServiceClient
Dim request As GetHazardAnalysesRequest
Dim value As GetHazardAnalysesResponse
value = instance.GetHazardAnalyses(request)
public GetHazardAnalysesResponse GetHazardAnalyses(
GetHazardAnalysesRequest
)
Parameters
- request
- Contains a GetHazardAnalysesRequest that identifies the Touchstone-generated Business Unit Sequential Identifier (SID), SQL Instance SID, and Project SID associated with the list of Hazard Analyses to retrieve.
Return Value
A GetHazardAnalysesResponse containing a list of Hazard Analyses in the specified Project, Business Unit, and SQL Server Instance.
Example
The following example shows how to retrieve a list of all Touchstone Hazard Analyses in a given Project, Business Unit, and SQL Server Instance using the
GetHazardAnalyses()
method:
using System;
using AIR.Services.Common.Data;
using AIR.Services.HazardAnalysis.Api;
using AIR.Services.HazardAnalysis.Data
class SnippetGetHazardAnalysesRequest
{
private static void GetHazardAnalyses(int businessUnitSid, int sqlInstanceSid, int projectSid)
{
HazardAnalysisServiceClient hazardAnalysisServiceClient = new HazardAnalysisServiceClient();
GetHazardAnalysesRequest getHazardAnalysesRequest = new GetHazardAnalysesRequest();
getHazardAnalysesRequest.ProjectSid = projectSid;
getHazardAnalysesRequest.BusinessUnitSid = businessUnitSid;
getHazardAnalysesRequest.SqlInstanceSid = sqlInstanceSid;
GetHazardAnalysesResponse getHazardAnalysesresponse = hazardAnalysisServiceClient.GetHazardAnalyses(getHazardAnalysesRequest);
if (getHazardAnalysesresponse.Status.Code == StatusCode.Success)
{
//Implement your logic to loop through all the hazard analses records.
foreach (var anlysis in getHazardAnalysesresponse.Analyses)
{
Console.WriteLine("----------------------- Hazard Analysis SID: " + anlysis.HazardAnalysis.Sid + " -----------------------");
Console.WriteLine("Status: " + anlysis.HazardAnalysis.ActivityStatusCode);
Console.WriteLine("Autor: " + anlysis.HazardAnalysis.Author);
Console.WriteLine("Created: " + anlysis.HazardAnalysis.Created);
Console.WriteLine("Analysis Name: " + anlysis.AnalysisOptions.Name);
Console.WriteLine("Exposure Target Name: " + anlysis.AnalysisOptions.ExposureTarget.Name);
Console.WriteLine("Exposure Target Type: " + anlysis.AnalysisOptions.ExposureTarget.Type);
// Output some of the values from the Earthquake, Tropical Cyclone, and Flood hazard profiles.
// The response also returns many other profile and Intensity options.
if (anlysis.AnalysisOptions.IncludeEarthquakeProfile)
{
Console.WriteLine("------------- Earthquake Profile Options -------------");
Console.WriteLine("Include Average Annual Loss: " + anlysis.AnalysisOptions.EarthquakeProfileOptions.IncludeAverageAnnualLoss);
Console.WriteLine("Include California DOI Zone: " + anlysis.AnalysisOptions.EarthquakeProfileOptions.IncludeCaliforniaDOIZone);
Console.WriteLine("Include Fault Zone: " + anlysis.AnalysisOptions.EarthquakeProfileOptions.IncludeFaultZone);
Console.WriteLine("Include Soil Type: " + anlysis.AnalysisOptions.EarthquakeProfileOptions.IncludeSoilType);
}
if (anlysis.AnalysisOptions.IncludeFloodProfile)
{
Console.WriteLine("------------- Flood Profile Options -------------");
Console.WriteLine("Include AIR Flood Zone Category: " + anlysis.AnalysisOptions.FloodProfileOptions.IncludeAIRFloodZoneCategory);
Console.WriteLine("Include Fema Base Flood Elevation: " + anlysis.AnalysisOptions.FloodProfileOptions.IncludeFemaBaseFloodElevation);
Console.WriteLine("Include Fema Flood Zone: " + anlysis.AnalysisOptions.FloodProfileOptions.IncludeFemaFloodZone);
Console.WriteLine("Include Fema Shortest Distance To 500 Year Flood Plain: " + anlysis.AnalysisOptions.FloodProfileOptions.IncludeFemaShortestDistanceTo500YearFloodPlain);
}
if (anlysis.AnalysisOptions.IncludeHurricaneProfile)
{
Console.WriteLine("------------- Hurricane Profile Options -------------");
Console.WriteLine("Include Depth For 100 Year Storm Surge: " + anlysis.AnalysisOptions.HurricaneProfileOptions.IncludeDepthFor100YearStormSurge);
Console.WriteLine("Include Florida Wind Mitigation Exposure Area 2010: " + anlysis.AnalysisOptions.HurricaneProfileOptions.IncludeFloridaWindMitigationExposureArea2010);
Console.WriteLine("Include Florida Wind Mitigation Exposure Area: " + anlysis.AnalysisOptions.HurricaneProfileOptions.IncludeFloridaWindMitigationExposureArea);
Console.WriteLine("Include Distance To ActualCoast: " + anlysis.AnalysisOptions.HurricaneProfileOptions.IncludeDistanceToActualCoast);
}
if (anlysis.AnalysisOptions.IncludeEventIntensityAnalysis)
{
Console.WriteLine("------------- Event Intensity Options -------------");
if (anlysis.AnalysisOptions.IncludeCoastalFloodForEventIntensity)
{
Console.WriteLine("Include On Plain Coastal Flood Depth: " + anlysis.AnalysisOptions.CoastalFloodEventIntensityOptions.IncludeOnPlainFloodDepth);
}
if (anlysis.AnalysisOptions.IncludeEarthquakeForEventIntensity)
{
Console.WriteLine("Include Peak Ground Acceleration: " + anlysis.AnalysisOptions.EarthquakeEventIntensityOptions.IncludePeakGroundAcceleration);
Console.WriteLine("Include Spectral Accelaration03: " + anlysis.AnalysisOptions.EarthquakeEventIntensityOptions.IncludeSpectralAccelaration03);
Console.WriteLine("Include Spectral Acceleration10: " + anlysis.AnalysisOptions.EarthquakeEventIntensityOptions.IncludeSpectralAcceleration10);
}
}
}
}
}
}
Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
See Also