dl::IEndpoint Class Reference

Abstract interface for a camera connection endpoint. More...

#include <dlapi.h>

Public Member Functions
virtual	~IEndpoint ()
virtual EEndpointType	getType () const =0
	Returns the endpoint's connection type.
virtual bool	getIsInitialized () const =0
	Returns whether the endpoint has been successfully initialized.
virtual const char *	toString () const =0
	Returns a human-readable description of the endpoint.
virtual const char *	toStringConcise () const =0
	Returns a concise description of the endpoint.

Detailed Description

Abstract interface for a camera connection endpoint.

Provides a DLL-boundary-safe abstraction over the concrete Endpoint class. All string-valued methods accept a caller-supplied buffer rather than returning std::string, which is not safe to pass across DLL boundaries.

Constructor & Destructor Documentation

~IEndpoint()

virtual dl::IEndpoint::~IEndpoint ( )

inlinevirtual

{}

Member Function Documentation

getIsInitialized()

virtual bool dl::IEndpoint::getIsInitialized ( ) const

pure virtual

Returns whether the endpoint has been successfully initialized.

Returns

true if the endpoint is initialized, false otherwise.

getType()

virtual EEndpointType dl::IEndpoint::getType ( ) const

pure virtual

Returns the endpoint's connection type.

Returns

EEndpointType the type of the endpoint.

See also

EEndpointType

toString()

virtual const char * dl::IEndpoint::toString ( ) const

pure virtual

Returns a human-readable description of the endpoint.

Returns

Null-terminated string describing the endpoint. The lifetime of the returned pointer is managed by the implementing object.

toStringConcise()

virtual const char * dl::IEndpoint::toStringConcise ( ) const

pure virtual

Returns a concise description of the endpoint.

Returns

Null-terminated string with a concise endpoint description. The lifetime of the returned pointer is managed by the implementing object.

---

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

• C:/Users/arobi/Perforce/nightly/DL_Imaging/Aluma_Software/dlapi/src/dlapi.h