SG::IAuxSetOption Class Reference

Abstract interface for setting a option on a aux data container. More...

#include <IAuxSetOption.h>

Inheritance diagram for SG::IAuxSetOption:

Collaboration diagram for SG::IAuxSetOption:

Public Member Functions
virtual	~IAuxSetOption ()=default
	Make sure this class has a vtable. More...
virtual bool	setOption (const AuxDataOption &option)=0
	Make an option setting. More...

Detailed Description

Abstract interface for setting a option on a aux data container.

A container used to hold auxiliary data can optionally provide this interface. This allows user code to set options for the container via the setOption interface.

This is used, for example, to set packing parameters for PackedContainer.

Definition at line 35 of file IAuxSetOption.h.

Constructor & Destructor Documentation

~IAuxSetOption()

virtual SG::IAuxSetOption::~IAuxSetOption ( )

virtualdefault

Make sure this class has a vtable.

Member Function Documentation

setOption()

virtual bool SG::IAuxSetOption::setOption ( const AuxDataOption &  option )

pure virtual

Make an option setting.

Parameters

option

The option to set.

The interpretation of the option depends on the concrete class.

Returns true if the option setting was successful; false otherwise.

Implemented in SG::PackedContainer< T, ALLOC >.

---

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

• IAuxSetOption.h