peak::core::ProducerLibrary Class Reference

Represents a GenTL producer library (CTI). More...

#include <peak/producer_library/peak_producer_library.hpp>

Inheritance diagram for peak::core::ProducerLibrary:

Public Member Functions
	ProducerLibrary ()=delete
	~ProducerLibrary () override
	ProducerLibrary (const ProducerLibrary &other)=delete
ProducerLibrary &	operator= (const ProducerLibrary &other)=delete
	ProducerLibrary (ProducerLibrary &&other)=delete
ProducerLibrary &	operator= (ProducerLibrary &&other)=delete
std::string	Key () const
	Returns the unique key.
std::shared_ptr< SystemDescriptor >	System () const
	Returns the system descriptor.

Static Public Member Functions
static std::shared_ptr< ProducerLibrary >	Open (const std::string &ctiPath)
	Opens the given producer library (CTI).

Detailed Description

Represents a GenTL producer library (CTI).

This class allows to load and initialize a GenTL producer library (CTI) and access its functionality. Each ProducerLibrary contains exactly one SystemDescriptor, which allows you to open the corresponding System.

Constructor & Destructor Documentation

ProducerLibrary() [1/3]

peak::core::ProducerLibrary::ProducerLibrary ( )

delete

~ProducerLibrary()

peak::core::ProducerLibrary::~ProducerLibrary ( )

inlineoverride

ProducerLibrary() [2/3]

peak::core::ProducerLibrary::ProducerLibrary ( const ProducerLibrary &  other )

delete

ProducerLibrary() [3/3]

peak::core::ProducerLibrary::ProducerLibrary ( ProducerLibrary &&  other )

delete

Member Function Documentation

Key()

std::string peak::core::ProducerLibrary::Key ( ) const

inline

Returns the unique key.

The returned key is unique even across different producer libraries.

Returns

Unique key

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

Open()

std::shared_ptr< ProducerLibrary > peak::core::ProducerLibrary::Open ( const std::string &  ctiPath )

inlinestatic

Opens the given producer library (CTI).

Parameters

[in]

ctiPath

The path of the producer library (CTI) to open.

Returns

Producer library

Since

1.0

Exceptions

InternalErrorException	An internal error has occurred.
CTILoadingException	Loading the cti failed.

operator=() [1/2]

ProducerLibrary & peak::core::ProducerLibrary::operator= ( const ProducerLibrary &  other )

delete

operator=() [2/2]

ProducerLibrary & peak::core::ProducerLibrary::operator= ( ProducerLibrary &&  other )

delete

System()

std::shared_ptr< SystemDescriptor > peak::core::ProducerLibrary::System ( ) const

inline

Returns the system descriptor.

The returned system descriptor can be used to query information about the GenTL system module without opening it and to open the GenTL system module.

Returns

System descriptor

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

---

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

• peak/producer_library/peak_producer_library.hpp