aace::core::Engine Class Reference

Public Member Functions
virtual bool	configure (std::initializer_list< std::shared_ptr< aace::core::config::EngineConfiguration >> configurationList)=0
virtual bool	configure (std::vector< std::shared_ptr< aace::core::config::EngineConfiguration >> configurationList)=0
virtual bool	configure (std::shared_ptr< aace::core::config::EngineConfiguration > configuration)=0
virtual bool	start ()=0
virtual bool	stop ()=0
virtual bool	shutdown ()=0
virtual bool	registerPlatformInterface (std::shared_ptr< aace::core::PlatformInterface > platformInterface)=0
virtual bool	registerPlatformInterface (std::initializer_list< std::shared_ptr< aace::core::PlatformInterface >> platformInterfaceList)=0
virtual std::shared_ptr< MessageBroker >	getMessageBroker ()=0

Detailed Description

The Engine must be instantiated by the platform implementation. Along with the platform interfaces, it is responsible for managing the interactions between the platform and AVS.

The platform implementation should not extend Engine; it is extended in the SDK.

Member Function Documentation

configure() [1/3]

virtual bool aace::core::Engine::configure ( std::initializer_list< std::shared_ptr< aace::core::config::EngineConfiguration >>  configurationList )

pure virtual

Sets the Engine configuration to a set of configuration objects

Parameters

[in]

configurationList

A collection of aace::core::config::EngineConfiguration objects as an std::initializer_list<aace::core::config::EngineConfiguration*>

Returns

true if the Engine configuration was successful, else false

configure() [2/3]

virtual bool aace::core::Engine::configure ( std::vector< std::shared_ptr< aace::core::config::EngineConfiguration >>  configurationList )

pure virtual

Sets the Engine configuration to a set of configuration objects

Parameters

[in]

configurationList

A collection of aace::core::config::EngineConfiguration objects as an std::vector<aace::core::config::EngineConfiguration*>

Returns

true if the Engine configuration was successful, else false

configure() [3/3]

virtual bool aace::core::Engine::configure ( std::shared_ptr< aace::core::config::EngineConfiguration >  configuration )

pure virtual

Sets the Engine configuration to a single configuration object

Parameters

[in]

configuration

An aace::core::config::EngineConfiguration object

Returns

true if the Engine configuration was successful, else false

start()

virtual bool aace::core::Engine::start ( )

pure virtual

Starts the Engine and attempts to establish a connection to AVS

Returns

true if the Engine was started, else false

See also

stop()

stop()

virtual bool aace::core::Engine::stop ( )

pure virtual

Stops the Engine and shuts down the connection to AVS

Returns

true if the Engine was stopped, else false

See also

start()

shutdown()

virtual bool aace::core::Engine::shutdown ( )

pure virtual

Shuts down the Engine and releases all of its resources

Returns

true if the Engine was shut down, else false

registerPlatformInterface() [1/2]

virtual bool aace::core::Engine::registerPlatformInterface ( std::shared_ptr< aace::core::PlatformInterface >  platformInterface )

pure virtual

Registers a PlatformInterface instance with the Engine

The platform implementation must register each interface required by the application.

Parameters

[in]

platformInterface

The PlatformInterface instance to register

Returns

true if the PlatformInterface instance was registered, else false

See also

aace::core::PlatformInterface

registerPlatformInterface() [2/2]

virtual bool aace::core::Engine::registerPlatformInterface ( std::initializer_list< std::shared_ptr< aace::core::PlatformInterface >>  platformInterfaceList )

pure virtual

Registers a list of PlatformInterface instances with the Engine

The platform implementation must register each interface required by the application.

Parameters

[in]

platformInterfaceList

The list of PlatformInterface instances to register

Returns

true if all PlatformInterface instances were registered, else false

See also

aace::core::PlatformInterface

registerPlatformInterface( std::shared_ptr<aace::core::PlatformInterface> platformInterface )

getMessageBroker()

virtual std::shared_ptr<MessageBroker> aace::core::Engine::getMessageBroker ( )

pure virtual

Returns the Engine's MessageBroker instance.