Class pvxrequestclient


This class is used to communicate request to the RequestManager which will pass the information to a dedicated worker process to take action.

Build Information

Author fmcguirk
Date 2007.06.08 23 at 02:51:20 PM EDT
Outputfile pvxrequestclient.pvc
Forcelinenumbers false

Constructor

Open a connection to the RequestManager.

ParameterDescription
Request_Socket$ Optional value for the socket to use to connect to the Request Manager. If this value is not set, ARG(1) will be used.

Properties

PROPERTY _version$

PROPERTY view_bookmarks$

PROPERTY view_embeddict$

PROPERTY view_nomads$

PROPERTY view_pvxoutline$

Methods

The values for the view name are defined as properties of this class

FUNCTION addBookmark(aResource$, aResetFlag$, theData$)

Send a message to add a bookmark to a resource

ParameterDescription
aResetFlag$ A boolean value to indicate existing file marks are to be reset
Data$ The data to be used to mark the resource
FUNCTION addToSearchView(aResource$, aResetFlag$, theData$)

Send a message to mark the search view for a resource

ParameterDescription
aResetFlag$ A boolean value to indicate existing file marks are to be reset
Data$ The data to be used to mark the resource
FUNCTION finishedSearch()

Send a message to end a search

FUNCTION print(text$)

Print a message on the console view.

ParameterDescription
text$ The text message to be displayed
FUNCTION resource_build(name$)

Send a message to trigger a rebuild of the specified resource.

ParameterDescription
name$ The full path of the resource to rebuild.
FUNCTION resource_copy(from$, to$)

Send a message to copy a resource

ParameterDescription
from$ The full path of the resource to be copied
to$ The full path of the location where to copy is to be saved
FUNCTION resource_mark(aResource$, aResetFlag$, theData$)

Send a message to mark errors and warnings for a resource

ParameterDescription
aResource$ The full path of the resource
aResetFlag$ A boolean value to indicate existing file marks are to be reset
Data$ The data to be used to mark the resource
FUNCTION resource_move(from$, to$)

Send a message to move a resource

ParameterDescription
from$ The full path of the resource to be copied
to$ The full path of the location where to copy is to be saved
FUNCTION resource_property(name$, property$, value$)

Send a message to set a property for a resource

ParameterDescription
name$ The full path of the resource to be affected.
property$ The name of the property to be set
value$ The value to be assigned to the property
FUNCTION resource_refresh(name$)

Send a message to refresh a resource.

ParameterDescription
name$ The full path to the resource to be refreshed.
FUNCTION restart()

Print a message on the console view.

ParameterDescription
text$ The text message to be displayed
FUNCTION startSearch(findStr$)

Send a message to start a new search

ParameterDescription
findStr$ The string to search for
FUNCTION statusbar_message(viewid$, msg$)

Print a message to the statusbar of a view

ParameterDescription
viewid$ The id of the view
msg$ the message to print to the statusbar
FUNCTION view_refresh(name$)

Send a message to refresh a view.

ParameterDescription
name$ The name of the view to be refreshed. The possible values for this argument are listed in the following table.
ValueDescription
thisClass'view_embeddict$ Embedded data dictionary information.
thisClass'view_nomads$ NOMADS library contents
thisClass'view_pvxoutline$ Information about currently selected resource