Files
win8phoneApp/Doc/man/man3/CampusAppWP8_Model_GeoDb_SpsModel.3
stubbfel 38e75365ef add doku
2013-10-11 14:42:47 +02:00

197 lines
4.5 KiB
Groff

.TH "CampusAppWP8.Model.GeoDb.SpsModel" 3 "Fri Oct 11 2013" "CampusAppWp8" \" -*- nroff -*-
.ad l
.nh
.SH NAME
CampusAppWP8.Model.GeoDb.SpsModel \-
.PP
\fBModel\fP for a xml-response of the SPSService
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBSpsModel\fP ()"
.br
.RI "\fIInitializes a new instance of the \fBSpsModel\fP class\&.\fP"
.ti -1c
.RI "List< \fBPlaceModel\fP > \fBGetPlacesByInformation\fP (string query, bool ignoreCases=true, List< string > informationNames=null)"
.br
.RI "\fIGets places by information\&.\fP"
.ti -1c
.RI "void \fBAddPlaces\fP (List< \fBPlaceModel\fP > places)"
.br
.RI "\fIAdds the places\&.\fP"
.ti -1c
.RI "List< string > \fBCreatePidList\fP ()"
.br
.RI "\fICreates PID list\&.\fP"
.ti -1c
.RI "\fBPlaceModel\fP \fBGetPlaceById\fP (string id)"
.br
.RI "\fIGets place by identifier\&.\fP"
.ti -1c
.RI "bool \fBContainsInformationNames\fP (List< string > pidList, List< string > names)"
.br
.RI "\fIQuery if 'pidList' contains information names\&.\fP"
.ti -1c
.RI "bool \fBContainsServiceNames\fP (List< string > pidList, List< string > names)"
.br
.RI "\fIQuery if 'pidList' contains service names\&.\fP"
.ti -1c
.RI "List< \fBPlaceModel\fP > \fBFilterByPid\fP (List< string > pidList)"
.br
.RI "\fIFilter by PID\&.\fP"
.in -1c
.SS "Properties"
.in +1c
.ti -1c
.RI "ObservableCollection< \fBPlaceModel\fP > \fBPlaces\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets a list of places \fP"
.ti -1c
.RI "bool \fBHasChanged\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets a value indicating whether this object has changed\&.\fP"
.in -1c
.SH "Detailed Description"
.PP
\fBModel\fP for a xml-response of the SPSService
.SH "Constructor & Destructor Documentation"
.PP
.SS "CampusAppWP8\&.Model\&.GeoDb\&.SpsModel\&.SpsModel ()"
.PP
Initializes a new instance of the \fBSpsModel\fP class\&.Stubbfel, 20\&.08\&.2013\&.
.SH "Member Function Documentation"
.PP
.SS "void CampusAppWP8\&.Model\&.GeoDb\&.SpsModel\&.AddPlaces (List< \fBPlaceModel\fP >places)"
.PP
Adds the places\&.Stubbfel, 09\&.09\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIplaces\fP A list of places\&.
.RE
.PP
.SS "bool CampusAppWP8\&.Model\&.GeoDb\&.SpsModel\&.ContainsInformationNames (List< string >pidList, List< string >names)"
.PP
Query if 'pidList' contains information names\&.Stubbfel, 09\&.09\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIpidList\fP List of pids\&.
.br
\fInames\fP The names\&.
.RE
.PP
\fBReturns:\fP
.RS 4
true if it succeeds, false if it fails\&.
.RE
.PP
.SS "bool CampusAppWP8\&.Model\&.GeoDb\&.SpsModel\&.ContainsServiceNames (List< string >pidList, List< string >names)"
.PP
Query if 'pidList' contains service names\&.Stubbfel, 09\&.09\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIpidList\fP List of pids\&.
.br
\fInames\fP The names\&.
.RE
.PP
\fBReturns:\fP
.RS 4
true if it succeeds, false if it fails\&.
.RE
.PP
.SS "List<string> CampusAppWP8\&.Model\&.GeoDb\&.SpsModel\&.CreatePidList ()"
.PP
Creates PID list\&.Stubbfel, 09\&.09\&.2013\&.
.PP
\fBReturns:\fP
.RS 4
The new PID list\&.
.RE
.PP
.SS "List<\fBPlaceModel\fP> CampusAppWP8\&.Model\&.GeoDb\&.SpsModel\&.FilterByPid (List< string >pidList)"
.PP
Filter by PID\&.Stubbfel, 11\&.09\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIpidList\fP List of pids\&.
.RE
.PP
\fBReturns:\fP
.RS 4
filtered list of places\&.
.RE
.PP
.SS "\fBPlaceModel\fP CampusAppWP8\&.Model\&.GeoDb\&.SpsModel\&.GetPlaceById (stringid)"
.PP
Gets place by identifier\&.Stubbfel, 09\&.09\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIid\fP The identifier\&.
.RE
.PP
\fBReturns:\fP
.RS 4
The place by identifier\&.
.RE
.PP
.SS "List<\fBPlaceModel\fP> CampusAppWP8\&.Model\&.GeoDb\&.SpsModel\&.GetPlacesByInformation (stringquery, boolignoreCases = \fCtrue\fP, List< string >informationNames = \fCnull\fP)"
.PP
Gets places by information\&.Stubbfel, 19\&.08\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIquery\fP The query\&.
.br
\fIignoreCases\fP (Optional) the ignore cases\&.
.br
\fIinformationNames\fP (Optional) name of the information\&.
.RE
.PP
\fBReturns:\fP
.RS 4
The places by information\&.
.RE
.PP
.SH "Property Documentation"
.PP
.SS "bool CampusAppWP8\&.Model\&.GeoDb\&.SpsModel\&.HasChanged\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets a value indicating whether this object has changed\&.true if this object has changed, false if not\&.
.SS "ObservableCollection<\fBPlaceModel\fP> CampusAppWP8\&.Model\&.GeoDb\&.SpsModel\&.Places\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets a list of places
.SH "Author"
.PP
Generated automatically by Doxygen for CampusAppWp8 from the source code\&.