227 lines
5.3 KiB
Groff
227 lines
5.3 KiB
Groff
.TH "CampusAppWP8.Model.MainModel< T >" 3 "Fri Oct 11 2013" "CampusAppWp8" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
CampusAppWP8.Model.MainModel< T > \-
|
|
.PP
|
|
Base model io handling class\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
Inherits AbstractMainModel< T >\&.
|
|
.PP
|
|
Inherited by \fBCampusAppWP8\&.Model\&.BinaryModel\fP, and \fBCampusAppWP8\&.Model\&.XmlModel< T >\fP\&.
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBMainModel\fP (ModelType modelType, string fileName, string url)"
|
|
.br
|
|
.RI "\fIInitializes a new instance of the MainModel{T} class\&. \fP"
|
|
.ti -1c
|
|
.RI "\fBMainModel\fP (ModelType modelType, string sourceName)"
|
|
.br
|
|
.RI "\fIInitializes a new instance of the MainModel{T} class\&. \fP"
|
|
.ti -1c
|
|
.RI "delegate bool \fBIsFileUpToDate\fP (T model, FileInfo fileInfo)"
|
|
.br
|
|
.RI "\fIDelegate of the IsFileUpToDate callback function\&. \fP"
|
|
.in -1c
|
|
.SS "Protected Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "override bool \fBCheckLoadFileIsNotUpToDate\fP ()"
|
|
.br
|
|
.RI "\fIMethod overrides the base CheckLoadFileIsNotUpToDate Method \fP"
|
|
.ti -1c
|
|
.RI "override bool \fBCheckSaveFileIsNotUpToDate\fP ()"
|
|
.br
|
|
.RI "\fIMethod overrides the base CheckSaveFileIsNotUpToDate Method \fP"
|
|
.ti -1c
|
|
.RI "override void \fBSendHttpGet\fP (Uri url)"
|
|
.br
|
|
.RI "\fIMethod overrides the base SendHttpGet Method \fP"
|
|
.ti -1c
|
|
.RI "override void \fBInitFile\fP ()"
|
|
.br
|
|
.RI "\fIInitializes the file object\&. \fP"
|
|
.ti -1c
|
|
.RI "override void \fBInitHttpApi\fP ()"
|
|
.br
|
|
.RI "\fIInitializes the web object\&. \fP"
|
|
.ti -1c
|
|
.RI "override bool \fBCheckIsNotUpToDate\fP (object checkFunc)"
|
|
.br
|
|
.RI "\fICheck if model or file is not up to date\&.\fP"
|
|
.in -1c
|
|
.SS "Properties"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "new \fBCampusAppWP8\&.Utility\&.File\fP \fBFile\fP\fC [get, set]\fP"
|
|
.br
|
|
.RI "\fIGets or sets the file \fP"
|
|
.ti -1c
|
|
.RI "new \fBHttpRequest\fP \fBApi\fP\fC [get, set]\fP"
|
|
.br
|
|
.RI "\fIGets or sets the api \fP"
|
|
.in -1c
|
|
.SS "Events"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBIsFileUpToDate\fP \fBIsFileUpToDateOnLoad\fP = null"
|
|
.br
|
|
.RI "\fICallback pointer, for checking if file is up to date at loading\&. \fP"
|
|
.ti -1c
|
|
.RI "\fBIsFileUpToDate\fP \fBIsFileUpToDateOnSave\fP = null"
|
|
.br
|
|
.RI "\fICallback pointer, for checking if file is up to date at saving\&. \fP"
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Base model io handling class\&.
|
|
|
|
|
|
.PP
|
|
\fBTemplate Parameters:\fP
|
|
.RS 4
|
|
\fIT\fP model type
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "CampusAppWP8\&.Model\&.MainModel< T >\&.MainModel (ModelTypemodelType, stringfileName, stringurl)"
|
|
|
|
.PP
|
|
Initializes a new instance of the MainModel{T} class\&.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fImodelType\fP \fBModel\fP IO type
|
|
.br
|
|
\fIfileName\fP name of the file
|
|
.br
|
|
\fIurl\fP url of the feed
|
|
.RE
|
|
.PP
|
|
|
|
.SS "CampusAppWP8\&.Model\&.MainModel< T >\&.MainModel (ModelTypemodelType, stringsourceName)"
|
|
|
|
.PP
|
|
Initializes a new instance of the MainModel{T} class\&.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fImodelType\fP \fBModel\fP IO type
|
|
.br
|
|
\fIsourceName\fP name of the file or the url of the feed
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "override bool CampusAppWP8\&.Model\&.MainModel< T >\&.CheckIsNotUpToDate (objectcheckFunc)\fC [protected]\fP"
|
|
|
|
.PP
|
|
Check if model or file is not up to date\&.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fIcheckFunc\fP The check function\&.
|
|
.RE
|
|
.PP
|
|
\fBReturns:\fP
|
|
.RS 4
|
|
true if model or file is not up to date, false if it is\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SS "override bool CampusAppWP8\&.Model\&.MainModel< T >\&.CheckLoadFileIsNotUpToDate ()\fC [protected]\fP"
|
|
|
|
.PP
|
|
Method overrides the base CheckLoadFileIsNotUpToDate Method
|
|
.PP
|
|
\fBReturns:\fP
|
|
.RS 4
|
|
true if it is not up-to-date, otherwise false
|
|
.RE
|
|
.PP
|
|
|
|
.SS "override bool CampusAppWP8\&.Model\&.MainModel< T >\&.CheckSaveFileIsNotUpToDate ()\fC [protected]\fP"
|
|
|
|
.PP
|
|
Method overrides the base CheckSaveFileIsNotUpToDate Method
|
|
.PP
|
|
\fBReturns:\fP
|
|
.RS 4
|
|
true if it is not up-to-date, otherwise false
|
|
.RE
|
|
.PP
|
|
|
|
.SS "override void CampusAppWP8\&.Model\&.MainModel< T >\&.InitFile ()\fC [protected]\fP"
|
|
|
|
.PP
|
|
Initializes the file object\&.
|
|
.SS "override void CampusAppWP8\&.Model\&.MainModel< T >\&.InitHttpApi ()\fC [protected]\fP"
|
|
|
|
.PP
|
|
Initializes the web object\&.
|
|
.SS "delegate bool CampusAppWP8\&.Model\&.MainModel< T >\&.IsFileUpToDate (Tmodel, FileInfofileInfo)"
|
|
|
|
.PP
|
|
Delegate of the IsFileUpToDate callback function\&.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fImodel\fP data model
|
|
.br
|
|
\fIfileInfo\fP info of the file
|
|
.RE
|
|
.PP
|
|
\fBReturns:\fP
|
|
.RS 4
|
|
true, is file is up to date
|
|
.RE
|
|
.PP
|
|
|
|
.SS "override void CampusAppWP8\&.Model\&.MainModel< T >\&.SendHttpGet (Uriurl)\fC [protected]\fP"
|
|
|
|
.PP
|
|
Method overrides the base SendHttpGet Method
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fIurl\fP the url
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Property Documentation"
|
|
.PP
|
|
.SS "new \fBHttpRequest\fP CampusAppWP8\&.Model\&.MainModel< T >\&.Api\fC [get]\fP, \fC [set]\fP"
|
|
|
|
.PP
|
|
Gets or sets the api
|
|
.SS "new \fBCampusAppWP8\&.Utility\&.File\fP CampusAppWP8\&.Model\&.MainModel< T >\&.\fBFile\fP\fC [get]\fP, \fC [set]\fP"
|
|
|
|
.PP
|
|
Gets or sets the file
|
|
.SH "Event Documentation"
|
|
.PP
|
|
.SS "\fBIsFileUpToDate\fP CampusAppWP8\&.Model\&.MainModel< T >\&.IsFileUpToDateOnLoad = null"
|
|
|
|
.PP
|
|
Callback pointer, for checking if file is up to date at loading\&.
|
|
.SS "\fBIsFileUpToDate\fP CampusAppWP8\&.Model\&.MainModel< T >\&.IsFileUpToDateOnSave = null"
|
|
|
|
.PP
|
|
Callback pointer, for checking if file is up to date at saving\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for CampusAppWp8 from the source code\&.
|