MCGetTimeSteps




http://www.QuantTools.com
CapeTools (Compact) Process Simulation function list

Welcome | Documentation format | QuantTools Groups | QuantTools Categories | Licence

Key TAGs | Excel Index | API Index


Return the TimeLine array (in years).

If executing the MCNextStep() or MCDiscounts() functions, you can also execute this function in order to view the time points that the asset prices or discount factors have been generated for.



Note: Within Excel, the function is named - CT.PRO.MCGetTimeSteps


High level graphic of MCGetTimeSteps() function with parameters. Blue square node is the actual function with the parameters ordered.



Parameter Description


  1. stepMC parameter

    Key to an already constructed Step MonteCarlo object.
  2. MandatorySteps parameter

    Do we present only the mandatory steps (true), or all the steps (false).


Extended information

Function Syntax

VB Syntax 


Variant CTProcessSimC.MCGetTimeSteps( _
String stepMC, _
Boolean MandatorySteps)


Excel Spreadsheet Syntax 


=CT.PRO.MCGetTimeSteps(
Excel String Cell stepMC,
Excel Boolean Value Cell MandatorySteps)


C++ Syntax 


static CTRangeDataCPP MCGetTimeSteps(
std::string stepMC,
bool MandatorySteps);


DotNET Syntax 


CTRangeData CTProcessSimCSA.MCGetTimeSteps(
System.String stepMC,
System.Boolean MandatorySteps);

Parameter data types

ArgNameArgTypeIsKey
stepMCStringTRUE
MandatoryStepsBooleanFALSE

Example Inputs

The first column represents the name of the parameters. The second column specifies whether the parameters are optional or not. Finally the last column provides some sample input data.
Function call input string-keys are always in the format : "NAME.EXTTAG.TICKER" The "EXTTAG.TICKER" part is determined from the output of other, capetools, object creation functions.


ArgNameIsOptional (Excel only)Example
stepMCFALSEstepMCNAME.EXTTAG.TICKER (from a function call)
MandatoryStepsFALSEtrue


Example function usage


The C# example below contains all the sub-function calls leading up to this function call. As a result, the example can contain a lot of code.

The VB.NET, J#, C++.NET, Java, Excel VBA, Visual Basic 6 (via COM) and C++ examples below contain function code stubs for the calls leading up to this function call. However, the function call for this function is displayed.
You can easily reproduce the stub functions code from the C# example.


If you are accessing this functrion via the MiniXL libraries, this function is present within the CT.QL.Simulation20 MiniXL Excel Addin.

Within our Excel Example Addin Generator, we have used the following QuantTools sub-functions in order to prepare the arguments needed to call the MCGetTimeSteps() function. If you are executing this function via the MiniXL libraries, the module addin name, (in brackets, to the right of the sub-functions listed below), indicates the MiniXL library in which the sub-function is held. You will need to load this library into your Excel session (along with any other libraries that the sub-function call within the addin requires (ie - CT.QT.Utils20 addin in almost all cases) in order for the example to compute successfully.

These are the financial QuantTools sub-function calls that are used within the examples :





The objects generated by these sub-functions are inter-connected in the following way :




The following four examples demostrate calling this function within a Microsoft .NET environment

The following four examples demostrate calling this function within a non .NET environment

The following is a sample output from executing the MCGetTimeSteps() function call


Example
0
0.5
1
1.5
2
2.5
3
3.5
4
4.5
5
5.5



Copyright (c) 2003-2007 CapeTools - All Rights Reserved.