TA_OBV





http://www.QuantTools.com
CapeTools Technical Analysis - Volume Indicators function list

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

Key TAGs | Excel Index | API Index



On Balance Volume : This function is contained within the Volume Indicators set of indicators.

Returns a 1-Column range.

outInteger (Integers).

(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.OBV




High level graphic of TA_OBV() 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. FieldName parameter

    The FieldName within the Historical DB that you wish to apply the analysis upon.
  6. VolField parameter

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


Extended information

Function Syntax

VB Syntax


Variant CT_TA_VolumeInd.TA_OBV( _
String Key, _
Boolean withHeaders, _
Boolean withDates, _
Boolean withData, _
String FieldName, _
String VolField)


Excel Spreadsheet Syntax


=CT.TA.OBV(
Excel String Cell Key,
Excel Boolean Value Cell withHeaders,
Excel Boolean Value Cell withDates,
Excel Boolean Value Cell withData,
Excel String Cell FieldName,
Excel String Cell VolField)


C++ Syntax


static CTRangeDataCPP TA_OBV(
std::string Key,
bool withHeaders,
bool withDates,
bool withData,
std::string FieldName,
std::string VolField);


DotNET Syntax


CTRangeData CT_TA_VolumeIndSA.TA_OBV(
System.String Key,
System.Boolean withHeaders,
System.Boolean withDates,
System.Boolean withData,
System.String FieldName,
System.String VolField);

Parameter data types

ArgNameArgTypeIsKey
KeyStringTRUE
withHeadersBooleanFALSE
withDatesBooleanFALSE
withDataBooleanFALSE
FieldNameStringFALSE
VolFieldStringFALSE


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
FieldNameFALSEOpen
VolFieldFALSEVolume


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_OBV() 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_OBV() function call


Example
DATEOPENHIGHLOWCLOSEVOLUMEOBV
3774629.37529.562528.812529.31252357023570
3774729.330229.331529.321729.326930920-7350
3774829.322629.329829.321729.326225242-32592
3774929.314929.342929.312629.326935845-68437
3775029.351929.359829.30629.3097130-61307
3775329.347229.347629.341929.34347024-68331
3775429.347829.387929.321129.344622019-46312
3775529.351729.36529.323629.325514065-32247
3775629.353929.354829.28629.342423185-9062
3775729.324829.343929.3129.322210862-19924
3776029.311829.367529.287929.31085649-25573
3776129.327129.354229.290329.327512188-13385
3776229.343129.361729.287729.3412224629077
3776329.344629.36729.306729.34573854047617
3776429.378729.382629.374629.37942339571012
3776729.36729.371229.365629.36962722643786
3776829.3729.380829.351729.35462462468410
3776929.383729.399229.328829.39062139289802
3777029.432929.438229.421429.4318675496556
3777129.422629.439829.407429.41251247484082
3777429.443429.456329.373229.382632280116362
3777529.347229.367129.338129.34810281106081
3777629.391429.395629.389829.391632318138399
3777729.404629.428129.40229.412813685152084
3777829.420729.44729.409929.443216217168301
3778129.413929.489729.394829.458918640149661
3778229.464529.486829.428729.430131378181039
3778329.469529.474629.469129.473133987215026
3778429.500329.50529.48729.503914386229412
3778529.50329.522929.472129.520914274243686
3778829.508829.570529.491729.530233289276975
3778929.532429.54329.507829.517412560289535
3779029.521729.548829.510329.538829633259902
3779129.545429.55129.526429.527324907284809
3779229.517829.572229.483829.49432575252234
3779529.476129.4829.475629.478422055230179
3779629.443229.444629.44329.44416188223991
3779729.443129.47529.437129.44037472216519
3779829.466429.485829.465929.475739791256310
3779929.517229.525229.515929.520519766276076
3780229.489629.51429.479229.485424897251179
3780329.532729.534129.525629.52956168257347
3780429.563529.569929.545229.548936132293479
3780529.543929.594529.531429.567727555265924
3780629.550629.571929.545429.547417206283130
3780929.516529.545829.512529.537239247243883
3781029.541329.576129.536229.55956792250675
3781129.580129.599729.542129.59185518256193
3781229.622229.624929.613329.616512897269090
3781329.616829.634429.600529.604629568239522
3781629.584429.593329.578829.586318074221448



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