Files
win8phoneApp/Doc/man/man3/CampusAppWP8_Model_GeoDb_PlaceModel.3
2013-10-18 09:32:53 +02:00

228 lines
5.7 KiB
Groff

.TH "CampusAppWP8.Model.GeoDb.PlaceModel" 3 "Fri Oct 18 2013" "Version 1.0.0" "CampusAppW8" \" -*- nroff -*-
.ad l
.nh
.SH NAME
CampusAppWP8.Model.GeoDb.PlaceModel \-
.PP
\fBModel\fP for a place of the SPSService\&.
.SH SYNOPSIS
.br
.PP
.PP
Inherits IEquatable< PlaceModel >\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "string \fBToNfcString\fP ()"
.br
.RI "\fIConverts this object to a nfc string\&. \fP"
.ti -1c
.RI "bool \fBEquals\fP (\fBPlaceModel\fP other)"
.br
.RI "\fITests if this \fBPlaceModel\fP is considered equal to another\&. \fP"
.ti -1c
.RI "void \fBAddPlaceInformations\fP (List< \fBPlaceInformation\fP > placeInformations)"
.br
.RI "\fIAdds a place information\&. \fP"
.ti -1c
.RI "void \fBAddPlaceServices\fP (List< \fBPlaceService\fP > placeServices)"
.br
.RI "\fIAdds a place services\&. \fP"
.ti -1c
.RI "bool \fBContainsInformationNames\fP (List< string > names)"
.br
.RI "\fIQuery if 'names' contains information names\&. \fP"
.ti -1c
.RI "bool \fBContainsServiceNames\fP (List< string > services)"
.br
.RI "\fIQuery if 'services' contains service names\&. \fP"
.ti -1c
.RI "string \fBGetInformationsValue\fP (string key)"
.br
.RI "\fIMethod gets the InformationValue of a certain InformationName\&. \fP"
.in -1c
.SS "Properties"
.in +1c
.ti -1c
.RI "string \fBPlaceId\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets the placeId\&. \fP"
.ti -1c
.RI "string \fBParentId\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets the id of the 'parent' of a place\&. \fP"
.ti -1c
.RI "string \fBRefPoint\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets the ReferencePoint of a place\&. \fP"
.ti -1c
.RI "GeoCoordinate \fBGeoRefPoint\fP\fC [get]\fP"
.br
.RI "\fIGets the geo reference point\&. \fP"
.ti -1c
.RI "ObservableCollection
.br
< \fBPlaceInformation\fP > \fBInformations\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets the information\&. \fP"
.ti -1c
.RI "ObservableCollection
.br
< \fBPlaceService\fP > \fBServices\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets the services\&. \fP"
.ti -1c
.RI "string \fBCaption\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets a string, which is the caption of the place (e\&.g\&. for contents of UIElements) \fP"
.in -1c
.SH "Detailed Description"
.PP
\fBModel\fP for a place of the SPSService\&.
Stubbfel, 15\&.10\&.2013\&.
.PP
\fBSee Also:\fP
.RS 4
T:System\&.IEquatable{CampusAppWP8\&.Model\&.GeoDb\&.PlaceModel}
.PP
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void CampusAppWP8\&.Model\&.GeoDb\&.PlaceModel\&.AddPlaceInformations (List< \fBPlaceInformation\fP >placeInformations)"
.PP
Adds a place information\&. Stubbfel, 09\&.09\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIplaceInformations\fP The place information\&.
.RE
.PP
.SS "void CampusAppWP8\&.Model\&.GeoDb\&.PlaceModel\&.AddPlaceServices (List< \fBPlaceService\fP >placeServices)"
.PP
Adds a place services\&. Stubbfel, 09\&.09\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIplaceServices\fP The place services\&.
.RE
.PP
.SS "bool CampusAppWP8\&.Model\&.GeoDb\&.PlaceModel\&.ContainsInformationNames (List< string >names)"
.PP
Query if 'names' contains information names\&. Stubbfel, 09\&.09\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\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\&.PlaceModel\&.ContainsServiceNames (List< string >services)"
.PP
Query if 'services' contains service names\&. Stubbfel, 09\&.09\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIservices\fP The services\&.
.RE
.PP
\fBReturns:\fP
.RS 4
true if it succeeds, false if it fails\&.
.RE
.PP
.SS "bool CampusAppWP8\&.Model\&.GeoDb\&.PlaceModel\&.Equals (\fBPlaceModel\fPother)"
.PP
Tests if this \fBPlaceModel\fP is considered equal to another\&. Stubbfel, 09\&.09\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIother\fP The place model to compare to this object\&.
.RE
.PP
\fBReturns:\fP
.RS 4
true if the objects are considered equal, false if they are not\&.
.RE
.PP
.SS "string CampusAppWP8\&.Model\&.GeoDb\&.PlaceModel\&.GetInformationsValue (stringkey)"
.PP
Method gets the InformationValue of a certain InformationName\&. Stubbfel, 15\&.10\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP string for InformationName\&.
.RE
.PP
\fBReturns:\fP
.RS 4
value of the information\&.
.RE
.PP
.SS "string CampusAppWP8\&.Model\&.GeoDb\&.PlaceModel\&.ToNfcString ()"
.PP
Converts this object to a nfc string\&. Stubbfel, 21\&.08\&.2013\&.
.PP
\fBReturns:\fP
.RS 4
This object as a string\&.
.RE
.PP
.SH "Property Documentation"
.PP
.SS "string CampusAppWP8\&.Model\&.GeoDb\&.PlaceModel\&.Caption\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets a string, which is the caption of the place (e\&.g\&. for contents of UIElements) The caption\&.
.SS "GeoCoordinate CampusAppWP8\&.Model\&.GeoDb\&.PlaceModel\&.GeoRefPoint\fC [get]\fP"
.PP
Gets the geo reference point\&. The geo reference point\&.
.SS "ObservableCollection<\fBPlaceInformation\fP> CampusAppWP8\&.Model\&.GeoDb\&.PlaceModel\&.Informations\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the information\&. The information\&.
.SS "string CampusAppWP8\&.Model\&.GeoDb\&.PlaceModel\&.ParentId\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the id of the 'parent' of a place\&. The identifier of the parent\&.
.SS "string CampusAppWP8\&.Model\&.GeoDb\&.PlaceModel\&.PlaceId\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the placeId\&. The identifier of the place\&.
.SS "string CampusAppWP8\&.Model\&.GeoDb\&.PlaceModel\&.RefPoint\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the ReferencePoint of a place\&. The reference point\&.
.SS "ObservableCollection<\fBPlaceService\fP> CampusAppWP8\&.Model\&.GeoDb\&.PlaceModel\&.Services\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the services\&. The services\&.
.SH "Author"
.PP
Generated automatically by Doxygen for CampusAppW8 from the source code\&.