IsRawProfitMode

Modified on 2013/05/11 13:17 by Eugene — Categorized as: Community Components

Syntax


public static bool IsRawProfitMode(this WealthScript obj)

public bool IsRawProfitMode()

Parameter Description

obj

A WealthScript object instance

Description

Returns true if Strategy was executed in Raw Profit mode, and false if in Portfolio Simulation mode.

Example

Here is an example illustrating how to use the method in your Strategy code:

Example using C# extension methods:


using System;
using System.Text;
using WealthLab;
using WealthLab.Indicators;

namespace WealthLab.Strategies
{
	public class MyStrategy : WealthScript
	{
		protected override void Execute()
		{
			if( this.IsRawProfitMode() )
				PrintDebug( "Raw Profit mode" );
			else
				PrintDebug( "Portfolio Simulation mode" );
		}
	}
}

Legacy syntax example:


using System;
using System.Text;
using WealthLab;
using WealthLab.Indicators;
/*** Requires installation of Community.Components Extension from www.wealth-lab.com > Extensions ***/

namespace WealthLab.Strategies
{
	public class MyStrategy : WealthScript
	{
		protected override void Execute()
		{
			/* 	
				Create an instance of the class that holds the method,
				passing it a WealthScript object (required) as "this" 
			*/
			
			Community.Components.Utility u = new Community.Components.Utility(this);

			// Call the method
			if( u.IsRawProfitMode() )
				PrintDebug( "Raw Profit mode" );
			else
				PrintDebug( "Portfolio Simulation mode" );
		}
	}
}