Public Member
Functions | Static Public
Attributes | Protected Member
Functions | Protected
Attributes
ParameterGroup Class Reference
#include <ParameterGroup.h>
Inheritance diagram for
ParameterGroup:
Public Member Functions |
|
| ParameterGroup (const awString::IString &name, const awString::IString &type, const awString::IString &className) | |
| ParameterGroup (const ParameterGroup &src) | |
| virtual ParameterGroupRef | clone () const =0 |
| template<class T > | |
| aw::Reference< T > | as () |
| template<class T > | |
| aw::Reference< const T > | as () const |
| Id & | getId () |
| void | setName (const awString::IString &name) |
| const awString::IString & | getName () const |
| void | setType (const awString::IString &name) |
| const awString::IString & | getType () const |
| const awString::IString & | getClass () const |
| void | setLabel (const awString::IString &newValue) |
| const awString::IString & | getLabel () const |
| virtual bool | operator== (const ParameterGroup &other) const =0 |
| bool | operator!= (const ParameterGroup &other) const |
| virtual bool | isEquivalent (const ParameterGroup &other) const =0 |
| bool | isCloseMatch (const ParameterGroup ¶mGroup, const aw::set< awString::IString > ¶mExcludeList) const |
| bool | hasParameter (const awString::IString ¶meterName) const |
| virtual ParameterRef | createParameter (const awString::IString &name, Parameter::Type type, const awString::IString &valueAsString)=0 |
| virtual bool | addParameter (const ParameterRef ¶m)=0 |
| bool | forceParameter (const awString::IString &name, const Parameter::Type type, const awString::IString &valueString) |
| If the parameter with the given name exists,
set its value. |
|
| virtual ParameterRef | getParameterByName (const awString::IString &name) const |
| ParameterRef | getParameterByConstant (const int) const |
| virtual int | getParameterCount () const =0 |
| virtual bool | removeParameter (const ParameterRef ¶m)=0 |
| virtual bool | removeParameterByName (const awString::IString &name) |
| virtual bool | removeAllParameters ()=0 |
| virtual ParameterIteratorRef | getIterator () const =0 |
| bool | isAnyParameterModified () const |
| virtual const awString::IString & | getOwnedObjectType () const |
| awString::IString | asXML () const |
| bool | applyXML (const awString::IString &xml) |
| virtual ParameterGroupRef | getConnectedParameterGroup (const awString::IString &name) const =0 |
Static Public Attributes |
|
| static const char | kPathSeparator = '|' |
| static const char | kParameterSeparator = ':' |
Protected Member Functions |
|
| ~ParameterGroup () | |
Protected Attributes |
|
| Id | myId |
| awString::IString | myType |
| awString::IString | myClass |
| awString::IString * | myLabel |
Constructor & Destructor Documentation
| ParameterGroup | ( | const awString::IString & | name, |
| const awString::IString & | type, | ||
| const awString::IString & | className | ||
| ) |
| ParameterGroup | ( | const ParameterGroup & | src | ) |
| ~ParameterGroup | ( | ) | [protected] |
Member Function Documentation
| virtual ParameterGroupRef clone | ( | ) | const [pure virtual] |
Implemented in ObjectAssociations, ObjectProperties, ProteinParameterGroup, and ValueParameterGroup.
| aw::Reference< T > as | ( | ) |
{
return dynamic_cast<T *>( this );
}
| aw::Reference< const T > as | ( | ) | const |
{
return dynamic_cast<const T *>( this );
}
| Id& getId | ( | ) |
| void setName | ( | const awString::IString & | name | ) |
| const awString::IString& getName | ( | ) | const |
| void setType | ( | const awString::IString & | name | ) |
| const awString::IString& getType | ( | ) | const |
| const awString::IString& getClass | ( | ) | const |
| void setLabel | ( | const awString::IString & | newValue | ) |
| const awString::IString& getLabel | ( | ) | const |
| virtual bool operator== | ( | const ParameterGroup & | other | ) | const [pure virtual] |
Implemented in ProteinParameterGroup, and ValueParameterGroup.
| bool operator!= | ( | const ParameterGroup & | other | ) | const |
| virtual bool isEquivalent | ( | const ParameterGroup & | other | ) | const [pure virtual] |
Implemented in ProteinParameterGroup, and ValueParameterGroup.
| bool isCloseMatch | ( | const ParameterGroup & | paramGroup, |
| const aw::set< awString::IString > & | paramExcludeList | ||
| ) | const |
| bool hasParameter | ( | const awString::IString & | parameterName | ) | const |
| virtual ParameterRef createParameter | ( | const awString::IString & | name, |
| Parameter::Type | type, | ||
| const awString::IString & | valueAsString | ||
| ) | [pure virtual] |
Implemented in ProteinParameterGroup, and ValueParameterGroup.
| virtual bool addParameter | ( | const ParameterRef & | param | ) | [pure virtual] |
Implemented in ProteinParameterGroup, and ValueParameterGroup.
| bool forceParameter | ( | const awString::IString & | name, |
| const Parameter::Type | type, | ||
| const awString::IString & | valueString | ||
| ) |
If the parameter with the given name exists, set its value.
If not, create it and add it to the group. Return true if the new parameter was created, false otherwise.
| virtual ParameterRef getParameterByName | ( | const awString::IString & | name | ) | const [virtual] |
Reimplemented in ProteinParameterGroup, and ValueParameterGroup.
| ParameterRef getParameterByConstant | ( | const int | ) | const |
| virtual int getParameterCount | ( | ) | const [pure virtual] |
Implemented in ProteinParameterGroup, and ValueParameterGroup.
| virtual bool removeParameter | ( | const ParameterRef & | param | ) | [pure virtual] |
Implemented in ProteinParameterGroup, and ValueParameterGroup.
| virtual bool removeParameterByName | ( | const awString::IString & | name | ) | [virtual] |
| virtual bool removeAllParameters | ( | ) | [pure virtual] |
Implemented in ProteinParameterGroup, and ValueParameterGroup.
| virtual ParameterIteratorRef getIterator | ( | ) | const [pure virtual] |
Implemented in ProteinParameterGroup, and ValueParameterGroup.
| bool isAnyParameterModified | ( | ) | const |
| virtual const awString::IString& getOwnedObjectType | ( | ) | const [virtual] |
| awString::IString asXML | ( | ) | const |
| bool applyXML | ( | const awString::IString & | xml | ) |
| virtual ParameterGroupRef getConnectedParameterGroup | ( | const awString::IString & | name | ) | const [pure virtual] |
Implemented in ProteinParameterGroup, and ValueParameterGroup.
Member Data Documentation
const char
kPathSeparator = '|' [static] |
const char
kParameterSeparator = ':' [static] |
awString::IString
myType [protected] |
awString::IString
myClass [protected] |
awString::IString*
myLabel [protected] |
