rcg::System Class Reference

#include <system.h>

List of all members.

Public Member Functions
void	close ()
const std::string &	getFilename () const
void *	getHandle () const
std::string	getID () const
std::vector< std::shared_ptr < Interface > >	getInterfaces ()
int	getMajorVersion () const
int	getMinorVersion () const
std::string	getModel () const
std::shared_ptr < GenApi::CNodeMapRef >	getNodeMap ()
std::string	getPathname () const
std::string	getTLType () const
std::string	getVendor () const
std::string	getVersion () const
bool	isCharEncodingASCII () const
void	open ()
	~System ()
Static Public Member Functions
static void	clearSystems ()
static std::vector < std::shared_ptr< System > >	getSystems ()
Private Member Functions
System &	operator= (const System &)
	System (const std::string &_filename)
	System (class System &)
Private Attributes
std::shared_ptr< CPort >	cport
std::string	filename
std::shared_ptr< const GenTLWrapper >	gentl
std::vector< std::weak_ptr < Interface > >	ilist
int	n_open
std::shared_ptr < GenApi::CNodeMapRef >	nodemap
void *	tl

---

Detailed Description

The system class encapsulates a Genicam transport layer.

NOTE: A GenTLException is thrown in case of a severe error.

Definition at line 57 of file system.h.

---

Constructor & Destructor Documentation

rcg::System::~System

(

)

Definition at line 48 of file system.cc.

rcg::System::System

(

const std::string &

_filename

)

[private]

Definition at line 415 of file system.cc.

rcg::System::System

(

class System &

)

[private]

---

Member Function Documentation

void rcg::System::clearSystems

(

)

[static]

Clears the internal list of systems. This may be called before exit so that all resources are cleaned before leaving the main function.

Definition at line 142 of file system.cc.

void rcg::System::close

(

)

Closes the system. Each call of open() must be followed by a call to close() at some point in time.

Definition at line 165 of file system.cc.

const std::string & rcg::System::getFilename

(

)

const

Get file name from which this system was created.

Returns:

File name.

Definition at line 147 of file system.cc.

void * rcg::System::getHandle

(

)

const

Get internal handle of open transport layer.

Returns:

Internal handle.

Definition at line 410 of file system.cc.

std::string rcg::System::getID

(

)

const

Returns the ID of the GenTL provider.

Returns:

ID.

Definition at line 304 of file system.cc.

std::vector< std::shared_ptr< Interface > > rcg::System::getInterfaces

(

)

Returns the currently available interfaces.

NOTE: open() must be called before calling this method.

Returns:

List of interfaces.

Definition at line 200 of file system.cc.

int rcg::System::getMajorVersion

(

)

const

Returns the major version number.

Returns:

Major version number.

Definition at line 361 of file system.cc.

int rcg::System::getMinorVersion

(

)

const

Returns the minor version number.

Returns:

Minor version number.

Definition at line 380 of file system.cc.

std::string rcg::System::getModel

(

)

const

Returns the model of the GenTL provider.

Returns:

Model.

Definition at line 314 of file system.cc.

std::shared_ptr< GenApi::CNodeMapRef > rcg::System::getNodeMap

(

)

Returns the node map of this object.

NOTE: open() must be called before calling this method. The returned pointer remains valid until close() of this object is called.

Returns:

Node map of this object.

Definition at line 399 of file system.cc.

std::string rcg::System::getPathname

(

)

const

Returns the path name of the GenTL provider.

Returns:

Path name.

Definition at line 329 of file system.cc.

std::vector< std::shared_ptr< System > > rcg::System::getSystems

(

)

[static]

Returns a list of systems (i.e. transport layers) that is currently available. For discovering available transport layers, the environment variable GENICAM_GENTL32_PATH or GENICAM_GENTL64_PATH (depending on the compilation with 32 or 64 bit) is used. In case the environment variable is not set or is empty, a default path is used, which points to the GenTL layer that is bundled with rc_genicam_api.

NOTE: This is the only method that can instantiate System objects.

Returns:

List of all available transport layers.

Definition at line 78 of file system.cc.

std::string rcg::System::getTLType

(

)

const

Returns the transport layer type of the GenTL provider.

Returns:

Transport layer type.

Definition at line 324 of file system.cc.

std::string rcg::System::getVendor

(

)

const

Returns the vendor name of the GenTL provider.

Returns:

Vendor name.

Definition at line 309 of file system.cc.

std::string rcg::System::getVersion

(

)

const

Returns the version of the GenTL provider.

Returns:

Version.

Definition at line 319 of file system.cc.

bool rcg::System::isCharEncodingASCII

(

)

const

Returns the character encoding.

Returns:

True for ASCII, false for UTF8.

Definition at line 334 of file system.cc.

void rcg::System::open

(

)

Opens the system for working with it. The system may be opened multiple times. However, for each open(), the close() method must be called as well.

Definition at line 152 of file system.cc.

System& rcg::System::operator=

(

const System &

)

[private]

---

Member Data Documentation

std::shared_ptr<CPort> rcg::System::cport [private]

Definition at line 221 of file system.h.

std::string rcg::System::filename [private]

Definition at line 215 of file system.h.

std::shared_ptr<const GenTLWrapper> rcg::System::gentl [private]

Definition at line 216 of file system.h.

std::vector<std::weak_ptr<Interface> > rcg::System::ilist [private]

Definition at line 224 of file system.h.

int rcg::System::n_open [private]

Definition at line 218 of file system.h.

std::shared_ptr<GenApi::CNodeMapRef> rcg::System::nodemap [private]

Definition at line 222 of file system.h.

void* rcg::System::tl [private]

Definition at line 219 of file system.h.

---

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

• system.h
• system.cc