TypeAdaptors provide a way for Connections to pass DataObjects that are not the same type from the source (ie an Output) to the destination (ie an InputScalar) of a connection. The main thing subclasses must do is implement the adapt() member function to perform the actual adaption from the source to the destination.
Subclasses would generally be creating new underlying data for the DataObject at the destination of the connection. The main exception to this is when the adaptor is converting between a derived class and its base class.
TypeAdaptors may be used outside of connections, but special care must be taken to ensure that the data objects can be converted and that the TypeAdaptor is deleted appropriately.
Performs the conversion between DataObjects.
- Parameters
-
| src | The DataObject that will be converted and stored in dest. |
| dest | The destination of the converted DataObject |
| copy | Whether a copy should occur regardless of whether or not a copy can be avoided. |
Some adapt() calls will always effectively make a copy, since they create a different data type from the source. Some, however, are able to make the destination data object re-use the source, such as when the destination is a base class of the source' data type.
- Returns
- true if the conversion was successful, false if the conversion was unsuccessful.
All TypeAdaptor subclasses are required to override this function and must respect the copy flag.
Implemented in Array3dAdaptor< From, To >, ArrayNdDimensionLabelsToStringListAdaptor, DataSeriesAdaptor< T >, DataSeriesToQVariantAdaptor, QVariantToDataSeriesAdaptor, ImageToOverlayAdaptor, QVariantToQImageAdaptor, MeshModelInterfaceToMeshModelAdaptor, MeshModelToMeshModelInterfaceAdaptor, TypedNullOperationMeshModelFilterAdaptor, TypedScalarNodeStateFilterAdaptor, TransformGroupAdaptor, NumPyToArray3dScalarAdaptor, ImageToSceneOverlayAdaptor, TransformToTransformGroupAdaptor, DateTimeToStringAdaptor, DependencyDateTimeAdaptor, QVariantToQVectorDoubleAdaptor, QVariantToQVectorIntAdaptor, QVariantToQVectorDateTimeAdaptor, TimeToStringAdaptor, AssignmentAdaptor< From, To >, DerivedToBaseAdaptor< D, B >, DoubleToStringAdaptor, EnumToIntAdaptor< T >, IntToStringAdaptor, JsonObjectGroupAdaptorBase< From, To >, JsonObjectGroupAdaptorBase< From, QJsonDocument >, JsonObjectGroupAdaptorBase< QJsonDocument, To >, JsonObjectGroupAdaptor< QJsonDocument, To >, JsonObjectGroupAdaptor< From, QJsonDocument >, SimpleAdaptor< From, To >, SimpleDataObjectAdaptor< From, To >, AdaptFromQVariant< T >, and AdaptToQVariant< T >.
| bool connectConversionAction |
( |
QAction & |
action | ) |
|
|
virtual |
- Parameters
-
| action | A QAction that will be used in things like a context menu. |
Subclasses should only reimplement this function if they need to provide some degree of configurability for their type adaptor. If the subclass does reimplement the function, it must do at least two things:
- Connect the action to a slot so that the type adaptor will handle the action being triggered.
- Return true to indicate that the action will be handled.
In addition, the subclass would not normally change the text, icon or shortcut of the action. In fact, the only thing a subclass should do is make a signal/slot connection to it. When the user triggers this action, they would expect to be presented with a dialog box through which they could configure any relevant settings specific to this type adaptor. For example, an adaptor that converts from double to QString would add a signal/slot connection to action, with that slot opening a dialog box with settings for things like the precision, field width, floating point format, etc.
- Returns
- True if the action will be handled, or false if the action is not needed. If the return value is false, the caller will typically end up deleting the action again.
Reimplemented in ArrayNdDimensionLabelsToStringListAdaptor, ImageToOverlayAdaptor, ImageToSceneOverlayAdaptor, DoubleToStringAdaptor, and IntToStringAdaptor.
Public Member Functions inherited from Serialize