CxDynagraph Methods

The CxDynagraph object contains the following methods:

The DataGroup parameter referenced in the table below is an integer that identifies a data group instance to operate on. The possible values are:

• 0 – Pumpoff Configuration
• 1 – Status Data (this is a hard coded list of status points in CVS)
• 2 – Current Card
• 3 – Shutdown Card
• 4 – Pumpup Card
• 5 – Reference Card
• 6 – Start Card
• 7 – Fluid Fill Data Group (EIE specific support)
• 8 – Ideal Card
• 9 – Alarm Card
• 10 – Failure Card

AbortAllRequests

The AbortAllRequests method aborts all card poll requests. See Aborting Card Requests.

Syntax

AbortAllRequests()

AbortCurrentRequest

The AbortCurrentRequest method aborts all current card poll requests. See Aborting Card Requests.

Syntax

AbortCurrentRequest()

AboutBox

The AboutBox method displays an About dialog box for the control.

Syntax

AboutBox()

Example

The following examples launch an About dialog box for the control.

Sub ShowAboutBox()
 
    <Object>.AboutBox
 
End Sub

Sub ButtonTool_EventClick()

    Dim This : Set This = ButtonTool
    <Object>.AboutBox
 
End Sub

AddCalcMethodFilter

The AdCalcMethodFilter method adds a calculation method filter to limit downhole cards based on relevant calculation type(s) used in a single transaction.

Syntax

AddCalcMethodFilter(CalcType As String)

Parameters

CanGetFromRtu

The CanGetFromRtu method returns true if the user can retrieve data from RTU. The user can retrieve data if they have the necessary security credentials. For card data groups, the user must have necessary security credentials and the EIE must support the particular card type.

Syntax

CanGetFromRtu(DataGroup As Integer) As Boolean

Parameters

CanSendToRtu

The CanSendToRtu method returns true if the user can send data to RTU. Pumpoff configuration and fluid fill data can be sent if the user has the necessary security credentials and the data has been read from the RTU already. Reference cards can be sent if the EIE supports writing reference cards and the user has the necessary security credentials.

Syntax

CanSendToRtu(DataGroup As Integer) As Boolean

Parameters

ChooseFacility

The ChooseFilter method displays a Facility Chooser dialog box and returns the selected facilities in an array.

Syntax

ChooseFacility() As String

ChooseSiteService

The ChooseSiteService method displays a Select Service dialog box to select a UIS Site.Service.

Syntax

ChooseSiteService() As String

ClearCalcMethodFilters

The ClearCalcMethodFilter method clears a calculation method filter. Results in the display of all available card types.

Syntax

ClearCalcMethodFilters()

EditCardTraceSetup

The EditCardTraceSetup method edits a card trace setup. A trace polls current cards at a specified interval for a specified duration, allowing you to closely monitor a well for a short length of time. See Executing a Card Trace.

Syntax

EditCardTraceSetup()

EditData

The EditData method presents a dialog that is used to edit pumpoff configuration or fluid fill data parameters and send changes to RTU.

Syntax

EditData(DataGroup As Integer) As Boolean

Parameters

ExportCard

The ExportCard method exports the card to a text or data file. See Saving Cards.

Syntax

ExportCard()

ExportCardEx

Syntax

ExportCardEx(ExportFormat As Integer, FileName As String) As Boolean

Parameters

GetCardCount

The GetCardCount method returns the number of cards of the currently chosen card type that the device has.

Syntax

GetCardCount() As Integer

GetCardFromRtu

The GetCardFromRtu method issues a poll for the specified DynaCard data group.

Syntax

GetCardFromRtu(DataGroup As Integer, NumCards As Integer) As Boolean

Parameters

GetCardPairFromRtu

The GetCardPairFromRtu method issues a poll for the two specified DynaCard data groups.

Syntax

GetCardPairFromRtu(DataGroup1 As Integer, NumCards1 As Integer, DataGroup2 As Integer, NumCards2 As Integer) As Boolean

Parameters

GetDeviceType

Syntax

GetDeviceType() As String

GetDownholeCalcMethods

See IsCalcMethodFilter method.

Syntax

GetDownholeCalcMethods(ByRef arrFilterCriteria)

GetFacilityCount

Syntax

GetFacilityCount() As Integer

GetFromRtu

The GetFromRtu method issues a poll for the specified data group.

Syntax

GetFromRtu(DataGroup As Integer) As Boolean

Parameters

GetLastRequestError

Syntax

GetLastRequestError(ErrorText, ErrorTimeUtc, Clear As Boolean) As Boolean

Parameters

GetRequestQueueCount

Syntax

GetRequestQueueCount() As Long

GetRequestQueueCurrent

Syntax

GetRequestQueueCurrent(DataGroup, FirstCard, LastCard) As Boolean

Parameters

GetSelectedCardDataElement

The GetSelectedCardDataElement method returns the data value for a data element in the DDS transaction of the currently selected card. Deid is the name of the data element requested and if it is an ordinalized data element (like the load and position values are). Index is the ordinal of the data element to retrieve.

Syntax

GetSelectedCardDataElement(Deid As String, Index As Integer) As String

Parameters

GetSelectedCardDbKey

The GetSelectedCardDbKey method returns the DDS database key (DbKey) for the currently selected card.

Syntax

GetSelectedCardDbKey() As String

GetSelectedCardToken

The GetSelectedCardToken method returns the token for the currently selected card.

Syntax

GetSelectedCardToken() As String

GetSelectedCardXml

The GetSelectedCardXml method returns the XML for the DDS transaction of the currently selected card.

Syntax

GetSelectedCardXml() As String

IsCalcMethodFilter

Syntax

IsCalcMethodFilter(arrFilterCriteria As String) As Long

Parameters

IsCardTraceActive

The IsCardTraceActive method determines whether the card trace is active or not. See Executing a Card Trace.

Syntax

IsCardTraceActive() As Boolean

IsSelectedCardMostRecent

The IsSelectedCardMostRecent method enables a user to call the function to determine whether the selected card is the most recently retrieved card of its type. Boolean value returned.

Syntax

IsSelectedCardMostRecent() As Boolean

Navigate

The Navigate method chooses the next pump off control device for the UIS if nNavObject is 0, or the next card for the selected device if nNavObject is 1. If bGoForward is True, this will navigate forwards to the next device or the next card, and if bGoForward is False this will navigate backwards to the previous device or previous card. Calling this function causes the CardChange event to fire if the selected device has a card of the set card type.

Syntax

Navigate(NavObject As Integer, GoForward As Boolean)

Parameters

Print

The Print method prints the contents of the control, grid, or viewer. When this method is called, the Print dialog box is shown to allow configuration.

Syntax

Print()

ProcessChanges

Syntax

ProcessChanges() As Boolean

RefreshCards

The RefreshCards method enables you to manually refresh card data and display to see the latest changes. Useful when a dynagraph card depends on another system for calculations, which might create a small lag time in communication between the systems.

Syntax

RefreshCards()

RefreshConfig

The RefreshConfig method refreshes the pumpoff configuration display.

Syntax

RefreshConfig()

RefreshDataGroup

The RefreshDataGroup method causes the control to re-read the data group data or status points and refresh the visible values.

Syntax

RefreshDataGroup(DataGroup As Integer)

Parameters

RefreshStatus

The RefreshStatus method refreshes the status data display.

Syntax

RefreshStatus()

RemoveCalcMethodFilter

Syntax

RemoveCalcMethodFilter(CalcType As String)

Parameters

RemoveCard

The RemoveCard method removes a card from the view set.

Syntax

RemoveCard(bAllCards As Boolean)

SaveReferenceCard

The SaveReferenceCard method displays the Save as Reference Card dialog box, allowing you to save the selected card as the most recent reference card in your CygNet system.

Syntax

SaveReferenceCard() As Boolean

SelectCards

Syntax

SelectCards()

SendToRtu

The SendToRtu method is used to resend pumpoff configuration or fluid fill data that has already been read from RTU.

Syntax

SendToRtu(DataGroup As Integer) As Boolean

Parameters

SetDynagraph

The SetDynagraph method sets the UIS and facility ID for the desired pump off control device. Calling this function causes the CardChange event to fire if the selected device has a card of the set card type.

Syntax

SetDynagraph(SiteService As String, FacilityId As String) As Boolean

Parameters

ShowCardDetails

The ShowCardDetails method displays the Dynagraph Card Details dialog box, displaying card information and position/load pairs.

Syntax

ShowCardDetails()

StartCardTrace

The StartCardTrace method starts a card trace. See Executing a Card Trace for more information.

Syntax

StartCardTrace(Enable As Boolean)

Parameters

ViewDbKey

Syntax

ViewDbKey(DbKey As String)

Parameters