Jypeli.FileManager luokkareferenssi

Luokan Jypeli.FileManager luokkakaavio

Luokat
class	AsyncOperation
class	AsyncTrigger

Julkiset jäsenfunktiot
	FileManager (params string[] pathCandidates)
LoadState	BeginLoad (string fileName)
LoadState	BeginLoadContent (string assetName)
SaveState	BeginSave (string tag)
virtual bool	ChDir (string path)
	Vaihtaa työhakemistoa. Lisää...
StorageFile	Create (string fileName)
	Luo uuden tiedoston Lisää...
virtual void	Delete (string fileName)
	Poistaa tiedoston. Ei heitä poikkeusta, jos tiedostoa ei ole olemassa. Lisää...
AsyncOperation	DoWith (string fileName, Action< StorageFile > callback)
	Avaa tiedoston (lukua varten) ja tekee sillä jotain. Lisää...
AsyncOperation	DoWithURL (string url, Action< StorageFile > callback)
	Avaa tiedoston netistä (lukua varten) ja tekee sillä jotain. Lisää...
AsyncOperation	DoWithURL (string url, TimeSpan timeout, Action< StorageFile > callback)
	Avaa tiedoston netistä (lukua varten) ja tekee sillä jotain. Lisää...
virtual bool	Exists (string fileName)
	Kertoo onko tiedosto tai hakemisto olemassa. Lisää...
void	Export (Stream objStream, string fileName)
	Vie virran sisällön tiedostoon. Lisää...
virtual IList< string >	GetFileList ()
	Antaa listan nykyisessä hakemistossa olevista tiedostoista. Lisää...
T	Load< T > (T obj, string fileName)
T	LoadContent< T > (T obj, string assetName)
virtual void	MkDir (string path)
	Luo uuden hakemiston. Lisää...
virtual StorageFile	Open (string fileName, bool write)
	Avaa tiedoston. Lisää...
void	PopDir ()
	Palauttaa edellisen työhakemiston. Jos edellistö työhakemistoa ei ole tallennettu, säilytetään nykyinen. Lisää...
void	PushDir (string dir)
	Vaihtaa työhakemistoa jättäen edellisen hakemiston muistiin. Kutsu PopDir kun haluat palauttaa työhakemiston edelliseen arvoonsa. Lisää...
virtual void	RmDir (string path)
	Tuhoaa hakemiston. Heittää poikkeuksen jos hakemisto ei ole tyhjä. Ei heitä poikkeusta, jos hakemistoa ei ole olemassa. Lisää...
void	Save (object obj, string fileName)
void	Save< T > (T obj, string fileName)
void	TriggerOnComplete (Action callback, params AsyncOperation[] actions)
	Laukaisee aliohjelman kun annetut operaatiot on suoritettu. Lisää...
void	TriggerOnComplete (Action callback, TimeSpan timeout, params AsyncOperation[] actions)
	Laukaisee aliohjelman kun annetut operaatiot on suoritettu. Lisää...
T	TryLoad< T > (T obj, string fileName)
void	TrySave (object obj, string fileName)
void	TrySave< T > (T obj, string fileName)
void	Update (Time time)
	Päivitysfunktio Lisää...

Suojatut jäsenfunktiot
void	FMAssert (Action func, bool write)
void	FMAssert< TP1 > (Action< TP1 > func, bool write, TP1 p1)
TR	FMAssert< TP1, TP2, TR > (Func< TP1, TP2, TR > func, bool write, TR defaultVal, TP1 p1, TP2 p2)
TR	FMAssert< TP1, TR > (Func< TP1, TR > func, bool write, TR defaultVal, TP1 p1)
TR	FMAssert< TR > (Func< TR > func, bool write, TR defaultVal)
void	Initialize ()

Suojellut attribuutit
string	_currentDir
string[]	pathCandidates

Paketin funktiot
LoadState	BeginLoad (StorageFile file, string fileName)
void	MakeAbsolute (ref string path)

Paketin staattiset funktiot
static string	SanitizeFileName (string fileName)

Ominaisuudet
string	CurrentDirectory [getset]
	Nykyinen työhakemisto. Lisää...
bool	IsUpdated [get]
Ominaisuudet inherited from Jypeli.Updatable
bool	IsUpdated [get]
	Ajetaanko oliolle päivitystä Lisää...

Tapahtumat
Action< Exception >	ReadAccessDenied
Action< Exception >	WriteAccessDenied

Yksityiset jäsenfunktiot
void	DoWithCallback (IAsyncResult ar)
void	OnAccessDenied (Exception e, bool write)
Stream	openFileStream (string fileName, bool write)

Yksityiset attribuutit
Stack< string >	prevDirs = new Stack<string>()
SynchronousList< AsyncTrigger >	triggers = new SynchronousList<AsyncTrigger>()

Yksityiskohtainen selite

Määrittely tiedoston Assert.cs rivillä 5.

Rakentajien & purkajien dokumentaatio

FileManager()

Jypeli.FileManager.FileManager

(

params string[]

pathCandidates

)

Määrittely tiedoston FileManager.cs rivillä 12.

Viittaukset Jypeli.FileManager.pathCandidates.

Jäsenfunktioiden dokumentaatio

BeginLoad() [1/2]

LoadState Jypeli.FileManager.BeginLoad ( StorageFile  file, string  fileName  )

package

Määrittely tiedoston Serialization.cs rivillä 13.

BeginLoad() [2/2]

LoadState Jypeli.FileManager.BeginLoad

(

string

fileName

)

Määrittely tiedoston Serialization.cs rivillä 8.

Viitattu Jypeli.FileManager.Load< T >() ja Jypeli.FileManager.LoadContent< T >().

BeginLoadContent()

LoadState Jypeli.FileManager.BeginLoadContent

(

string

assetName

)

Määrittely tiedoston XnaSerialization.cs rivillä 12.

Viittaukset Jypeli.Game.Instance.

BeginSave()

SaveState Jypeli.FileManager.BeginSave

(

string

tag

)

Määrittely tiedoston Serialization.cs rivillä 18.

Viitattu Jypeli.FileManager.Save() ja Jypeli.FileManager.Save< T >().

ChDir()

virtual bool Jypeli.FileManager.ChDir ( string  path )

virtual

Vaihtaa työhakemistoa.

Parametrit

path	Hakemistopolku.

Palauttaa

Onnistuiko hakemiston vaihtaminen (palauttaa false jos hakemistoa ei ole).

Määrittely tiedoston Directories.cs rivillä 47.

Viittaukset Jypeli.FileManager._currentDir, Jypeli.FileManager.FMAssert(), Jypeli.FileManager.Initialize() ja Jypeli.FileManager.MakeAbsolute().

Viitattu Jypeli.FileManager.PushDir().

Create()

StorageFile Jypeli.FileManager.Create

(

string

fileName

)

Luo uuden tiedoston

Parametrit

fileName

Palauttaa

Määrittely tiedoston Files.cs rivillä 13.

Viittaukset Jypeli.FileManager.Open().

Viitattu Jypeli.FileManager.Export().

Delete()

virtual void Jypeli.FileManager.Delete ( string  fileName )

virtual

Poistaa tiedoston. Ei heitä poikkeusta, jos tiedostoa ei ole olemassa.

Parametrit

fileName

Tiedoston nimi

Määrittely tiedoston Files.cs rivillä 56.

Viittaukset Jypeli.FileManager.FMAssert(), Jypeli.FileManager.Initialize() ja Jypeli.FileManager.MakeAbsolute().

DoWith()

AsyncOperation Jypeli.FileManager.DoWith	(	string	fileName,
		Action< StorageFile >	callback
	)

Avaa tiedoston (lukua varten) ja tekee sillä jotain.

Parametrit

fileName	Tiedoston nimi
callback	Mitä tehdään (aliohjelman nimi)

{ DoWith( "kuva.png", AsetaKuva ); }

void AsetaKuva( StorageFile kuva ) { olio.Image = new Image( kuva ); }

Määrittely tiedoston HTTP.cs rivillä 107.

Viittaukset Jypeli.FileManager.Open().

DoWithCallback()

void Jypeli.FileManager.DoWithCallback ( IAsyncResult  ar )

private

Määrittely tiedoston HTTP.cs rivillä 167.

Viittaukset Jypeli.FileManager.AsyncOperation.Callback, Jypeli.FileManager.AsyncOperation.Request ja Jypeli.FileManager.triggers.

Viitattu Jypeli.FileManager.DoWithURL().

DoWithURL() [1/2]

AsyncOperation Jypeli.FileManager.DoWithURL	(	string	url,
		Action< StorageFile >	callback
	)

Avaa tiedoston netistä (lukua varten) ja tekee sillä jotain.

Parametrit

url	Nettiosoite
callback	Mitä tehdään (aliohjelman nimi)

{ DoWith( "http://www.google.fi/images/srpr/logo3w.png", AsetaKuva ); }

void AsetaKuva( StorageFile kuva ) { olio.Image = new Image( kuva ); }

Määrittely tiedoston HTTP.cs rivillä 132.

Viittaukset Jypeli.FileManager.DoWithCallback() ja Jypeli.FileManager.AsyncOperation.Result.

DoWithURL() [2/2]

AsyncOperation Jypeli.FileManager.DoWithURL	(	string	url,
		TimeSpan	timeout,
		Action< StorageFile >	callback
	)

Avaa tiedoston netistä (lukua varten) ja tekee sillä jotain.

Parametrit

url	Nettiosoite
timeout	Paljonko aikaa tiedoston lataamiselle annetaan. Mikäli lataaminen ei onnistu annetussa ajassa, se keskeytetään.
callback	Mitä tehdään (aliohjelman nimi)

{ DoWith( "http://www.google.fi/images/srpr/logo3w.png", AsetaKuva ); }

void AsetaKuva( StorageFile kuva ) { olio.Image = new Image( kuva ); }

Määrittely tiedoston HTTP.cs rivillä 158.

Viittaukset Jypeli.FileManager.DoWithCallback() ja Jypeli.FileManager.AsyncOperation.Result.

Exists()

virtual bool Jypeli.FileManager.Exists ( string  fileName )

virtual

Kertoo onko tiedosto tai hakemisto olemassa.

Parametrit

fileName

Tiedoston tai hakemiston nimi

Palauttaa

Onko olemassa

Määrittely tiedoston Files.cs rivillä 23.

Viittaukset Jypeli.FileManager.FMAssert(), Jypeli.FileManager.Initialize() ja Jypeli.FileManager.MakeAbsolute().

Viitattu Jypeli.FileManager.Load< T >().

Export()

void Jypeli.FileManager.Export	(	Stream	objStream,
		string	fileName
	)

Vie virran sisällön tiedostoon.

Parametrit

objStream	Virta
fileName	Tiedoston nimi

Määrittely tiedoston Serialization.cs rivillä 87.

Viittaukset Jypeli.FileManager.Create().

FMAssert()

void Jypeli.FileManager.FMAssert ( Action  func, bool  write  )

protected

Määrittely tiedoston Assert.cs rivillä 18.

Viittaukset Jypeli.FileManager.OnAccessDenied().

Viitattu Jypeli.FileManager.ChDir(), Jypeli.FileManager.Delete(), Jypeli.FileManager.Exists(), Jypeli.FileManager.GetFileList(), Jypeli.FileManager.MkDir() ja Jypeli.FileManager.RmDir().

FMAssert< TP1 >()

void Jypeli.FileManager.FMAssert< TP1 > ( Action< TP1 >  func, bool  write, TP1  p1  )

protected

Määrittely tiedoston Assert.cs rivillä 34.

Viittaukset Jypeli.FileManager.OnAccessDenied().

FMAssert< TP1, TP2, TR >()

TR Jypeli.FileManager.FMAssert< TP1, TP2, TR > ( Func< TP1, TP2, TR >  func, bool  write, TR  defaultVal, TP1  p1, TP2  p2  )

protected

Määrittely tiedoston Assert.cs rivillä 86.

Viittaukset Jypeli.FileManager.OnAccessDenied().

FMAssert< TP1, TR >()

TR Jypeli.FileManager.FMAssert< TP1, TR > ( Func< TP1, TR >  func, bool  write, TR  defaultVal, TP1  p1  )

protected

Määrittely tiedoston Assert.cs rivillä 68.

Viittaukset Jypeli.FileManager.OnAccessDenied().

FMAssert< TR >()

TR Jypeli.FileManager.FMAssert< TR > ( Func< TR >  func, bool  write, TR  defaultVal  )

protected

Määrittely tiedoston Assert.cs rivillä 50.

Viittaukset Jypeli.FileManager.OnAccessDenied().

GetFileList()

virtual IList< string > Jypeli.FileManager.GetFileList ( )

virtual

Antaa listan nykyisessä hakemistossa olevista tiedostoista.

Palauttaa

Määrittely tiedoston Directories.cs rivillä 86.

Viittaukset Jypeli.FileManager._currentDir, Jypeli.FileManager.FMAssert() ja Jypeli.FileManager.Initialize().

Initialize()

void Jypeli.FileManager.Initialize ( )

protected

Määrittely tiedoston FileManager.cs rivillä 17.

Viittaukset Jypeli.FileManager._currentDir ja Jypeli.FileManager.pathCandidates.

Viitattu Jypeli.FileManager.ChDir(), Jypeli.FileManager.Delete(), Jypeli.FileManager.Exists(), Jypeli.FileManager.GetFileList(), Jypeli.FileManager.MkDir(), Jypeli.FileManager.Open() ja Jypeli.FileManager.RmDir().

Load< T >()

T Jypeli.FileManager.Load< T >	(	T	obj,
		string	fileName
	)

Määrittely tiedoston Serialization.cs rivillä 23.

Viittaukset Jypeli.FileManager.BeginLoad(), Jypeli.LoadState.EndLoad(), Jypeli.FileManager.Exists(), Jypeli.LoadState.Load() ja Jypeli.T.

Viitattu Jypeli.FileManager.TryLoad< T >().

LoadContent< T >()

T Jypeli.FileManager.LoadContent< T >	(	T	obj,
		string	assetName
	)

Määrittely tiedoston XnaSerialization.cs rivillä 21.

Viittaukset Jypeli.FileManager.BeginLoad(), Jypeli.LoadState.EndLoad(), Jypeli.Game.Instance, Jypeli.LoadState.Load() ja Jypeli.T.

MakeAbsolute()

void Jypeli.FileManager.MakeAbsolute ( ref string  path )

package

Määrittely tiedoston NameHelpers.cs rivillä 24.

Viittaukset Jypeli.FileManager._currentDir.

Viitattu Jypeli.FileManager.ChDir(), Jypeli.FileManager.Delete(), Jypeli.FileManager.Exists(), Jypeli.FileManager.MkDir(), Jypeli.FileManager.Open() ja Jypeli.FileManager.RmDir().

MkDir()

virtual void Jypeli.FileManager.MkDir ( string  path )

virtual

Luo uuden hakemiston.

Parametrit

path	Hakemistopolku.

Määrittely tiedoston Directories.cs rivillä 63.

Viittaukset Jypeli.FileManager.FMAssert(), Jypeli.FileManager.Initialize() ja Jypeli.FileManager.MakeAbsolute().

OnAccessDenied()

void Jypeli.FileManager.OnAccessDenied ( Exception  e, bool  write  )

private

Määrittely tiedoston Assert.cs rivillä 10.

Viittaukset Jypeli.FileManager.ReadAccessDenied ja Jypeli.FileManager.WriteAccessDenied.

Viitattu Jypeli.FileManager.FMAssert(), Jypeli.FileManager.FMAssert< TP1 >(), Jypeli.FileManager.FMAssert< TP1, TP2, TR >(), Jypeli.FileManager.FMAssert< TP1, TR >() ja Jypeli.FileManager.FMAssert< TR >().

Open()

virtual StorageFile Jypeli.FileManager.Open ( string  fileName, bool  write  )

virtual

Avaa tiedoston.

Parametrit

fileName	Tiedoston nimi.
write	Tarvitaanko tiedostoon kirjoitusoikeus.

Palauttaa

StorageFile-olio

Määrittely tiedoston Files.cs rivillä 36.

Viittaukset Jypeli.FileManager.Initialize(), Jypeli.FileManager.MakeAbsolute() ja Jypeli.FileManager.openFileStream().

Viitattu Jypeli.LoadState.LoadState(), Jypeli.SaveState.SaveState(), Jypeli.FileManager.Create(), Jypeli.FileManager.DoWith() ja Jypeli.LoadState.ResetFile().

openFileStream()

Stream Jypeli.FileManager.openFileStream ( string  fileName, bool  write  )

private

Määrittely tiedoston Files.cs rivillä 44.

Viitattu Jypeli.FileManager.Open().

PopDir()

void Jypeli.FileManager.PopDir

(

)

Palauttaa edellisen työhakemiston. Jos edellistö työhakemistoa ei ole tallennettu, säilytetään nykyinen.

Määrittely tiedoston Directories.cs rivillä 36.

Viittaukset Jypeli.FileManager._currentDir ja Jypeli.FileManager.prevDirs.

PushDir()

void Jypeli.FileManager.PushDir

(

string

dir

)

Vaihtaa työhakemistoa jättäen edellisen hakemiston muistiin. Kutsu PopDir kun haluat palauttaa työhakemiston edelliseen arvoonsa.

Parametrit

dir

Määrittely tiedoston Directories.cs rivillä 26.

Viittaukset Jypeli.FileManager._currentDir, Jypeli.FileManager.ChDir() ja Jypeli.FileManager.prevDirs.

RmDir()

virtual void Jypeli.FileManager.RmDir ( string  path )

virtual

Tuhoaa hakemiston. Heittää poikkeuksen jos hakemisto ei ole tyhjä. Ei heitä poikkeusta, jos hakemistoa ei ole olemassa.

Parametrit

path

Määrittely tiedoston Directories.cs rivillä 75.

Viittaukset Jypeli.FileManager.FMAssert(), Jypeli.FileManager.Initialize() ja Jypeli.FileManager.MakeAbsolute().

SanitizeFileName()

static string Jypeli.FileManager.SanitizeFileName ( string  fileName )

staticpackage

Määrittely tiedoston NameHelpers.cs rivillä 9.

Save()

void Jypeli.FileManager.Save	(	object	obj,
		string	fileName
	)

Määrittely tiedoston Serialization.cs rivillä 64.

Viittaukset Jypeli.FileManager.BeginSave(), Jypeli.SaveState.EndSave() ja Jypeli.SaveState.Save().

Viitattu Jypeli.Widgets.EasyHighScore.Clear(), Jypeli.Widgets.EasyHighScore.SaveData() ja Jypeli.FileManager.TrySave().

Save< T >()

void Jypeli.FileManager.Save< T >	(	T	obj,
		string	fileName
	)

Määrittely tiedoston Serialization.cs rivillä 46.

Viittaukset Jypeli.FileManager.BeginSave(), Jypeli.SaveState.EndSave(), Jypeli.SaveState.Save() ja Jypeli.T.

Viitattu Jypeli.FileManager.TrySave< T >().

TriggerOnComplete() [1/2]

void Jypeli.FileManager.TriggerOnComplete	(	Action	callback,
		params AsyncOperation[]	actions
	)

Laukaisee aliohjelman kun annetut operaatiot on suoritettu.

Parametrit

callback	Aliohjelma
actions	Operaatiot

Määrittely tiedoston HTTP.cs rivillä 204.

Viittaukset Jypeli.Game.Time, Jypeli.FileManager.triggers ja Jypeli.Time.Zero.

TriggerOnComplete() [2/2]

void Jypeli.FileManager.TriggerOnComplete	(	Action	callback,
		TimeSpan	timeout,
		params AsyncOperation[]	actions
	)

Laukaisee aliohjelman kun annetut operaatiot on suoritettu.

Parametrit

callback	Aliohjelma
timeout	Kuinka pitkään odotetaan yksittäistä operaatiota ennen kuin luovutetaan
actions	Operaatiot

Määrittely tiedoston HTTP.cs rivillä 221.

Viittaukset Jypeli.Game.Time, Jypeli.FileManager.triggers ja Jypeli.Time.Zero.

TryLoad< T >()

T Jypeli.FileManager.TryLoad< T >	(	T	obj,
		string	fileName
	)

Määrittely tiedoston Serialization.cs rivillä 34.

Viittaukset Jypeli.FileManager.Load< T >() ja Jypeli.T.

TrySave()

void Jypeli.FileManager.TrySave	(	object	obj,
		string	fileName
	)

Määrittely tiedoston Serialization.cs rivillä 71.

Viittaukset Jypeli.FileManager.Save().

TrySave< T >()

void Jypeli.FileManager.TrySave< T >	(	T	obj,
		string	fileName
	)

Määrittely tiedoston Serialization.cs rivillä 53.

Viittaukset Jypeli.FileManager.Save< T >().

Update()

void Jypeli.FileManager.Update

(

Time

time

)

Päivitysfunktio

Parametrit

time	Kulunut aika edellisestä päivityksestä

Toteuttaa luokan Jypeli.Updatable.

Määrittely tiedoston HTTP.cs rivillä 66.

Viittaukset Jypeli.FileManager.triggers.

Jäsendatan dokumentaatio

_currentDir

string Jypeli.FileManager._currentDir

protected

Määrittely tiedoston Directories.cs rivillä 10.

Viitattu Jypeli.FileManager.ChDir(), Jypeli.FileManager.GetFileList(), Jypeli.FileManager.Initialize(), Jypeli.FileManager.MakeAbsolute(), Jypeli.FileManager.PopDir() ja Jypeli.FileManager.PushDir().

pathCandidates

string [] Jypeli.FileManager.pathCandidates

protected

Määrittely tiedoston FileManager.cs rivillä 10.

Viitattu Jypeli.FileManager.FileManager() ja Jypeli.FileManager.Initialize().

prevDirs

Stack<string> Jypeli.FileManager.prevDirs = new Stack<string>()

private

Määrittely tiedoston Directories.cs rivillä 9.

Viitattu Jypeli.FileManager.PopDir() ja Jypeli.FileManager.PushDir().

triggers

SynchronousList<AsyncTrigger> Jypeli.FileManager.triggers = new SynchronousList<AsyncTrigger>()

private

Määrittely tiedoston HTTP.cs rivillä 59.

Viitattu Jypeli.FileManager.DoWithCallback(), Jypeli.FileManager.TriggerOnComplete() ja Jypeli.FileManager.Update().

Ominaisuuksien dokumentaatio

CurrentDirectory

string Jypeli.FileManager.CurrentDirectory

getset

Nykyinen työhakemisto.

Määrittely tiedoston Directories.cs rivillä 15.

IsUpdated

bool Jypeli.FileManager.IsUpdated

get

Määrittely tiedoston HTTP.cs rivillä 61.

Tapahtumien dokumentaatio

ReadAccessDenied

Action<Exception> Jypeli.FileManager.ReadAccessDenied

Määrittely tiedoston Assert.cs rivillä 7.

Viitattu Jypeli.FileManager.OnAccessDenied().

WriteAccessDenied

Action<Exception> Jypeli.FileManager.WriteAccessDenied

Määrittely tiedoston Assert.cs rivillä 8.

Viitattu Jypeli.FileManager.OnAccessDenied().

---

Dokumentaatio tälle luokalle luotiin seuraavista tiedostoista:

• C:/Users/Mikko/Desktop/Jypeli/Jypeli/Storage/FileManager/Assert.cs
• C:/Users/Mikko/Desktop/Jypeli/Jypeli/Storage/FileManager/Directories.cs
• C:/Users/Mikko/Desktop/Jypeli/Jypeli/Storage/FileManager/FileManager.cs
• C:/Users/Mikko/Desktop/Jypeli/Jypeli/Storage/FileManager/HTTP.cs
• C:/Users/Mikko/Desktop/Jypeli/Jypeli/Storage/FileManager/Files.cs
• C:/Users/Mikko/Desktop/Jypeli/Jypeli/Storage/FileManager/NameHelpers.cs
• C:/Users/Mikko/Desktop/Jypeli/Jypeli/Storage/FileManager/Serialization.cs
• C:/Users/Mikko/Desktop/Jypeli/Jypeli/Storage/FileManager/XnaSerialization.cs