icl::io::pylon::PylonAutoEnv Struct Reference

Utility Structure. More...

#include <PylonUtils.h>

List of all members.

Public Member Functions
ICLIO_API	PylonAutoEnv ()
	Initializes Pylon environment if not already done.
ICLIO_API	~PylonAutoEnv ()
	Terminates Pylon environment when (calls to term) == (calls to init).
Static Public Member Functions
static ICLIO_API bool	initPylonEnv ()
	Initializes the Pylon environment.
static ICLIO_API bool	termPylonEnv ()
	terminates the Pylon environment.

---

Detailed Description

Utility Structure.

This struct is used to initialize and terminate the pylon environment. It intializes Pylon on creation and terminates it on destruction. Uses a static counter to ensure initialization only on first and termination on last call.

---

Constructor & Destructor Documentation

ICLIO_API icl::io::pylon::PylonAutoEnv::PylonAutoEnv

(

)

Initializes Pylon environment if not already done.

ICLIO_API icl::io::pylon::PylonAutoEnv::~PylonAutoEnv

(

)

Terminates Pylon environment when (calls to term) == (calls to init).

---

Member Function Documentation

static ICLIO_API bool icl::io::pylon::PylonAutoEnv::initPylonEnv

(

)

[static]

Initializes the Pylon environment.

Returns:

whether Pylon::PylonInitialize() actually was called.

static ICLIO_API bool icl::io::pylon::PylonAutoEnv::termPylonEnv

(

)

[static]

terminates the Pylon environment.

Returns:

whether Pylon::PylontTerminate() actually was called.

---

The documentation for this struct was generated from the following file:

• /home/jenkins/workspace/icl-manual-trunk/icl-manual/ICLIO/src/ICLIO/PylonUtils.h