DataDirector API
DDD_AttributeUInt.h
Go to the documentation of this file.
1 /*! \file DDD_AttributeUInt.h
2  \brief The DDD_AttributeUInt class. Unsigned integer attribute
3  \par Copyright Information
4 
5  Copyright (c) 2012 The DiSTI Corporation.<br>
6  11301 Corporate Blvd; Suite 100<br>
7  Orlando, Florida 32817<br>
8  USA<br>
9  <br>
10  All rights reserved.<br>
11 
12  This Software contains proprietary trade secrets of DiSTI and may not be
13 reproduced, in whole or part, in any form, or by any means of electronic,
14 mechanical, or otherwise, without the written permission of DiSTI. Said
15 permission may be derived through the purchase of applicable DiSTI product
16 licenses which detail the distribution rights of this content and any
17 Derivative Works based on this or other copyrighted DiSTI Software.
18 
19  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
20 AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
21 PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
22 AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
23 IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
24 PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
25 
26  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
27 IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
28 INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
29 DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
30 INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
31 INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBLITY
32 OF SUCH DAMAGES. DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
33 EXCEED FIVE DOLLARS (US$5.00).
34 
35  The aforementioned terms and restrictions are governed by the laws of the
36 State of Florida and the United States of America.
37 
38 */
39 
40 #ifndef _DDD_AttributeUInt_h_
41 #define _DDD_AttributeUInt_h_
42 
43 #include "DDD_AttributeBase.h"
44 
45 #include <string>
46 
47 namespace disti
48 {
49 
50 /** \brief DataDirector attribute class corresponding to a unsigned 32-bit integer datatype.
51  * \ingroup GroupAttributes
52  */
53 class DDD_EXPORT DDD_AttributeUInt : public DDD_AttributeBase
54 {
55 public:
56  /** constructor
57  * \param name The attribute's name
58  * \param initialVal The attribute's initial value
59  * \param container The container that will "own" this attribute
60  * \param validConnectionStates Valid connection states for the attribute (INPUT,OUTPUT, IN_OUT); see DDD_AttributeBase::ConnectionState
61  * \param persistent True if it's a persistent attribute
62  * \param revertable If not NULL, it's a pointer to the revertable attribute for this attribute
63  */
64  DDD_AttributeUInt(const std::string &name,unsigned int initialVal,DDD_AttributeContainer *container,int validConnectionStates,bool persistent,DDD_AttributeBase *revertable);
65 
66  // DDD_AttributeBase methods
67  virtual DataType GetPreferredDataType() const;
68 
69  virtual std::string GetValueString() const;
70  virtual void SetValueString(const std::string &value,bool notify, DDD_AttributeObserver *originator);
71 
72  virtual int GetValueInt(void) const;
73  virtual void SetValueInt(const int value,bool notify, DDD_AttributeObserver *originator);
74 
75  virtual unsigned int GetValueUInt(void) const;
76  virtual void SetValueUInt(const unsigned int value,bool notify, DDD_AttributeObserver *originator);
77 
78  virtual double GetValueDouble(void) const;
79  virtual void SetValueDouble(const double value,bool notify, DDD_AttributeObserver *originator);
80 
81  virtual bool GetValueBool(void) const;
82  virtual void SetValueBool(const bool value,bool notify, DDD_AttributeObserver *originator);
83 
84  virtual void SetValueByteBuffer(const char *buffer, unsigned int length, bool notify, DDD_AttributeObserver *originator);
85  virtual void GetValueByteBuffer(char **buffer, unsigned int &length);
86 
87 protected:
88  unsigned int _value;
89 };
90 
91 
92 } // end namespace disti
93 #endif
94 
DDD_AttributeContainer. A virtual interface class for containers of attributes.
Definition: DDD_AttributeBase.h:57
A virtual interface class for all DataDirector attribute types.
Definition: DDD_AttributeBase.h:87
DataType
Definition: DDD_AttributeBase.h:104
A virtual interface class for observers of attributes. AttributeObserver-derived objects are able to ...
Definition: DDD_AttributeBase.h:66
DataDirector attribute class corresponding to a unsigned 32-bit integer datatype. ...
Definition: DDD_AttributeUInt.h:53
Definition: AttributeChangedEmitter.h:46