NEOCCA bindings Specification  0.2.8
ParameterPortFactory.hh
Go to the documentation of this file.
1 #ifndef neo_ParameterPortFactory_h_seen
2 #define neo_ParameterPortFactory_h_seen
3 
4 namespace neo {
5 namespace cca {
6 namespace ports {
7 
8 
12 class ParameterPortFactory : public virtual neo::cca::Port
13 {
14 public:
15 
16  virtual ~ParameterPortFactory() {}
17 
20  virtual void createParameterPort(neo::cca::TypeMap_shared portData, const ::std::string & portName)= 0;
21 
24  virtual void setBatchTitle(neo::cca::TypeMap_shared portData, const ::std::string & title)= 0;
25 
30  virtual void setGroupName(neo::cca::TypeMap_shared portData, const std::string & newGroupName)= 0;
31  virtual void setGroupNameAndTitle(neo::cca::TypeMap_shared portData, const std::string & newGroupName, const std::string & title)= 0;
32 
35  virtual void addRequestBoolean(neo::cca::TypeMap_shared portData,
36  const std::string & name,
37  const std::string & help,
38  const std::string & prompt,
39  bool deflt)= 0;
40 
43  virtual void addRequestInt(neo::cca::TypeMap_shared portData,
44  const std::string & name,
45  const std::string & help,
46  const std::string & prompt,
47  int deflt,
48  int low,
49  int high)= 0;
50 
53  virtual void addRequestLong(neo::cca::TypeMap_shared portData,
54  const std::string & name,
55  const std::string & help,
56  const std::string & prompt,
57  int64_t deflt,
58  int64_t low,
59  int64_t high)= 0;
60 
66  virtual void addRequestFloat(neo::cca::TypeMap_shared portData,
67  const std::string & name,
68  const std::string & help,
69  const std::string & prompt,
70  float deflt,
71  float low,
72  float high)= 0;
73 
76  virtual void addRequestDouble(neo::cca::TypeMap_shared portData,
77  const std::string & name,
78  const std::string & help,
79  const std::string & prompt,
80  double deflt,
81  double low,
82  double high)= 0;
83 
86  virtual void addRequestString(neo::cca::TypeMap_shared portData,
87  const std::string & name,
88  const std::string & help,
89  const std::string & prompt,
90  const std::string & deflt)= 0;
93  const std::string & key, const std::string &choice)= 0;
94 
96  virtual void addStringChoices(neo::cca::TypeMap_shared portData,
97  const std::string & key,
98  std::vector< std::string > choices)= 0;
99 
101  virtual void addIntChoices(neo::cca::TypeMap_shared portData,
102  const std::string & key,
103  std::vector< int32_t > choices)= 0;
104 
107  virtual void addIntChoices(neo::cca::TypeMap_shared portData,
108  const std::string & key,
109  int32_t choices[], size_t nChoices)= 0;
110 
112  virtual void addLongChoices(neo::cca::TypeMap_shared portData,
113  const std::string & key,
114  std::vector< int64_t > choices)= 0;
115 
118  virtual void addLongChoices(neo::cca::TypeMap_shared portData,
119  const std::string & key,
120  int64_t choices[], size_t nChoices)= 0;
121 
123  virtual void addFloatChoices(neo::cca::TypeMap_shared portData,
124  const std::string & key,
125  std::vector< float > choices)= 0;
126 
129  virtual void addFloatChoices(neo::cca::TypeMap_shared portData,
130  const std::string & key,
131  float choices[], size_t nChoices)= 0;
132 
134  virtual void addDoubleChoices(neo::cca::TypeMap_shared portData,
135  const std::string & key,
136  std::vector< double > choices)= 0;
137 
140  virtual void addDoubleChoices(neo::cca::TypeMap_shared portData,
141  const std::string & key,
142  double choices[], size_t nChoices)= 0;
143 
145  virtual void addFcomplexChoices(neo::cca::TypeMap_shared portData,
146  const std::string & key,
147  std::vector< std::complex< float > > choices)= 0;
148 
151  virtual void addFcomplexChoices(neo::cca::TypeMap_shared portData,
152  const std::string & key,
153  std::complex< float > choices[], size_t nChoices)= 0;
154 
156  virtual void addDcomplexChoices(neo::cca::TypeMap_shared portData,
157  const std::string & key,
158  std::vector< std::complex< double > > choices)= 0;
159 
162  virtual void addDcomplexChoices(neo::cca::TypeMap_shared portData,
163  const std::string & key,
164  std::complex< double > choices[], size_t nChoices)= 0;
165 
166 
177  virtual void clearRequests(neo::cca::TypeMap_shared portData)= 0;
178 
187  virtual void registerUpdater(neo::cca::TypeMap_shared portData,
188  ParameterGetListener *powner)= 0;
189 
198  ParameterSetListener *powner)= 0;
199 
204  virtual void addParameterPort(neo::cca::TypeMap_shared portData, neo::cca::Services * svc)= 0;
205 
207  virtual void removeParameterPort(neo::cca::TypeMap_shared portData, neo::cca::Services * svc)= 0;
208 
209 
210 }; // end virtual interface ParameterPortFactory
211 
212 
213 } // end namespace ports
214 } // end namespace cca
215 } // end namespace neo
216 #endif // neo_ParameterPortFactory_h_seen
This interface is typically implemented by a component using the ParameterPortFactory in a very dynam...
Definition: ParameterSetListener.hh:12
virtual void addStringChoices(neo::cca::TypeMap_shared portData, const std::string &key, std::vector< std::string > choices)=0
define more choices for a string parameter.
virtual void addRequestBoolean(neo::cca::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, bool deflt)=0
Define a boolean parameter and its default state.
virtual void addRequestInt(neo::cca::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, int deflt, int low, int high)=0
Define a int parameter and its default state.
boost::shared_ptr< TypeMap > TypeMap_shared
This (TypeMap_shared) is what everyone declares in component code and noone ever calls new on...
Definition: TypeMap.hh:14
virtual void removeParameterPort(neo::cca::TypeMap_shared portData, neo::cca::Services *svc)=0
Cause a previously defined parameter port to go away.
virtual void addRequestString(neo::cca::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, const std::string &deflt)=0
Define a string parameter and its default state.
virtual void registerUpdater(neo::cca::TypeMap_shared portData, ParameterGetListener *powner)=0
Register listener (the component) that wishes to have a chance to change the contents of its Paramete...
virtual void addParameterPort(neo::cca::TypeMap_shared portData, neo::cca::Services *svc)=0
Signal that the ParameterPort is fully defined and should now pop out on the component.
virtual void setGroupNameAndTitle(neo::cca::TypeMap_shared portData, const std::string &newGroupName, const std::string &title)=0
virtual void addRequestLong(neo::cca::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, int64_t deflt, int64_t low, int64_t high)=0
Define a long parameter and its default state.
virtual void addDcomplexChoices(neo::cca::TypeMap_shared portData, const std::string &key, std::vector< std::complex< double > > choices)=0
define more choices for a parameter.
virtual void setGroupName(neo::cca::TypeMap_shared portData, const std::string &newGroupName)=0
Define the next tab/group title to use.
virtual void createParameterPort(neo::cca::TypeMap_shared portData, const ::std::string &portName)=0
Initialize the portData ...
virtual void addLongChoices(neo::cca::TypeMap_shared portData, const std::string &key, std::vector< int64_t > choices)=0
define more choices for a int64 parameter.
The handle through which the component communicates with its containing framework.
Definition: Services.hh:16
virtual void clearRequests(neo::cca::TypeMap_shared portData)=0
Clear all previously added requests, titles, groups.
This class mostly follows the sidl documentation for the class of the same name in the gov...
Definition: ParameterPortFactory.hh:12
virtual void registerUpdatedListener(neo::cca::TypeMap_shared portData, ParameterSetListener *powner)=0
Register listener (the component) if it wishes to be informed when an parameter is set...
virtual void addIntChoices(neo::cca::TypeMap_shared portData, const std::string &key, std::vector< int32_t > choices)=0
define more choices for a int32 parameter.
virtual ~ParameterPortFactory()
Definition: ParameterPortFactory.hh:16
virtual void setBatchTitle(neo::cca::TypeMap_shared portData, const ::std::string &title)=0
Define the window title for the parameter dialog.
virtual void addFcomplexChoices(neo::cca::TypeMap_shared portData, const std::string &key, std::vector< std::complex< float > > choices)=0
define more choices for a parameter.
A pure-virtual tag interface to identify a function set capable of being exported to or imported from...
Definition: Port.hh:17
virtual void addDoubleChoices(neo::cca::TypeMap_shared portData, const std::string &key, std::vector< double > choices)=0
define more choices for a parameter.
virtual void addRequestFloat(neo::cca::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, float deflt, float low, float high)=0
Define a float parameter and its default state.
virtual void addRequestDouble(neo::cca::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, double deflt, double low, double high)=0
Define a double parameter and its default state.
This interface is typically implemented by a component using the neo::ports::ParameterPortFactory dyn...
Definition: ParameterGetListener.hh:12
virtual void addFloatChoices(neo::cca::TypeMap_shared portData, const std::string &key, std::vector< float > choices)=0
define more choices for a parameter.
virtual void addRequestStringChoice(neo::cca::TypeMap_shared portData, const std::string &key, const std::string &choice)=0
define a new choice for a string parameter.
This is neoclassic – the ::classic::gov::cca headers updated to be similar to the official CCA speci...
Definition: neocca.hh:62