tomh/ns-3-dev-spectrum-wifi: src/core/system-file.h@663120712cd9 (annotated)

150 663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	1	/* -- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -- */
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	2	/*
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	3	* Copyright (c) 2005 INRIA
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	4	* All rights reserved.
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	5	*
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	6	* This program is free software; you can redistribute it and/or modify
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	7	* it under the terms of the GNU General Public License version 2 as
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	8	* published by the Free Software Foundation;
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	9	*
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	10	* This program is distributed in the hope that it will be useful,
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	13	* GNU General Public License for more details.
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	14	*
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	15	* You should have received a copy of the GNU General Public License
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	16	* along with this program; if not, write to the Free Software
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	17	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	18	*
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	19	* Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	20	*/
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	21
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	22	#ifndef SYSTEM_FILE_H
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	23	#define SYSTEM_FILE_H
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	24
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	25	#include <stdint.h>
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	26
16 99e833adbb46 change yans namespace to ns3 Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 9 diff changeset	27	namespace ns3 {
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	28
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	29	class SystemFilePrivate;
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	30
57 9385fba1589e add doc target to BUILD file Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 54 diff changeset	31	/**
9385fba1589e add doc target to BUILD file Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 54 diff changeset	32	* \brief os-independent file creation and writing
9385fba1589e add doc target to BUILD file Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 54 diff changeset	33	*
9385fba1589e add doc target to BUILD file Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 54 diff changeset	34	* Create a file and write data to this file.
9385fba1589e add doc target to BUILD file Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 54 diff changeset	35	*/
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	36	class SystemFile {
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	37	public:
150 663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	38	/**
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	39	* This method does not create or open any
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	40	* file on disk.
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	41	*/
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	42	SystemFile ();
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	43	/**
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	44	* If a file has been opened, it is closed by
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	45	* this destructor.
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	46	*/
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	47	~SystemFile ();
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	48
150 663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	49	/**
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	50	* \param filename name of file to open
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	51	*
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	52	* Open a file for writing. If the file does not
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	53	* exist, it is created. If it exists, it is
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	54	* emptied first.
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	55	*/
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	56	void Open (char const *filename);
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	57	/**
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	58	* \param buffer data to write
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	59	* \param size size of data to write
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	60	*
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	61	* Write data in file on disk. This method cannot fail:
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	62	* it will write _all_ the data to disk. This method does not
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	63	* perform any data caching and forwards the data
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	64	* to the OS through a direct syscall. However,
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	65	* it is not possible to rely on the data being
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	66	* effectively written to disk after this method returns.
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	67	* To make sure the data is written to disk, destroy
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	68	* this object.
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	69	*/
663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	70	void Write (uint8_t const*buffer, uint32_t size);
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	71	private:
150 663120712cd9 fix coding style Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 131 diff changeset	72	SystemFilePrivate *m_priv;
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	73	};
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	74
16 99e833adbb46 change yans namespace to ns3 Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 9 diff changeset	75	}; //namespace ns3
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	76
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	77	#endif /* SYSTEM_FILE_H */

author	Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
	Wed, 01 Nov 2006 13:11:30 +0100
changeset 150	663120712cd9
parent 131	f4fb87e77034
permissions	-rw-r--r--