Manager class for LabVIEW DCOM Interaction. Parses an lvinput.xml file and provides access to the LabVIEW VI controls/indicators described within. More...

#include <lvDCOMInterface.h>

Public Member Functions
	lvDCOMInterface (const char configSection, const char configFile, const char host, int options, const char progid, const char username, const char password)
	section name of configFile we will load settings from More...

long	nParams ()

void	getParams (std::map< std::string, std::string > &res)

template<typename T >
void	setLabviewValue (const char *param, const T &value)

template<typename T >
void	getLabviewValue (const char param, T value)

template<typename T >
void	getLabviewValue (const char param, T value, size_t nElements, size_t &nIn)

	~lvDCOMInterface ()

std::string	doPath (const std::string &xpath)

std::string	doXPATH (const std::string &xpath)

bool	doXPATHbool (const std::string &xpath)

void	report (FILE *fp, int details)
	Helper for EPICS driver report function. More...

int	generateFilesFromSECI (const char portName, const char macros, const char configSection, const char configFile, const char dbSubFile, const char blocks_match, bool no_setter)
	generate XML and DB files for SECI blocks More...

bool	checkForNewBlockDetails ()

template<>
void	getLabviewValue (const char param, std::string value)

template<>
void	setLabviewValue (const char *param, const std::string &value)

Static Public Member Functions
static double	diffFileTimes (const FILETIME &f1, const FILETIME &f2)
	filetime uses 100ns units, returns difference in seconds More...

Private Types
typedef std::map< std::wstring, ViRef >	vi_map_t

Private Member Functions
void	DomFromCOM ()

char *	envExpand (const char *str)
	expand epics environment strings using previously saved environment based on EPICS macEnvExpand() More...

void	getViRef (BSTR vi_name, bool reentrant, LabVIEW::VirtualInstrumentPtr &vi)

void	createViRef (BSTR vi_name, bool reentrant, LabVIEW::VirtualInstrumentPtr &vi)

void	getLabviewValue (BSTR vi_name, BSTR control_name, VARIANT *value)

void	setLabviewValue (BSTR vi_name, BSTR control_name, const VARIANT &value)

void	setLabviewValueExt (BSTR vi_name, BSTR control_name, const VARIANT &value, VARIANT *results)

void	callLabview (BSTR vi_name, VARIANT &names, VARIANT &values, VARIANT_BOOL reentrant, VARIANT *results)

void	waitForLabviewBoolean (BSTR vi_name, BSTR control_name, bool value)

COAUTHIDENTITY *	createIdentity (const std::string &user, const std::string &domain, const std::string &pass)

HRESULT	setIdentity (COAUTHIDENTITY pidentity, IUnknown pUnk)

void	stopVis (bool only_ones_we_started)

bool	checkOption (lvDCOMOptions option)

double	getLabviewUptime ()
	returns -1.0 if labview not running, else labview uptime in seconds More...

std::string	getLabviewValueType (BSTR vi_name, BSTR control_name)
	determine best epics type for a labvier variable, this will be used to choose the appropriate EPICS record template to use More...

double	waitForLabVIEW ()
	wait for LabVIEW to have been running for m_minLVUptime seconds More...

void	maybeWaitForLabVIEWOrExit ()

void	getBlockDetails (std::vector< std::vector< std::string > > &values)

Static Private Member Functions
static void	epicsExitFunc (void *arg)

Private Attributes
std::string	m_configSection
	section of configFile to load information from More...

std::string	m_configFile

std::string	m_host

std::string	m_progid

CLSID	m_clsid

std::string	m_username

std::string	m_password

int	m_options
	the various lvDCOMOptions currently in use More...

vi_map_t	m_vimap

epicsMutex	m_lock

IXMLDOMDocument2 *	m_pxmldom

CComBSTR	m_extint

CComPtr< LabVIEW::_Application >	m_lv

COAUTHIDENTITY *	m_pidentity

std::map< std::string, std::string >	m_xpath_map

std::map< std::string, bool >	m_xpath_bool_map

MAC_HANDLE *	m_mac_env

Static Private Attributes
static double	m_minLVUptime = 60.0
	minimum time labview must be running before connection made in "lvNoStart" mode More...

static std::vector < std::vector< std::string > >	m_seci_values
	horrible - do properly some time More...

Detailed Description

Manager class for LabVIEW DCOM Interaction. Parses an lvinput.xml file and provides access to the LabVIEW VI controls/indicators described within.

Definition at line 80 of file lvDCOMInterface.h.

Member Typedef Documentation

typedef std::map<std::wstring, ViRef> lvDCOMInterface::vi_map_t

private

Definition at line 109 of file lvDCOMInterface.h.

Constructor & Destructor Documentation

lvDCOMInterface::lvDCOMInterface	(	const char *	configSection,
		const char *	configFile,
		const char *	host,
		int	options,
		const char *	progid,
		const char *	username,
		const char *	password
	)

section name of configFile we will load settings from

Parameters

[in]	configSection
[in]	configFile	Path to the XML input file to load configuration information from.
[in]	host	host name where LabVIEW is running ("" for localhost)
[in]	options	options as per lvDCOMOptions enum
[in]	progid	(optional) DCOM ProgID (required if connecting to a compiled LabVIEW application)
[in]	username	(optional) remote username for host
[in]	password	(optional) remote password for username on host

Definition at line 335 of file lvDCOMInterface.cpp.

References checkOption(), LabVIEW::CLSID_Application, DomFromCOM(), doPath(), envExpand(), epicsExitFunc(), initCOM(), lvNoStart, m_clsid, m_configFile, m_extint, m_host, m_mac_env, m_progid, m_pxmldom, onceId, and waitForLabVIEW().

lvDCOMInterface::~lvDCOMInterface ( )

inline

Definition at line 89 of file lvDCOMInterface.h.

References m_pxmldom.

Member Function Documentation

void lvDCOMInterface::callLabview	(	BSTR	vi_name,
		VARIANT &	names,
		VARIANT &	values,
		VARIANT_BOOL	reentrant,
		VARIANT *	results
	)

private

Definition at line 1307 of file lvDCOMInterface.cpp.

References getViRef().

Referenced by setLabviewValueExt().

bool lvDCOMInterface::checkForNewBlockDetails ( )

Definition at line 525 of file lvDCOMInterface.cpp.

References getBlockDetails(), lvSECIConfig, m_options, and m_seci_values.

Referenced by lvDCOMDriver::lvDCOMTask().

bool lvDCOMInterface::checkOption ( lvDCOMOptions option )

inlineprivate

Definition at line 136 of file lvDCOMInterface.h.

References m_options.

Referenced by createViRef(), epicsExitFunc(), lvDCOMInterface(), and maybeWaitForLabVIEWOrExit().

COAUTHIDENTITY * lvDCOMInterface::createIdentity	(	const std::string &	user,
		const std::string &	domain,
		const std::string &	pass
	)

private

Definition at line 727 of file lvDCOMInterface.cpp.

Referenced by createViRef().

void lvDCOMInterface::createViRef	(	BSTR	vi_name,
		bool	reentrant,
		LabVIEW::VirtualInstrumentPtr &	vi
	)

private

Definition at line 862 of file lvDCOMInterface.cpp.

References checkOption(), createIdentity(), LabVIEW::eIdle, initCOM(), m_clsid, m_host, m_lv, m_password, m_pidentity, m_username, m_vimap, maybeWaitForLabVIEWOrExit(), onceId, setIdentity(), ViRef::started, viStartIfIdle, and viWarnIfIdle.

Referenced by getViRef().

double lvDCOMInterface::diffFileTimes	(	const FILETIME &	f1,
		const FILETIME &	f2
	)

static

filetime uses 100ns units, returns difference in seconds

Definition at line 830 of file lvDCOMInterface.cpp.

Referenced by getLabviewUptime().

void lvDCOMInterface::DomFromCOM ( )

private

Definition at line 306 of file lvDCOMInterface.cpp.

References m_pxmldom.

Referenced by lvDCOMInterface().

std::string lvDCOMInterface::doPath ( const std::string & xpath )

Definition at line 299 of file lvDCOMInterface.cpp.

References doXPATH().

Referenced by getLabviewValue(), lvDCOMInterface(), and StringItem::StringItem().

std::string lvDCOMInterface::doXPATH ( const std::string & xpath )

Definition at line 173 of file lvDCOMInterface.cpp.

References envExpand(), m_lock, m_pxmldom, and m_xpath_map.

Referenced by doPath(), getLabviewValue(), and StringItem::StringItem().

bool lvDCOMInterface::doXPATHbool ( const std::string & xpath )

Definition at line 207 of file lvDCOMInterface.cpp.

References envExpand(), m_lock, m_pxmldom, and m_xpath_bool_map.

Referenced by BoolItem::BoolItem().

char * lvDCOMInterface::envExpand ( const char * str )

private

expand epics environment strings using previously saved environment based on EPICS macEnvExpand()

Definition at line 145 of file lvDCOMInterface.cpp.

References m_mac_env.

Referenced by doXPATH(), doXPATHbool(), generateFilesFromSECI(), and lvDCOMInterface().

void lvDCOMInterface::epicsExitFunc ( void * arg )

staticprivate

Definition at line 443 of file lvDCOMInterface.cpp.

References checkOption(), stopVis(), viAlwaysStopOnExit, and viStopOnExitIfStarted.

Referenced by lvDCOMInterface().

int lvDCOMInterface::generateFilesFromSECI	(	const char *	portName,
		const char *	macros,
		const char *	configSection,
		const char *	configFile,
		const char *	dbSubFile,
		const char *	blocks_match,
		bool	no_setter
	)