GUIDOLib  1.7.7
Guido Engine Internal Documentation
ARSpace.h
1 #ifndef ARSpace_H
2 #define ARSpace_H
3 
4 /*
5  GUIDO Library
6  Copyright (C) 2002 Holger Hoos, Juergen Kilian, Kai Renz
7  Copyright (C) 2002-2017 Grame
8 
9  This Source Code Form is subject to the terms of the Mozilla Public
10  License, v. 2.0. If a copy of the MPL was not distributed with this
11  file, You can obtain one at http://mozilla.org/MPL/2.0/.
12 
13  Grame Research Laboratory, 11, cours de Verdun Gensoul 69002 Lyon - France
14  research@grame.fr
15 
16 */
17 
18 #include "ARMTParameter.h"
19 
20 /*@mkdoc
21 
22 @group:Miscellaneous
23 
24 @tagname:\space
25 @tagalias:
26 @tagtype:P
27 @tagnotation:insert space at any position.
28 @tagdesc
29 The **\space** tag can be used to save space for notation elements that do not take up space.
30 @tagend
31 
32 @params:
33 @param:dd:unit:the amount of space:0:false
34 @paramdesc
35 See the [Space](@EXAMPLES/space/) example.
36 @paramend
37 
38 */
39 
42 class ARSpace : public ARMTParameter
43 {
44  public:
45  ARSpace();
46  ARSpace(float val) : fVal(val) {}
47  virtual ~ARSpace() {};
48 
49  virtual int getOrder() const { return kDontMove; }
50  virtual const char* getParamsStr() const { return kARSpaceParams; };
51  virtual const char* getTagName() const { return "ARSpace"; };
52  virtual std::string getGMNName() const { return "\\space"; };
53 
54  virtual void setTagParameters (const TagParameterMap& params);
55  virtual float getValue() const { return fVal; }
56 
57  virtual ARSpace* isARSpace() { return this; }
58 
59  private:
60  float fVal;
61 };
62 
63 #endif
64 
ARSpace
not yet documented
Definition: ARSpace.h:42
ARSpace::~ARSpace
virtual ~ARSpace()
Definition: ARSpace.h:47
ARSpace::setTagParameters
virtual void setTagParameters(const TagParameterMap &params)
ARSpace::getGMNName
virtual std::string getGMNName() const
Definition: ARSpace.h:52
ARMTParameter
not yet documented
Definition: ARMTParameter.h:24
ARSpace::isARSpace
virtual ARSpace * isARSpace()
Definition: ARSpace.h:57
ARSpace::ARSpace
ARSpace(float val)
Definition: ARSpace.h:46
ARSpace::getParamsStr
virtual const char * getParamsStr() const
Definition: ARSpace.h:50
ARMusicalTag::kDontMove
Definition: ARMusicalTag.h:40
ARSpace::getTagName
virtual const char * getTagName() const
Definition: ARSpace.h:51
ARSpace::ARSpace
ARSpace()
ARSpace::getOrder
virtual int getOrder() const
Definition: ARSpace.h:49
ARSpace::getValue
virtual float getValue() const
Definition: ARSpace.h:55
TagParameterMap
A list of tag parameters represented as a map.
Definition: TagParameterMap.h:31

Guido Project Copyright © 2019 Grame-CNCM