File: lsvariable.h

package info (click to toggle)
aethera 0.9.3-7
  • links: PTS
  • area: main
  • in suites: woody
  • size: 8,588 kB
  • ctags: 7,282
  • sloc: cpp: 64,544; sh: 9,913; perl: 1,756; makefile: 1,680; python: 258
file content (113 lines) | stat: -rw-r--r-- 3,692 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/**
 * This file is part of Magellan <http://www.kAlliance.org/Magellan>
 *
 * Copyright (c) 1998-2000 Teodor Mihai <teddy@ireland.com>
 * Copyright (c) 1998-2000 Laur Ivan <laur.ivan@ul.ie>
 * Copyright (c) 1999-2000 Virgil Palanciuc <vv@ulise.cs.pub.ro>
 *
 * Requires the Qt widget libraries, available at no cost at
 * http://www.troll.no/
 *
 * Also requires the KDE libraries, available at no cost at
 * http://www.kde.org/
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
 * copies of the Software, and to permit persons to whom the Software is 
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in 
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS 
 * IN THE SOFTWARE.
 */

#ifndef __Variable__
#define __Variable__

#include <qstring.h>

/***
*	Variable
* @short Class for storing a variable's characteristics.
*/
class Variable
{
	QString name;
	QString value;
	QString type;
	bool input;
public:
	/** 
	 *   Constructor
	 * @param n the variable's name
	 * @param v the variable's value
	 * @param t the variable's type
	 */
	Variable(QString n=QString::null, 
		QString v=QString::null,
		QString t=QString::null);
	/** 
	 *   Method for accessing the variable's fields.
	 * @return the variable's name.
	 */
	QString getName()	{ return name; }
	/** 
	 *   Method for accessing the variable's fields.
	 * @return the variable's value.
	 */
	QString getValue() { return value; }
	/** 
	 *   Method for accessing the variable's fields.
	 * @return the variable's type.
	 */
	QString getType() { return type; }
	/** 
	 *   Method for accessing the variable's fields.
	 * @return true if the variable has to be refreshed by the user. False
	 * otherwise
	 */
	bool getInput() { return input; }
	/** 
	 *   Method for accessing the variable's fields.
	 * @param newName the variable's new name.
	 */
	void setName(QString newName) { name=newName; }
	/** 
	 *   Method for accessing the variable's fields.
	 * @param newValue the variable's new value.
	 */
	void setValue(QString newValue) { value=newValue; }
	/** 
	 *   Method for accessing the variable's fields.
	 * @param newType the variable's new type.
	 */
	void setType(QString newType) { type=newType; }
	/** 
	 *   Method for accessing the variable's fields.
	 * @param newInput the variable's new input.
	 */
	void setInput(bool newInput) { input=newInput; }
	/** 
	 *   Method for testing if a variable matches some criteria.
	 * @param testName the variable's desired name.
	 * @param testType the variable's desired type.
	 * @param testValue the variable's desired value.
	 * @return true if the variable's fields matches the parameters.
	 * A NULL field is ignored. The name *HAS* to be not void. If the name is
	 * NULL, the function returns FALSE.
	 */
	bool match(QString testName=QString::null, 
		QString testType=QString::null, 
		QString testValue=QString::null);
};

#endif