A set of named function call arguments. More...
#include <ocean/plankton/VScript.hpp>
Inheritance diagram for Wizt::VScriptParameters:
Classes | |
| struct | iterator |
| struct | Map |
Public Member Functions | |
| bool | append (const RefPtr< VScriptValue > &) |
| Append with a name which is just the number of arguments. | |
| RefPtr< VScriptValue > | find (const string &name) const |
| Find a function argument. | |
| RefPtr< VScriptValue > | find (const string &name, const string &alternative_name) const |
| Find a function argument, allowing for a possible alternative name Possible useful alternative names are just numberings of argument names. | |
| RefPtr< VScriptTypedValue > | get (const string &name, const string &alternative_name, const type_info &preferred_type, const type_info &default_type=typeid(void)) const |
| Convenience function: Geht the value of a parameter, if existent for the specified name and type. | |
| bool | insert (const string &name, const RefPtr< VScriptValue > &) |
| Insert a function argument with a given name. | |
| int | iterate (iterator &it) |
| Iterate over all parameters. | |
| VScriptParameters () | |
| Constructor, no parameters. | |
| ~VScriptParameters () | |
| Destructor. | |
 Public Member Functions inherited from MemCore::ReferenceBase< VScriptParameters > | |
| auto | getObjectCountID () const noexcept |
| Get a unique ID for this object in the given domain. | |
| bool | isIdentical (const WeakPtr< VScriptParameters, VScriptParameters > &PossibleSelf) const noexcept |
| Check if this object is identical to the one used by the given pointer. | |
| void | mkAutoDestructive () |
| Marks this object as being automatically destructed, e.g. | |
| refcount_t | refcount () const noexcept |
| The strong reference count. | |
| ReferenceBase (VScriptParameters *that) noexcept | |
| Constructor, initializes reference counter to zero. | |
| const auto & | self () const |
| Return weak pointer to the object self. | |
| refcount_t | wrefcount () const noexcept |
| The weak reference count. | |
Additional Inherited Members | |
| Public Types inherited from MemCore::ReferenceBase< VScriptParameters > | |
| using | reference_domain_t = VScriptParameters |
| The type of the base class. | |
| using | SelfPtr_t = WeakPtr< VScriptParameters, VScriptParameters > |
| Type for a pointer to this object itself. | |
| Protected Member Functions inherited from MemCore::ReferenceBase< VScriptParameters > | |
| virtual void | extremeUnction () |
| A virtual function that will be called just before the object is destroyed. | |
| ReferenceBase & | operator= (const ReferenceBase &R) |
| Protected assignment operator (should not be called). | |
| void | suicide () |
| Delete this. | |
| virtual | ~ReferenceBase () |
| Virtual destructor. | |
Detailed Description
A set of named function call arguments.
Member Function Documentation
◆ get()
| RefPtr< VScriptTypedValue > Wizt::VScriptParameters::get | ( | const string & | name, |
| const string & | alternative_name, | ||
| const type_info & | preferred_type, | ||
| const type_info & | default_type = typeid(void) |
||
| ) | const |
Convenience function: Geht the value of a parameter, if existent for the specified name and type.
This function is identical to calling find(<name>) with subsequent get(<type>).
References find().
