XII Release 0.1.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
xiiConstructorFunctionProperty< CLASS, Args > Class Template Reference
Inheritance diagram for xiiConstructorFunctionProperty< CLASS, Args >:
[legend]

Public Member Functions

virtual xiiFunctionType::Enum GetFunctionType () const override
 Returns the type of function, see xiiFunctionPropertyType::Enum.
 
template<std::size_t... I>
void ExecuteImpl (xiiTraitInt< 1 >, xiiVariant &out_returnValue, xiiArrayPtr< xiiVariant > arguments, std::index_sequence< I... >) const
 
template<std::size_t... I>
void ExecuteImpl (xiiTraitInt< 0 >, xiiVariant &out_returnValue, xiiArrayPtr< xiiVariant > arguments, std::index_sequence< I... >) const
 
virtual void Execute (void *pInstance, xiiArrayPtr< xiiVariant > arguments, xiiVariant &out_returnValue) const override
 Calls the function. Provide the instance on which the function is supposed to be called.
 
- Public Member Functions inherited from xiiTypedFunctionProperty< CLASS *, Args... >
 xiiTypedFunctionProperty (xiiStringView sPropertyName)
 
virtual const xiiRTTI * GetReturnType () const override
 Returns the type of the return value.
 
virtual xiiBitflags< xiiPropertyFlags > GetReturnFlags () const override
 Returns property flags of the return value.
 
virtual xiiUInt32 GetArgumentCount () const override
 Returns the number of arguments.
 
const xiiRTTI * GetParameterTypeImpl (xiiUInt32 uiParamIndex, std::index_sequence< I... >) const
 
virtual const xiiRTTI * GetArgumentType (xiiUInt32 uiParamIndex) const override
 Returns the type of the given argument.
 
xiiBitflags< xiiPropertyFlags > GetParameterFlagsImpl (xiiUInt32 uiParamIndex, std::index_sequence< I... >) const
 
virtual xiiBitflags< xiiPropertyFlags > GetArgumentFlags (xiiUInt32 uiParamIndex) const override
 Returns the property flags of the given argument.
 
- Public Member Functions inherited from xiiAbstractFunctionProperty
 xiiAbstractFunctionProperty (xiiStringView sPropertyName)
 Passes the property name through to xiiAbstractProperty.
 
virtual xiiPropertyCategory::Enum GetCategory () const override
 Returns the category of this property. Cast this property to the next higher type for more information.
 
virtual const xiiRTTI * GetSpecificType () const override
 Returns the type information of the constant property. Use this to cast this property to a specific version of xiiTypedConstantProperty.
 
xiiAbstractFunctionProperty * AddFlags (xiiBitflags< xiiPropertyFlags > flags)
 Adds flags to the property. Returns itself to allow to be called during initialization.
 
xiiAbstractFunctionProperty * AddAttributes (xiiPropertyAttribute *pAttrib1, xiiPropertyAttribute *pAttrib2=nullptr, xiiPropertyAttribute *pAttrib3=nullptr, xiiPropertyAttribute *pAttrib4=nullptr, xiiPropertyAttribute *pAttrib5=nullptr, xiiPropertyAttribute *pAttrib6=nullptr)
 Adds attributes to the property. Returns itself to allow to be called during initialization. Allocate an attribute using standard 'new'.
 
- Public Member Functions inherited from xiiAbstractProperty
 xiiAbstractProperty (xiiStringView sPropertyName)
 The constructor must get the name of the property. The string must be a compile-time constant.
 
xiiStringView GetPropertyName () const
 Returns the name of the property.
 
const xiiBitflags< xiiPropertyFlags > & GetFlags () const
 Returns the flags of the property.
 
xiiAbstractProperty * AddFlags (xiiBitflags< xiiPropertyFlags > flags)
 Adds flags to the property. Returns itself to allow to be called during initialization.
 
xiiAbstractProperty * AddAttributes (xiiPropertyAttribute *pAttrib1, xiiPropertyAttribute *pAttrib2=nullptr, xiiPropertyAttribute *pAttrib3=nullptr, xiiPropertyAttribute *pAttrib4=nullptr, xiiPropertyAttribute *pAttrib5=nullptr, xiiPropertyAttribute *pAttrib6=nullptr)
 Adds attributes to the property. Returns itself to allow to be called during initialization. Allocate an attribute using standard 'new'.
 
xiiArrayPtr< const xiiPropertyAttribute *const > GetAttributes () const
 Returns the array of property attributes.
 
template<typename Type>
const Type * GetAttributeByType () const
 Returns the first attribute that derives from the given type, or nullptr if nothing is found.
 

Additional Inherited Members

- Protected Attributes inherited from xiiAbstractProperty
xiiBitflags< xiiPropertyFlags > m_Flags
 
xiiStringView m_sPropertyName
 
xiiHybridArray< const xiiPropertyAttribute *, 2U, xiiStaticAllocatorWrapper > m_Attributes
 

Member Function Documentation

◆ Execute()

template<class CLASS, class... Args>
virtual void xiiConstructorFunctionProperty< CLASS, Args >::Execute ( void * pInstance,
xiiArrayPtr< xiiVariant > arguments,
xiiVariant & out_returnValue ) const
inlineoverridevirtual

Calls the function. Provide the instance on which the function is supposed to be called.

arguments must be the size of GetArgumentCount, the following rules apply for both arguments and return value: Any standard type must be provided by value, even if it is a pointer to one. Types must match exactly, no ConvertTo is called. enum and bitflags are supported if xiiEnum / xiiBitflags is used, value must be provided as xiiInt64. Out values (&, *) are written back to the variant they were read from. Any class is provided by pointer, regardless of whether it is a pointer or not. The returnValue must only be valid if the return value is a ref or by value class. In that case returnValue must be a ptr to a valid class instance of the returned type. An invalid variant is equal to a nullptr, except for if the argument is of type xiiVariant, in which case it is impossible to pass along a nullptr.

Implements xiiAbstractFunctionProperty.

◆ GetFunctionType()

template<class CLASS, class... Args>
virtual xiiFunctionType::Enum xiiConstructorFunctionProperty< CLASS, Args >::GetFunctionType ( ) const
inlineoverridevirtual

Returns the type of function, see xiiFunctionPropertyType::Enum.

Implements xiiAbstractFunctionProperty.

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