libdap++  Updated for version 3.13.1
libdap::ServerFunction Class Reference

#include <ServerFunction.h>

Collaboration diagram for libdap::ServerFunction:
Collaboration graph

Public Member Functions

virtual bool canOperateOn (DDS &)
 
bool_func get_bool_func ()
 
btp_func get_btp_func ()
 
proj_func get_proj_func ()
 
string getDescriptionString ()
 
string getDocUrl ()
 
string getName ()
 
string getRole ()
 
string getTypeString ()
 
string getUsageString ()
 
string getVersion ()
 
 ServerFunction ()
 
 ServerFunction (string name, string version, string description, string usage, string doc_url, string role, bool_func f)
 
 ServerFunction (string name, string version, string description, string usage, string doc_url, string role, btp_func f)
 
 ServerFunction (string name, string version, string description, string usage, string doc_url, string role, proj_func f)
 
void setDescriptionString (const string &desc)
 
void setDocUrl (const string &url)
 
void setFunction (bool_func bf)
 
void setFunction (btp_func btp)
 
void setFunction (proj_func pf)
 
void setName (const string &n)
 
void setRole (const string &r)
 
void setUsageString (const string &u)
 
void setVersion (const string &ver)
 
virtual ~ServerFunction ()
 

Detailed Description

Definition at line 45 of file ServerFunction.h.

Constructor & Destructor Documentation

libdap::ServerFunction::ServerFunction ( )

Definition at line 38 of file ServerFunction.cc.

References setDescriptionString(), setDocUrl(), setName(), setRole(), and setUsageString().

Here is the call graph for this function:

libdap::ServerFunction::ServerFunction ( string  name,
string  version,
string  description,
string  usage,
string  doc_url,
string  role,
bool_func  f 
)

Definition at line 50 of file ServerFunction.cc.

References setDescriptionString(), setDocUrl(), setFunction(), setName(), setRole(), setUsageString(), and setVersion().

Here is the call graph for this function:

libdap::ServerFunction::ServerFunction ( string  name,
string  version,
string  description,
string  usage,
string  doc_url,
string  role,
btp_func  f 
)

Definition at line 60 of file ServerFunction.cc.

References setDescriptionString(), setDocUrl(), setFunction(), setName(), setRole(), setUsageString(), and setVersion().

Here is the call graph for this function:

libdap::ServerFunction::ServerFunction ( string  name,
string  version,
string  description,
string  usage,
string  doc_url,
string  role,
proj_func  f 
)

Definition at line 71 of file ServerFunction.cc.

References setDescriptionString(), setDocUrl(), setFunction(), setName(), setRole(), setUsageString(), and setVersion().

Here is the call graph for this function:

libdap::ServerFunction::~ServerFunction ( )
virtual

Definition at line 82 of file ServerFunction.cc.

Member Function Documentation

virtual bool libdap::ServerFunction::canOperateOn ( DDS )
inlinevirtual

If you are writing a function that can only operate on a particular kind of data, or one that relies on the presence of particular metadata, then you might orride this method in order to stop the server from advertising the function in conjunction with datasets to which it cannot be applied.

Parameters
ddsA DDS object for the dataset about which we will ask the question: Can this function operate on all or some portion of the contents of this dataset? CAUTION: Any implementation of this should be careful not to read data (or read as little as possible) from the passed DDS. Reading data in this method may have negative effect on overall performance. Examining metadata and dataset structure should be the basis for determining the applicability of a function to the dataset.
Returns
true If this function operate on all or some portion of the contents of this dataset, false otherwise.

Definition at line 98 of file ServerFunction.h.

bool_func libdap::ServerFunction::get_bool_func ( )
inline

Definition at line 129 of file ServerFunction.h.

btp_func libdap::ServerFunction::get_btp_func ( )
inline

Definition at line 130 of file ServerFunction.h.

proj_func libdap::ServerFunction::get_proj_func ( )
inline

Definition at line 131 of file ServerFunction.h.

string libdap::ServerFunction::getDescriptionString ( )
inline

Definition at line 80 of file ServerFunction.h.

string libdap::ServerFunction::getDocUrl ( )
inline

Definition at line 74 of file ServerFunction.h.

string libdap::ServerFunction::getName ( )
inline
string libdap::ServerFunction::getRole ( )
inline

Definition at line 77 of file ServerFunction.h.

string libdap::ServerFunction::getTypeString ( )
inline

Definition at line 118 of file ServerFunction.h.

string libdap::ServerFunction::getUsageString ( )
inline

Definition at line 71 of file ServerFunction.h.

string libdap::ServerFunction::getVersion ( )
inline

Definition at line 83 of file ServerFunction.h.

void libdap::ServerFunction::setDescriptionString ( const string &  desc)
inline

Definition at line 81 of file ServerFunction.h.

Referenced by ServerFunction().

void libdap::ServerFunction::setDocUrl ( const string &  url)
inline

Definition at line 75 of file ServerFunction.h.

Referenced by ServerFunction().

void libdap::ServerFunction::setFunction ( bool_func  bf)
inline

Definition at line 100 of file ServerFunction.h.

Referenced by ServerFunction().

void libdap::ServerFunction::setFunction ( btp_func  btp)
inline

Definition at line 106 of file ServerFunction.h.

void libdap::ServerFunction::setFunction ( proj_func  pf)
inline

Definition at line 112 of file ServerFunction.h.

void libdap::ServerFunction::setName ( const string &  n)
inline

Definition at line 69 of file ServerFunction.h.

Referenced by ServerFunction().

void libdap::ServerFunction::setRole ( const string &  r)
inline

Definition at line 78 of file ServerFunction.h.

Referenced by ServerFunction().

void libdap::ServerFunction::setUsageString ( const string &  u)
inline

Definition at line 72 of file ServerFunction.h.

Referenced by ServerFunction().

void libdap::ServerFunction::setVersion ( const string &  ver)
inline

Definition at line 84 of file ServerFunction.h.

Referenced by ServerFunction().


The documentation for this class was generated from the following files: