Ocean
Public Member Functions
Ocean::ParameterizedFunctionBase< RT > Class Template Referenceabstract
Ocean Base Library

This class is the base class for a parameterized function container. More...

Inheritance diagram for Ocean::ParameterizedFunctionBase< RT >:

Public Member Functions

virtual ~ParameterizedFunctionBase ()
 Destructs a parameterized function object. More...
 
virtual RT call () const =0
 Calls the internal encapsulated function and uses the specified parameters. More...
 
virtual ParameterizedFunctionBase * copy () const =0
 Creates a copy of the entire derivated object. More...
 
virtual unsigned int parameters () const =0
 Returns the number of function parameters. More...
 
virtual void * parameter (const unsigned int index)=0
 Returns a specified parameter as a void pointer to the parameter's pointer. More...
 
virtual void setParameter (const unsigned int index, const void *value)=0
 Sets a specified parameter. More...
 
virtual const std::type_info & type (const unsigned int index) const =0
 Returns the parameter type of a specific parameter. More...
 

Detailed Description

template<typename RT>
class Ocean::ParameterizedFunctionBase< RT >

This class is the base class for a parameterized function container.

This base function cantainer allows the specification of parameters and therefore can call the encapsulated function without explicit parameters.

Template Parameters
RTDefines the return data type

Constructor & Destructor Documentation

◆ ~ParameterizedFunctionBase()

template<typename RT >
Ocean::ParameterizedFunctionBase< RT >::~ParameterizedFunctionBase
virtual

Destructs a parameterized function object.

Member Function Documentation

◆ call()

template<typename RT >
virtual RT Ocean::ParameterizedFunctionBase< RT >::call ( ) const
pure virtual

Calls the internal encapsulated function and uses the specified parameters.

Returns
Return value

Implemented in Ocean::ParameterizedStaticFunction< RT, PT0, PT1, PT2, PT3, PT4, PT5, PT6, PT7, PT8, PT9, PT10, PT11, PT12, PT13, PT14, PT15, PT16, PT17, PT18, PT19 >, Ocean::ParameterizedMemberFunctionConst< CT, RT, PT0, PT1, PT2, PT3, PT4, PT5, PT6, PT7, PT8, PT9, PT10, PT11, PT12, PT13, PT14, PT15, PT16, PT17, PT18, PT19 >, and Ocean::ParameterizedMemberFunction< CT, RT, PT0, PT1, PT2, PT3, PT4, PT5, PT6, PT7, PT8, PT9, PT10, PT11, PT12, PT13, PT14, PT15, PT16, PT17, PT18, PT19 >.

◆ copy()

template<typename RT >
virtual ParameterizedFunctionBase* Ocean::ParameterizedFunctionBase< RT >::copy ( ) const
pure virtual

Creates a copy of the entire derivated object.

Returns
Instance copy

Implemented in Ocean::ParameterizedStaticFunction< RT, PT0, PT1, PT2, PT3, PT4, PT5, PT6, PT7, PT8, PT9, PT10, PT11, PT12, PT13, PT14, PT15, PT16, PT17, PT18, PT19 >, Ocean::ParameterizedMemberFunctionConst< CT, RT, PT0, PT1, PT2, PT3, PT4, PT5, PT6, PT7, PT8, PT9, PT10, PT11, PT12, PT13, PT14, PT15, PT16, PT17, PT18, PT19 >, and Ocean::ParameterizedMemberFunction< CT, RT, PT0, PT1, PT2, PT3, PT4, PT5, PT6, PT7, PT8, PT9, PT10, PT11, PT12, PT13, PT14, PT15, PT16, PT17, PT18, PT19 >.

◆ parameter()

template<typename RT >
virtual void* Ocean::ParameterizedFunctionBase< RT >::parameter ( const unsigned int  index)
pure virtual

Returns a specified parameter as a void pointer to the parameter's pointer.

Parameters
indexIndex of the parameter to change
Returns
Requested parameter pointer

Implemented in Ocean::ParameterizedFunction< RT, PT0, PT1, PT2, PT3, PT4, PT5, PT6, PT7, PT8, PT9, PT10, PT11, PT12, PT13, PT14, PT15, PT16, PT17, PT18, PT19 >, and Ocean::ParameterizedFunction< RT, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass >.

◆ parameters()

template<typename RT >
virtual unsigned int Ocean::ParameterizedFunctionBase< RT >::parameters ( ) const
pure virtual

Returns the number of function parameters.

Returns
Parameter number

Implemented in Ocean::ParameterizedFunction< RT, PT0, PT1, PT2, PT3, PT4, PT5, PT6, PT7, PT8, PT9, PT10, PT11, PT12, PT13, PT14, PT15, PT16, PT17, PT18, PT19 >, and Ocean::ParameterizedFunction< RT, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass >.

◆ setParameter()

template<typename RT >
virtual void Ocean::ParameterizedFunctionBase< RT >::setParameter ( const unsigned int  index,
const void *  value 
)
pure virtual

Sets a specified parameter.

Parameters
indexIndex of the parameter to change
valueNew parameter value

Implemented in Ocean::ParameterizedFunction< RT, PT0, PT1, PT2, PT3, PT4, PT5, PT6, PT7, PT8, PT9, PT10, PT11, PT12, PT13, PT14, PT15, PT16, PT17, PT18, PT19 >, and Ocean::ParameterizedFunction< RT, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass >.

◆ type()

template<typename RT >
virtual const std::type_info& Ocean::ParameterizedFunctionBase< RT >::type ( const unsigned int  index) const
pure virtual

Returns the parameter type of a specific parameter.

Parameters
indexIndex of the parameter
Returns
Type information

Implemented in Ocean::ParameterizedFunction< RT, PT0, PT1, PT2, PT3, PT4, PT5, PT6, PT7, PT8, PT9, PT10, PT11, PT12, PT13, PT14, PT15, PT16, PT17, PT18, PT19 >, and Ocean::ParameterizedFunction< RT, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass, NullClass >.

The documentation for this class was generated from the following file: