Section 3: library functions
nutscan_scan_usb – Scan NUT compatible USB devices. Synopsis #include <nut-scan.h> nutscan_device_t * nutscan_scan_usb(); Description The nutscan_scan_usb() function try to detect NUT compatible USB devices. You MUST call nutscan_init(3) before using this function. Return Value The nutscan_scan_usb() function returns a pointer to a nutscan_device_t structure containing all found devices or NULL if an error occurs or…
nutscan_scan_snmp – Scan network for SNMP devices. Synopsis #include <nut-scan.h> nutscan_device_t * nutscan_scan_snmp(const char * start_ip,const char * stop_ip,long timeout, nutscan_snmp_t * sec); Description The nutscan_scan_snmp() function try to detect NUT compatible SNMP devices. It tries SNMP queries on every IP ranging from start_ip to stop_ip. Those IP may be either IPv4 or IPv6 addresses…
nutscan_scan_nut – Scan network for available NUT services. Synopsis #include <nut-scan.h> nutscan_device_t * nutscan_scan_nut(const char * startIP, const char * stopIP, const char * port, long usec_timeout); Description The nutscan_scan_nut() function try to detect available NUT services and their associated devices. It issues a NUT request on every IP ranging from startIP to stopIP. startIP…
nutscan_scan_ipmi – Scan local IPMI devices. Synopsis #include <nut-scan.h> nutscan_device_t * nutscan_scan_ipmi(void); Description The nutscan_scan_ipmi() function is not implemented yet. You MUST call nutscan_init(3) before using this function. Return Value The nutscan_scan_ipmi() function is not implemented yet. See Also nutscan_init(3), nutscan_scan_usb(3), nutscan_scan_xml_http(3), nutscan_scan_nut(3), nutscan_scan_avahi(3), nutscan_scan_snmp(3), nutscan_display_ups_conf(3), nutscan_display_parsable(3), nutscan_new_device(3), nutscan_free_device(3), nutscan_add_option_to_device(3), nutscan_add_device_to_device(3), nutscan_scan_eaton_serial(3), nutscan_cidr_to_ip(3)
nutscan_scan_eaton_serial – Scan serial ports for Eaton devices (XCP, SHUT and Q1). Synopsis #include <nut-scan.h> nutscan_device_t * nutscan_scan_eaton_serial(const char* ports_list); Description The nutscan_scan_eaton_serial() function tries to detect NUT devices which are compatible with Eaton’s serial device protocols (SHUT, XCP and Q1 (aka blazer)). ports_list is a NULL terminated array of pointers to strings containing serial…
nutscan_scan_avahi – Scan network for NUT services via mDNS Synopsis #include <nut-scan.h> nutscan_device_t * nutscan_scan_avahi(long usec_timeout); Description The nutscan_scan_avahi() function tries to detect the NUT service via mDNS, and its associated devices. It uses the Avahi library to do so. You MUST call nutscan_init(3) before using this function. This function waits up to usec_timeout microseconds…
nutscan_new_device – Create a new nutscan_device_t structure. Synopsis #include <nut-scan.h> nutscan_device_t * nutscan_new_device(); Description The nutscan_new_device() function allocates a new nutscan_device_type_t structure. Return Value The nutscan_new_device() function returns the newly allocated nutscan_device_type_t structure See Also nutscan_scan_usb(3), nutscan_scan_xml_http(3), nutscan_scan_nut(3), nutscan_scan_avahi(3), nutscan_scan_ipmi(3), nutscan_scan_snmp(3) nutscan_display_ups_conf(3), nutscan_display_parsable(3) nutscan_free_device(3), nutscan_add_option_to_device(3) nutscan_add_device_to_device(3)
nutscan_get_serial_ports_list – Get a port list name from a range of port. Synopsis #include <nut-scan.h> char **nutscan_get_serial_ports_list(const char *ports_range); Description The nutscan_get_serial_ports_list() function returns a null terminated array of string generated from a port range. ports_range may be one of: • a single character from 0 to 9 or a to z representing a serial…
nutscan_free_device – Free a nutscan_device_t structure created by nutscan_new_device. Synopsis #include <nut-scan.h> void nutscan_free_device(nutscan_device_t *device); Description The nutscan_free_device() function free a nutscan_device_type_t structure. Doing so, it free the whole linked list, not only the given device. See Also nutscan_scan_usb(3), nutscan_scan_xml_http(3), nutscan_scan_nut(3), nutscan_scan_avahi(3), nutscan_scan_ipmi(3), nutscan_scan_snmp(3), nutscan_display_ups_conf(3), nutscan_display_parsable(3), nutscan_new_device(3), nutscan_add_option_to_device(3), nutscan_add_device_to_device(3)
nutscan_display_ups_conf – Display the specified `nutscan_device_t` structure on stdout. Synopsis #include <nut-scan.h> void nutscan_display_ups_conf(nutscan_device_t *device); Description The nutscan_display_ups_conf() function displays all NUT devices in device to stdout. It displays them in a way that it can be directly copied into the ups.conf file. See Also nutscan_scan_usb(3), nutscan_scan_xml_http(3), nutscan_scan_nut(3), nutscan_scan_avahi(3), nutscan_scan_ipmi(3), nutscan_scan_snmp(3), nutscan_display_parsable(3), nutscan_new_device(3), nutscan_free_device(3), nutscan_add_option_to_device(3),…
nutscan_display_parsable – Display the specified `nutscan_device_t` structure on stdout. Synopsis #include <nut-scan.h> void nutscan_display_parsable(nutscan_device_t *device); Description The nutscan_display_parsable() function displays all NUT devices in device to stdout. It displays them in a way that can be easily parsed which is: <driver type>:driver="<driver name>",port="<port type>"[,<optional parameter 1>="<optional data 1>",<optional parameter 2>="<optional data 2>",…] <driver type> may…
nutscan_cidr_to_ip – Convert a CIDR IP to a range of IP address. Synopsis #include <nut-scan.h> int nutscan_cidr_to_ip(const char *cidr, char **start_ip, char **stop_ip); Description The nutscan_cidr_to_ip() function converts a range of IP address in the CIDR format given as a string in cidr, to two IPs in strings pointed by start_ip and stop_ip which can…
nutscan_add_option_to_device – Add option data to the specified device. Synopsis #include <nut-scan.h> void nutscan_add_option_to_device(nutscan_device_t *device, char *option_name, char *value); Description The nutscan_device_t contains the following variables: nutscan_device_type_t type; char * driver; char * port; nutscan_options_t opt; struct nutscan_device * prev; struct nutscan_device * next; This is a double linked list of device. Each device is…
nutscan_add_device_to_device – Concatenate two devices structure. Synopsis #include <nut-scan.h> nutscan_device_t * nutscan_add_device_to_device(nutscan_device_t * first, nutscan_device_t * second); Description The nutscan_device_t contains the following variables: nutscan_device_type_t type; char * driver; char * port; nutscan_options_t opt; struct nutscan_device * prev; struct nutscan_device * next; This is a double linked list of device. Each device is described by…
nutscan – Network UPS Tools (NUT) device discovery library Description The Network UPS Tools (NUT) nutscan library provides the same discovery related features that are also offered by nut-scanner(8). It enables the discovery of supported NUT devices (USB, SNMP, Eaton XML/HTTP and IPMI) and NUT servers (using Avahi, or the classic connection method). Discovery Functions…
QuantLib::Currency – Currency specification Synopsis const std::string & name () const currency name, e.g, ‘U.S. Dollar’ const std::string & code () const ISO 4217 three-letter code, e.g, ‘USD’. Integer numericCode () const ISO 4217 numeric code, e.g, ‘840’. const std::string & symbol () const symbol, e.g, ‘$’ const std::string & fractionSymbol () const fraction symbol,…
QuantLib::MarketModelEvolver – Market-model evolver. Synopsis virtual const std::vector< Size > & numeraires () const =0 virtual Real startNewPath ()=0 virtual Real advanceStep ()=0 virtual Size currentStep () const =0 virtual const CurveState & currentState () const =0 virtual void setInitialState (const CurveState &)=0 Inherited by ConstrainedEvolver, LogNormalCmSwapRatePc, LogNormalCotSwapRatePc, LogNormalFwdRateEuler, LogNormalFwdRateIpc, LogNormalFwdRatePc, NormalFwdRatePc, and SVDDFwdRatePc. Public…
QuantLib::HybridHestonHullWhiteProcess – Hybrid Heston Hull-White stochastic process. Synopsis const boost::shared_ptr< HullWhite > hullWhiteModel_ const Real corrEquityShortRate_ const Time T_ DiscountFactor endDiscount_ Inherits QuantLib::JointStochasticProcess. Public Member Functions HybridHestonHullWhiteProcess (const boost::shared_ptr< HestonProcess > &hestonProcess, const boost::shared_ptr< HullWhiteForwardProcess > &hullWhiteProcess, Real corrEquityShortRate, Size factors) void preEvolve (Time t0, const Array &x0, Time dt, const Array &dw) const Disposable<…
QuantLib::OrthogonalProjections – Synopsis #include <ql/math/matrixutilities/basisincompleteordered.hpp> Public Member Functions OrthogonalProjections (const Matrix &originalVectors, Real multiplierCutOff, Real tolerance) const std::vector< bool > & validVectors () const const std::vector< Real > & GetVector (Size index) const Size numberValidVectors () const Detailed Description Given a collection of vectors, w_i, find a collection of vectors x_i such that x_i is…
QuantLib::MarketModelVolProcess – Synopsis #include <ql/models/marketmodels/evolvers/marketmodelvolprocess.hpp> Inherited by SquareRootAndersen. Public Member Functions virtual Size variatesPerStep ()=0 virtual Size numberSteps ()=0 virtual void nextPath ()=0 virtual Real nextstep (const std::vector< Real > &variates)=0 virtual Real stepSd () const =0 virtual std::vector< Real > & stateVariables () const =0 virtual Size numberStateVariables () const =0 Detailed Description Displaced…