peak::core::PortURL Class Reference

Represents a GenTL port URL. More...

#include <peak/port/peak_port_url.hpp>

Public Member Functions
	PortURL ()=delete
	~PortURL ()=default
	PortURL (const PortURL &other)=delete
PortURL &	operator= (const PortURL &other)=delete
	PortURL (PortURL &&other)=delete
PortURL &	operator= (PortURL &&other)=delete
RawInformation	Info (int32_t infoCommand) const
	Delivers information based on the given GenTL info command.
std::string	URL () const
	Returns the URL.
PortURLScheme	Scheme () const
	Returns the scheme.
std::string	FileName () const
	Returns the file name.
uint64_t	FileRegisterAddress () const
	Returns the file register address.
uint64_t	FileSize () const
	Returns the file size.
std::vector< uint8_t >	FileSHA1Hash () const
	Returns the file SHA1 hash.
int32_t	FileVersionMajor () const
	Returns the file major version.
int32_t	FileVersionMinor () const
	Returns the file major version.
int32_t	FileVersionSubminor () const
	Returns the file subminor version.
int32_t	FileSchemaVersionMajor () const
	Returns the file schema major version.
int32_t	FileSchemaVersionMinor () const
	Returns the file schema minor version.
std::shared_ptr< class Port >	ParentPort () const
	Returns the parent port.

Detailed Description

Represents a GenTL port URL.

This class allows to query information about a GenTL port URL.

Constructor & Destructor Documentation

PortURL() [1/3]

peak::core::PortURL::PortURL ( )

delete

~PortURL()

peak::core::PortURL::~PortURL ( )

default

PortURL() [2/3]

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

delete

PortURL() [3/3]

peak::core::PortURL::PortURL ( PortURL && other )

delete

Member Function Documentation

FileName()

std::string peak::core::PortURL::FileName ( ) const

inline

Returns the file name.

Returns

File name

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

FileRegisterAddress()

uint64_t peak::core::PortURL::FileRegisterAddress ( ) const

inline

Returns the file register address.

Returns

File register address

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

FileSchemaVersionMajor()

int32_t peak::core::PortURL::FileSchemaVersionMajor ( ) const

inline

Returns the file schema major version.

Returns

File schema major version

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

FileSchemaVersionMinor()

int32_t peak::core::PortURL::FileSchemaVersionMinor ( ) const

inline

Returns the file schema minor version.

Returns

File schema minor version

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

FileSHA1Hash()

std::vector< uint8_t > peak::core::PortURL::FileSHA1Hash ( ) const

inline

Returns the file SHA1 hash.

Returns

File SHA1 hash

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

FileSize()

uint64_t peak::core::PortURL::FileSize ( ) const

inline

Returns the file size.

Returns

File size

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

FileVersionMajor()

int32_t peak::core::PortURL::FileVersionMajor ( ) const

inline

Returns the file major version.

Returns

File major version

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

FileVersionMinor()

int32_t peak::core::PortURL::FileVersionMinor ( ) const

inline

Returns the file major version.

Returns

File major version

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

FileVersionSubminor()

int32_t peak::core::PortURL::FileVersionSubminor ( ) const

inline

Returns the file subminor version.

Returns

File subminor version

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

Info()

RawInformation peak::core::PortURL::Info ( int32_t infoCommand ) const

inline

Delivers information based on the given GenTL info command.

Parameters

[in]

infoCommand

The GenTL info command.

This function can be used to query information going beyond the predefined info functions, based on the GenTL info commands of the corresponding module.

Example (error handling is omitted):

#include <peak/thirdparty/GenTL.h>
auto info = object->Info(GenTL::XX_INFO_XX);
 
// Cast depending on the delivered data type
if (info.dataType == GenTL::INFO_DATATYPE_UINT64)
{
    uint64_t uint64Var = *reinterpret_cast<const uint64_t*>(info.data.data());
    // Do something with the information
}
else if (infoDataTypeVar == GenTL::INFO_DATATYPE_INT64)
{
    ...
}
...

Returns

Raw information according to the passed info command

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

ParentPort()

std::shared_ptr< Port > peak::core::PortURL::ParentPort ( ) const

inline

Returns the parent port.

Returns

Parent port

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

Scheme()

PortURLScheme peak::core::PortURL::Scheme ( ) const

inline

Returns the scheme.

Returns

Scheme

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

URL()

std::string peak::core::PortURL::URL ( ) const

inline

Returns the URL.

Returns

URL

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

---

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

• peak/port/peak_port_url.hpp