Method

Operator_Add

---

Description

Allows the class to support the Addition (+) operator to provide custom functionality.

Notes

Create an Operator_Add function in a class to specify the functionality of the + operator for that class.

In the function, the Self instance is one of the operands and the other operand is passed as a parameter. Operator_Add assumes the Self instance is on the left and the passed instance is on the right.

Sample code

Suppose you have a class, Vector, that can store a vector of modest size. To define the + operator for this class, create a method of the Vector class called Operator_Add.

The Vector class has two Integer properties, x and y.

Operator_Add is defined as:

Function Operator_Add(rhs As Vector) As Vector
  ' rhs stands for right-hand-side, the vector to be added to Self
  Var ret As New Vector '  the sum of the two vectors
  ret.x = Self.x + rhs.x
  ret.y = Self.y + rhs.y

  Return ret
End Function

Compatibility

All project types on all supported operating systems.

See also

+ operator, Operator AddRight, Operator And, Operator Divide, Operator IntegerDivide, Operator Modulo, Operator Multiply, Operator Negate, Operator Or, Operator Power, Operator Subtract, Operator Overloading