TA_WCLPRICE





http://www.QuantTools.com
CapeTools Technical Analysis - Price Transform function list

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

Key TAGs | Excel Index | API Index



Weighted Close Price : This function is contained within the Price Transform set of indicators.

Returns a 1-Column range.

outReal (Doubles).

(Reference - http://www.tadoc.org, http://www.ta-lib.org).

This function requires the input of a Technical Analysis memory data table object key, which must have been produced via a call to MakeHistoricalDB(). This function would have returned a string 'KEY' which is to be passed to the 'Key' parameter of this function.



Note: Within Excel, the function is named - CT.TA.WCLPRICE




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



Parameter Description


  1. Key parameter

    Key to an already created HistoricalDB object
  2. withHeaders parameter

    Display header information with the output range?
  3. withDates parameter

    Display the Dates column along with the output range?
  4. withData parameter

    Display the 'Open', 'High', 'Low', 'Close' and 'Volume' columns along with the output range?
  5. HighField parameter

    The 'High' Field name within the Historical DB that you wish to apply the analysis upon.
  6. LowField parameter

    The 'Low' Field name within the Historical DB that you wish to apply the analysis upon.
  7. CloseField parameter

    The 'Close' Field name within the Historical DB that you wish to apply the analysis upon.


Extended information

Function Syntax

VB Syntax


Variant CT_TA_PriceTran.TA_WCLPRICE( _
String Key, _
Boolean withHeaders, _
Boolean withDates, _
Boolean withData, _
String HighField, _
String LowField, _
String CloseField)


Excel Spreadsheet Syntax


=CT.TA.WCLPRICE(
Excel String Cell Key,
Excel Boolean Value Cell withHeaders,
Excel Boolean Value Cell withDates,
Excel Boolean Value Cell withData,
Excel String Cell HighField,
Excel String Cell LowField,
Excel String Cell CloseField)


C++ Syntax


static CTRangeDataCPP TA_WCLPRICE(
std::string Key,
bool withHeaders,
bool withDates,
bool withData,
std::string HighField,
std::string LowField,
std::string CloseField);


DotNET Syntax


CTRangeData CT_TA_PriceTranSA.TA_WCLPRICE(
System.String Key,
System.Boolean withHeaders,
System.Boolean withDates,
System.Boolean withData,
System.String HighField,
System.String LowField,
System.String CloseField);

Parameter data types

ArgNameArgTypeIsKey
KeyStringTRUE
withHeadersBooleanFALSE
withDatesBooleanFALSE
withDataBooleanFALSE
HighFieldStringFALSE
LowFieldStringFALSE
CloseFieldStringFALSE


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
KeyFALSEKeyNAME.EXTTAG.TICKER (from a function call)
withHeadersFALSEtrue
withDatesFALSEtrue
withDataFALSEtrue
HighFieldFALSEHigh
LowFieldFALSELow
CloseFieldFALSEClose


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.TechnicalAnalysis20 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 TA_WCLPRICE() 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 TA_WCLPRICE() function call


Example
DATEOPENHIGHLOWCLOSEVOLUMEWCLPRICE
3774629.37529.562528.812529.31252357029.25
3774729.330229.331529.321729.32693092029.3267
3774829.322629.329829.321729.32622524229.326
3774929.314929.342929.312629.32693584529.3273
3775029.351929.359829.30629.309713029.321
3775329.347229.347629.341929.3434702429.3441
3775429.347829.387929.321129.34462201929.3496
3775529.351729.36529.323629.32551406529.3349
3775629.353929.354829.28629.34242318529.3314
3775729.324829.343929.3129.32221086229.3246
3776029.311829.367529.287929.3108564929.3193
3776129.327129.354229.290329.32751218829.3249
3776229.343129.361729.287729.34122246229.333
3776329.344629.36729.306729.34573854029.3413
3776429.378729.382629.374629.37942339529.379
3776729.36729.371229.365629.36962722629.369
3776829.3729.380829.351729.35462462429.3604
3776929.383729.399229.328829.39062139229.3773
3777029.432929.438229.421429.4318675429.4308
3777129.422629.439829.407429.41251247429.4181
3777429.443429.456329.373229.38263228029.3987
3777529.347229.367129.338129.3481028129.3503
3777629.391429.395629.389829.39163231829.3922
3777729.404629.428129.40229.41281368529.4139
3777829.420729.44729.409929.44321621729.4358
3778129.413929.489729.394829.45891864029.4506
3778229.464529.486829.428729.43013137829.4439
3778329.469529.474629.469129.47313398729.4725
3778429.500329.50529.48729.50391438629.4999
3778529.50329.522929.472129.52091427429.5092
3778829.508829.570529.491729.53023328929.5306
3778929.532429.54329.507829.51741256029.5214
3779029.521729.548829.510329.53882963329.5342
3779129.545429.55129.526429.52732490729.533
3779229.517829.572229.483829.4943257529.511
3779529.476129.4829.475629.47842205529.4781
3779629.443229.444629.44329.4441618829.444
3779729.443129.47529.437129.4403747229.4482
3779829.466429.485829.465929.47573979129.4758
3779929.517229.525229.515929.52051976629.5205
3780229.489629.51429.479229.48542489729.491
3780329.532729.534129.525629.5295616829.5297
3780429.563529.569929.545229.54893613229.5532
3780529.543929.594529.531429.56772755529.5653
3780629.550629.571929.545429.54741720629.553
3780929.516529.545829.512529.53723924729.5332
3781029.541329.576129.536229.5595679229.5578
3781129.580129.599729.542129.5918551829.5814
3781229.622229.624929.613329.61651289729.6178
3781329.616829.634429.600529.60462956829.611
3781629.584429.593329.578829.58631807429.5862



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