UnaryLogicOp.h
Go to the documentation of this file.
1 /* Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
2 
3  This file is part of the TerraLib - a Framework for building GIS enabled applications.
4 
5  TerraLib is free software: you can redistribute it and/or modify
6  it under the terms of the GNU Lesser General Public License as published by
7  the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  TerraLib is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public License
16  along with TerraLib. See COPYING. If not, write to
17  TerraLib Team at <terralib-team@terralib.org>.
18  */
19 
20 /*!
21  \file UnaryLogicOp.h
22 
23  \brief A logical operator that can be used to combine one conditional expressions.
24  */
25 
26 #ifndef __TERRALIB_FE_INTERNAL_UNARYLOGICOP_H
27 #define __TERRALIB_FE_INTERNAL_UNARYLOGICOP_H
28 
29 // TerraLib
30 #include "LogicOp.h"
31 
32 namespace te
33 {
34  namespace fe
35  {
36 // Forard declarations
37  class AbstractOp;
38 
39  /*!
40  \class UnaryLogicOp
41 
42  \brief A logical operator that can be used to combine one conditional expressions.
43 
44  \sa LogicOp, AbstractOp, BinaryLogicOp
45  */
47  {
48  public:
49 
51 
52  /** @name Initializer Methods
53  * Methods related to instantiation and destruction.
54  */
55  //@{
56 
57  /*!
58  \brief It initializes a new UnaryLogicOp.
59 
60  \param opName The unary logic operator name.
61 
62  \note The LogicOp will not take the ownership of the given name.
63  */
64  UnaryLogicOp(const char* opName = 0);
65 
66  /*!
67  \brief It initializes a new UnaryLogicOp.
68 
69  \param opName The unary logic operator name.
70  \param o The operand.
71 
72  \note The LogicOp will not take the ownership of the given name.
73  */
74  UnaryLogicOp(const char* opName, AbstractOp* o);
75 
76  /*! \brief Virtual destructor. */
77  virtual ~UnaryLogicOp();
78 
79  //@}
80 
81  /** @name Accessor methods
82  * Methods used to get or set properties.
83  */
84  //@{
85 
86  /*!
87  \brief It sets the operand.
88 
89  \param o The operand.
90 
91  \note It will take the ownership of the operand.
92  */
93  void setOp(AbstractOp* o);
94 
95  /*!
96  \brief It returns the operand.
97 
98  \return The operand.
99  */
100  AbstractOp* getOp() const;
101 
102  //@}
103 
104  protected:
105 
106  AbstractOp* m_op; //!< Mandatory.
107  };
108 
109  } // end namespace fe
110 } // end namespace te
111 
112 #endif // __TERRALIB_FE_INTERNAL_UNARYLOGICOP_H
#define TEFEEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:59
A logical operator that can be used to combine one conditional expressions.
Definition: UnaryLogicOp.h:46
A logical operator can be used to combine one or more conditional expressions.
URI C++ Library.
#define TE_DEFINE_VISITABLE
Definition: BaseVisitable.h:75
An abstract interface for operators.
Definition: AbstractOp.h:47
AbstractOp * m_op
Mandatory.
Definition: UnaryLogicOp.h:106
A logical operator can be used to combine one or more conditional expressions.
Definition: LogicOp.h:52