NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
ILWEFactory Class Referenceabstract

The ILWEFactory interface is the starting point for using LWE (lightweight ethernet aka NMEA450). It's what you use to create other LWE resources. More...

#include <lwe_interface.h>

Inheritance diagram for ILWEFactory:
ISDKComponent

Public Member Functions

virtual SDKResult SDK_CALLTYPE CreateEndpointParameters (ISDKParametersSP &params) const =0 throw ()
 Creates default parameters needed for the endpoint. More...
 
virtual SDKResult SDK_CALLTYPE CreateEndpoint (const EndpointId &id, const ISDKParametersSP &parameters, ILWEEndpointSP &endpoint) const =0 throw ()
 Creates an endpoint with a specified SFI and parameters. More...
 
virtual SDKResult SDK_CALLTYPE CreateComposer (const EndpointId &id, ILWEComposerSP &composer) const =0 throw ()
 Creates a composer with a specified SFI. More...
 
- Public Member Functions inherited from ISDKComponent
virtual SDKAtomicRefCount SDK_CALLTYPE AddRef () const =0 throw ()
 Increments the reference count for an interface on a component.

 
virtual SDKAtomicRefCount SDK_CALLTYPE Release () const =0 throw ()
 Decrements the reference count for an interface on a component.
 
virtual SDKResult SDK_CALLTYPE GetInterface (const InterfaceId &id, void **obj_ptr)=0 throw ()
 Returns pointers to the supported interfaces on a component.
 
template<typename _Itf >
SDKResult GetInterface (_Itf **obj_ptr) throw ()
 Returns pointers to the supported interfaces on a component.
 

Detailed Description

The ILWEFactory interface is the starting point for using LWE (lightweight ethernet aka NMEA450). It's what you use to create other LWE resources.

Member Function Documentation

◆ CreateEndpointParameters()

virtual SDKResult SDK_CALLTYPE CreateEndpointParameters ( ISDKParametersSP &  params) const
throw (
)
pure virtual

Creates default parameters needed for the endpoint.

Parameters
[out]paramsISDKParameters interface associated with the endpoint parameters
Returns
SDKResult_Succeeded or an error if fails

◆ CreateEndpoint()

virtual SDKResult SDK_CALLTYPE CreateEndpoint ( const EndpointId &  id,
const ISDKParametersSP &  parameters,
ILWEEndpointSP &  endpoint 
) const
throw (
)
pure virtual

Creates an endpoint with a specified SFI and parameters.

Parameters
[in]idThe SFI name
[in]parametersISDKParameters interface associated with the endpoint parameters
[out]endpointILWEEndpoint interface associated with the specified SFI
Returns
SDKResult_Succeeded or an error if fails

◆ CreateComposer()

virtual SDKResult SDK_CALLTYPE CreateComposer ( const EndpointId &  id,
ILWEComposerSP &  composer 
) const
throw (
)
pure virtual

Creates a composer with a specified SFI.

Parameters
[in]idThe SFI name
[out]endpointILWEComposer interface associated with the specified SFI
Returns
SDKResult_Succeeded or an error if fails

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