Files | |
| file | ApiUtilities.h |
| file | DynamicTypes.h |
| file | GeographicData.h |
| file | Metadata.h |
| file | RasterData.h |
| file | SimpleAnimation.h |
| file | SimpleAoi.h |
| file | SimpleApiErrors.h |
| file | SimpleExecution.h |
| file | SimpleSignature.h |
| file | SimpleViews.h |
Classes | |
| struct | Gcp |
| The in-memory definition of a GCP point. More... | |
| struct | DataInfo |
| Descriptor for data dimensions. More... | |
| struct | RasterElementArgs |
| Descriptor for creating a RasterElement. More... | |
| struct | DataPointerArgs |
| Descriptor for data access. More... | |
| struct | DataAccessorArgs |
| Descriptor for data access. More... | |
| struct | ThresholdLayerInfo |
| Threshold Layers ///////////////////. More... | |
| struct | RasterLayerStretchInfo |
| Raster Layers ////////////////. More... | |
| struct | RasterStatistics |
| Raster statistics structure. More... | |
Defines | |
| #define | SIMPLE_NO_ERROR 0 |
| #define | SIMPLE_WRONG_TYPE 1 |
| #define | SIMPLE_NOT_FOUND 2 |
| #define | SIMPLE_BAD_PARAMS 3 |
| #define | SIMPLE_BUFFER_SIZE 4 |
| #define | SIMPLE_NO_MEM 5 |
| #define | SIMPLE_EXISTS 6 |
| #define | SIMPLE_WRONG_VIEW_TYPE 7 |
| #define | SIMPLE_OTHER_FAILURE -1 |
Typedefs | |
| typedef void(* | animation_callback_t )(const char *pAnimation, const char *pFrameName, uint32_t frameNumber, double frameTime, void *pUser) |
Functions | |
| EXPORT_SYMBOL void | setHandle (void *pExternal) |
| EXPORT_SYMBOL void * | handle () |
| EXPORT_SYMBOL uint32_t | getOpticksVersion (char *pVersion, uint32_t versionSize) |
| EXPORT_SYMBOL uint32_t | getTestDataPath (char *pPath, uint32_t pathSize) |
| EXPORT_SYMBOL uint32_t | loadFile (const char *pFilename, int batch) |
| EXPORT_SYMBOL DataElement * | getDataElement (const char *pName, const char *pType, int create) |
| EXPORT_SYMBOL void | destroyDataElement (DataElement *pElement) |
| EXPORT_SYMBOL uint32_t | getDataElementName (DataElement *pElement, char *pName, uint32_t nameSize) |
| EXPORT_SYMBOL uint32_t | getDataElementType (DataElement *pElement, char *pType, uint32_t typeSize) |
| EXPORT_SYMBOL uint32_t | getDataElementFilename (DataElement *pElement, char *pFilename, uint32_t filenameSize) |
| EXPORT_SYMBOL uint32_t | getDataElementChildCount (DataElement *pElement) |
| EXPORT_SYMBOL DataElement * | getDataElementChild (DataElement *pElement, uint32_t index) |
| EXPORT_SYMBOL void * | castDataElement (DataElement *pElement, const char *pType) |
| EXPORT_SYMBOL DataElement * | castToDataElement (void *pElement, const char *pType) |
| EXPORT_SYMBOL void * | castLayer (Layer *pLayer, const char *pType) |
| EXPORT_SYMBOL void | copyClassification (DataElement *pCopyFrom, DataElement *pCopyTo) |
| EXPORT_SYMBOL DataVariant * | createDataVariant (const char *pType, const void *pValue) |
| EXPORT_SYMBOL DataVariant * | createDataVariantFromString (const char *pType, const char *pValue, int xml) |
| EXPORT_SYMBOL void | freeDataVariant (DataVariant *pDv) |
| EXPORT_SYMBOL int | isDataVariantValid (DataVariant *pDv) |
| EXPORT_SYMBOL uint32_t | getDataVariantTypeName (DataVariant *pDv, char *pType, uint32_t typeSize) |
| EXPORT_SYMBOL void * | getDataVariantValue (DataVariant *pDv) |
| EXPORT_SYMBOL uint32_t | getDataVariantValueString (DataVariant *pDv, int xml, char *pValue, uint32_t valueSize) |
| EXPORT_SYMBOL uint32_t | vectorToArray (void *pValue, const char *pType, void **pOutValue) |
| EXPORT_SYMBOL void | freePlugInArgList (PlugInArgList *pPial) |
| EXPORT_SYMBOL uint32_t | getPlugInArgCount (PlugInArgList *pPial) |
| EXPORT_SYMBOL PlugInArg * | getPlugInArgByName (PlugInArgList *pPial, const char *pArgName) |
| EXPORT_SYMBOL PlugInArg * | getPlugInArgByIndex (PlugInArgList *pPial, uint32_t argNum) |
| EXPORT_SYMBOL uint32_t | getPlugInArgName (PlugInArg *pPia, char *pName, uint32_t nameSize) |
| EXPORT_SYMBOL uint32_t | getPlugInArgTypeName (PlugInArg *pPia, char *pType, uint32_t typeSize) |
| EXPORT_SYMBOL uint32_t | getPlugInArgDescription (PlugInArg *pPia, char *pDesc, uint32_t descSize) |
| EXPORT_SYMBOL int | isPlugInArgDefaultSet (PlugInArg *pPia) |
| EXPORT_SYMBOL int | isPlugInArgActualSet (PlugInArg *pPia) |
| EXPORT_SYMBOL void * | getPlugInArgDefaultValue (PlugInArg *pPia) |
| EXPORT_SYMBOL void * | getPlugInArgActualValue (PlugInArg *pPia) |
| EXPORT_SYMBOL void * | getPlugInArgValue (PlugInArg *pPia) |
| EXPORT_SYMBOL void | setPlugInArgDefaultValueFromVoid (PlugInArg *pPia, void *pValue) |
| EXPORT_SYMBOL void | setPlugInArgDefaultValueFromDataVariant (PlugInArg *pPia, DataVariant *pValue) |
| EXPORT_SYMBOL void | setPlugInArgActualValueFromVoid (PlugInArg *pPia, void *pValue) |
| EXPORT_SYMBOL void | setPlugInArgActualValueFromDataVariant (PlugInArg *pPia, DataVariant *pValue) |
| EXPORT_SYMBOL uint32_t | getGcpCount (DataElement *pList) |
| EXPORT_SYMBOL struct Gcp | getGcpPoint (DataElement *pList, uint32_t index) |
| EXPORT_SYMBOL uint32_t | getGcpPoints (DataElement *pList, struct Gcp *pPoints) |
| EXPORT_SYMBOL uint32_t | setGcpPoints (DataElement *pList, uint32_t count, struct Gcp *pPoints) |
| EXPORT_SYMBOL DynamicObject * | createDynamicObject () |
| EXPORT_SYMBOL void | freeDynamicObject (DynamicObject *pDynamicObject) |
| EXPORT_SYMBOL DynamicObject * | getDataElementMetadata (DataElement *pElement) |
| EXPORT_SYMBOL uint32_t | getMetadataAttributeCount (DynamicObject *pMeta) |
| EXPORT_SYMBOL uint32_t | getMetadataAttributeName (DynamicObject *pMeta, uint32_t attributeIndex, char *pName, uint32_t nameSize) |
| EXPORT_SYMBOL DataVariant * | getMetadataAttribute (DynamicObject *pMeta, const char *pName) |
| EXPORT_SYMBOL DataVariant * | getMetadataAttributeByPath (DynamicObject *pMeta, const char *pPath) |
| EXPORT_SYMBOL void | setMetadataAttribute (DynamicObject *pMeta, const char *pName, DataVariant *pValue) |
| EXPORT_SYMBOL void | setMetadataAttributeByPath (DynamicObject *pMeta, const char *pPath, DataVariant *pValue) |
| EXPORT_SYMBOL void | removeMetadataAttribute (DynamicObject *pMeta, const char *pName) |
| EXPORT_SYMBOL void | removeMetadataAttributeByPath (DynamicObject *pMeta, const char *pPath) |
| EXPORT_SYMBOL void | clearMetadata (DynamicObject *pMeta) |
| EXPORT_SYMBOL DataVariant * | getConfigurationSetting (const char *pSettingKey) |
| EXPORT_SYMBOL int | setConfigurationSetting (const char *pSettingKey, DataVariant *pValue) |
| EXPORT_SYMBOL int | copyConfigurationSetting (const char *pSettingKey, DynamicObject *pDynamicObject) |
| EXPORT_SYMBOL int | serializeConfigurationSettingDefaults (const char *pFilename, DynamicObject *pDynamicObject) |
| EXPORT_SYMBOL DataInfo * | createDataInfo (DataElement *pElement) |
| EXPORT_SYMBOL void | destroyDataInfo (DataInfo *pDataInfo) |
| EXPORT_SYMBOL DataElement * | createRasterElement (const char *pName, RasterElementArgs args) |
| EXPORT_SYMBOL void * | createDataPointer (DataElement *pElement, DataPointerArgs *pArgs, int *pOwn) |
| EXPORT_SYMBOL void | destroyDataPointer (void *pData) |
| EXPORT_SYMBOL int | copyDataToRasterElement (DataElement *pElement, DataPointerArgs *pArgs, void *pData) |
| EXPORT_SYMBOL void | updateRasterElement (DataElement *pElement) |
| EXPORT_SYMBOL DataAccessorImpl * | createDataAccessor (DataElement *pElement, DataAccessorArgs *pArgs) |
| EXPORT_SYMBOL void | destroyDataAccessor (DataAccessorImpl *pAccessor) |
| EXPORT_SYMBOL int | isDataAccessorValid (DataAccessorImpl *pAccessor) |
| EXPORT_SYMBOL void * | getDataAccessorRow (DataAccessorImpl *pAccessor) |
| EXPORT_SYMBOL void | nextDataAccessorRow (DataAccessorImpl *pAccessor, uint32_t count, int resetColumn) |
| EXPORT_SYMBOL void * | getDataAccessorColumn (DataAccessorImpl *pAccessor) |
| EXPORT_SYMBOL void | nextDataAccessorColumn (DataAccessorImpl *pAccessor, uint32_t count) |
| EXPORT_SYMBOL void | toDataAccessorPixel (DataAccessorImpl *pAccessor, uint32_t row, uint32_t column) |
| EXPORT_SYMBOL RasterElement * | getDataAccessorRasterElement (DataAccessorImpl *pAccessor) |
| EXPORT_SYMBOL uint32_t | getDataAccessorRowSize (DataAccessorImpl *pAccessor) |
| EXPORT_SYMBOL AnimationController * | getAnimationController (const char *pName) |
| EXPORT_SYMBOL AnimationController * | createAnimationController (const char *pName, int timeBased) |
| EXPORT_SYMBOL void | destroyAnimationController (AnimationController *pController) |
| EXPORT_SYMBOL int | activateAnimationController (AnimationController *pController) |
| EXPORT_SYMBOL uint32_t | getAnimationControllerState (AnimationController *pController) |
| EXPORT_SYMBOL int | setAnimationControllerState (AnimationController *pController, uint32_t state) |
| EXPORT_SYMBOL int | playAnimationController (AnimationController *pController) |
| EXPORT_SYMBOL int | pauseAnimationController (AnimationController *pController) |
| EXPORT_SYMBOL int | stopAnimationController (AnimationController *pController) |
| EXPORT_SYMBOL uint32_t | getAnimationControllerCycle (AnimationController *pController) |
| EXPORT_SYMBOL int | setAnimationControllerCycle (AnimationController *pController, uint32_t cycle) |
| EXPORT_SYMBOL int | canAnimationControllerDropFrames (AnimationController *pController) |
| EXPORT_SYMBOL int | setAnimationControllerCanDropFrames (AnimationController *pController, int dropFrames) |
| EXPORT_SYMBOL double | getAnimationControllerIntervalMultiplier (AnimationController *pController) |
| EXPORT_SYMBOL int | setAnimationControllerIntervalMultiplier (AnimationController *pController, double multiplier) |
| EXPORT_SYMBOL int | attachRasterLayerToAnimationController (AnimationController *pController, Layer *pLayer) |
| EXPORT_SYMBOL void * | attachCallbackToAnimationController (AnimationController *pController, const char *pName, animation_callback_t pCallback, void *pUser, uint32_t frameCount, double *pFrameTimes) |
| EXPORT_SYMBOL void | destroyAnimationControllerAttachment (AnimationController *pController, const char *pName, void *pHandler) |
| EXPORT_SYMBOL int | getAoiValue (DataElement *pElement, int32_t x, int32_t y) |
| EXPORT_SYMBOL int | setAoiValue (DataElement *pElement, uint32_t x, uint32_t y, int value) |
| EXPORT_SYMBOL int | getAoiMinimalBoundingBox (DataElement *pElement, int32_t *pX1, int32_t *pY1, int32_t *pX2, int32_t *pY2) |
| EXPORT_SYMBOL BitMaskIterator * | createAoiIteratorOverRaster (DataElement *pElement, DataElement *pRaster) |
| EXPORT_SYMBOL BitMaskIterator * | createAoiIteratorOverBoundingBox (DataElement *pElement, int32_t x1, int32_t y1, int32_t x2, int32_t y2) |
| EXPORT_SYMBOL void | freeAoiIterator (BitMaskIterator *pIter) |
| EXPORT_SYMBOL int | nextAoiIterator (BitMaskIterator *pIter) |
| EXPORT_SYMBOL int | getAoiIteratorLocation (BitMaskIterator *pIter, int32_t *pX, int32_t *pY) |
| EXPORT_SYMBOL int | getLastError () |
| EXPORT_SYMBOL const char * | getErrorString (int code) |
| EXPORT_SYMBOL void | setLastError (int code) |
| EXPORT_SYMBOL ExecutableAgent * | createPlugIn (const char *pName, int batch) |
| EXPORT_SYMBOL void | freePlugIn (ExecutableAgent *pPlugin) |
| EXPORT_SYMBOL PlugInArgList * | getPlugInInputArgList (ExecutableAgent *pPlugin) |
| EXPORT_SYMBOL PlugInArgList * | getPlugInOutputArgList (ExecutableAgent *pPlugin) |
| EXPORT_SYMBOL int | executePlugIn (ExecutableAgent *pPlugin) |
| EXPORT_SYMBOL WizardObject * | loadWizard (const char *pFilename) |
| EXPORT_SYMBOL void | freeWizard (WizardObject *pWizard) |
| EXPORT_SYMBOL uint32_t | getWizardName (WizardObject *pWizard, char *pName, uint32_t nameSize) |
| EXPORT_SYMBOL uint32_t | getWizardInputNodeCount (WizardObject *pWizard) |
| EXPORT_SYMBOL uint32_t | getWizardOutputNodeCount (WizardObject *pWizard) |
| EXPORT_SYMBOL WizardNode * | getWizardInputNodeByIndex (WizardObject *pWizard, uint32_t idx) |
| EXPORT_SYMBOL WizardNode * | getWizardInputNodeByName (WizardObject *pWizard, const char *pName) |
| EXPORT_SYMBOL WizardNode * | getWizardOutputNodeByIndex (WizardObject *pWizard, uint32_t idx) |
| EXPORT_SYMBOL WizardNode * | getWizardOutputNodeByName (WizardObject *pWizard, const char *pName) |
| EXPORT_SYMBOL int | executeWizard (WizardObject *pWizard) |
| EXPORT_SYMBOL uint32_t | getWizardNodeName (WizardNode *pNode, char *pName, uint32_t nameSize) |
| EXPORT_SYMBOL uint32_t | getWizardNodeType (WizardNode *pNode, char *pType, uint32_t typeSize) |
| EXPORT_SYMBOL void * | getWizardNodeValue (WizardNode *pNode) |
| EXPORT_SYMBOL int | setWizardNodeValue (WizardNode *pNode, void *pValue) |
| EXPORT_SYMBOL uint32_t | getSignatureDataSetCount (DataElement *pSig) |
| EXPORT_SYMBOL uint32_t | getSignatureDataSetName (DataElement *pSig, uint32_t index, char *pName, uint32_t nameSize) |
| EXPORT_SYMBOL DataVariant * | getSignatureDataSet (DataElement *pSig, const char *pName) |
| EXPORT_SYMBOL int | setSignatureDataSet (DataElement *pSig, const char *pName, DataVariant *pValue) |
| EXPORT_SYMBOL uint32_t | getSignatureSetCount (DataElement *pSet) |
| EXPORT_SYMBOL DataElement * | getSignatureSetSignature (DataElement *pSet, uint32_t index) |
| EXPORT_SYMBOL Layer * | getLayer (const char *pName, const char *pType) |
| EXPORT_SYMBOL void | destroyLayer (Layer *pLayer) |
| EXPORT_SYMBOL uint32_t | getLayerName (Layer *pLayer, char *pName, uint32_t nameSize) |
| EXPORT_SYMBOL uint32_t | getLayerType (Layer *pLayer, char *pType, uint32_t typeSize) |
| EXPORT_SYMBOL DataElement * | getLayerElement (Layer *pLayer) |
| EXPORT_SYMBOL View * | getLayerView (Layer *pLayer) |
| EXPORT_SYMBOL int | getLayerScaleOffset (Layer *pLayer, double *pScaleX, double *pScaleY, double *pOffsetX, double *pOffsetY) |
| EXPORT_SYMBOL int | setLayerScaleOffset (Layer *pLayer, double scaleX, double scaleY, double offsetX, double offsetY) |
| EXPORT_SYMBOL int | isLayerDisplayed (Layer *pLayer) |
| EXPORT_SYMBOL int | setLayerDisplayed (Layer *pLayer, int displayed) |
| EXPORT_SYMBOL Layer * | deriveLayer (Layer *pLayer, const char *pName, const char *pType) |
| EXPORT_SYMBOL Layer * | convertLayer (Layer *pLayer, const char *pType) |
| EXPORT_SYMBOL int | isLayerActive (Layer *pLayer) |
| EXPORT_SYMBOL int | activateLayer (Layer *pLayer) |
| EXPORT_SYMBOL uint32_t | getLayerDisplayIndex (Layer *pLayer) |
| EXPORT_SYMBOL int | setLayerDisplayIndex (Layer *pLayer, uint32_t newIndex) |
| EXPORT_SYMBOL int | getThresholdLayerInfo (Layer *pLayer, struct ThresholdLayerInfo *pInfo) |
| EXPORT_SYMBOL int | setThresholdLayerInfo (Layer *pLayer, struct ThresholdLayerInfo *pInfo) |
| EXPORT_SYMBOL uint32_t | getPseudocolorClassCount (Layer *pLayer) |
| EXPORT_SYMBOL int32_t | getPseudocolorClassId (Layer *pLayer, uint32_t index) |
| EXPORT_SYMBOL uint32_t | getPseudocolorClassName (Layer *pLayer, int32_t id, char *pName, uint32_t nameSize) |
| EXPORT_SYMBOL int32_t | getPseudocolorClassValue (Layer *pLayer, int32_t id) |
| EXPORT_SYMBOL uint32_t | getPseudocolorClassColor (Layer *pLayer, int32_t id) |
| EXPORT_SYMBOL int | isPseudocolorClassDisplayed (Layer *pLayer, int32_t id) |
| EXPORT_SYMBOL int32_t | addPseudocolorClass (Layer *pLayer, const char *pName, int32_t *pValue, uint32_t *pColor, int *pDisplayed) |
| EXPORT_SYMBOL int | setPseudocolorClassName (Layer *pLayer, int32_t id, const char *pName) |
| EXPORT_SYMBOL int | setPseudocolorClassValue (Layer *pLayer, int32_t id, int32_t value) |
| EXPORT_SYMBOL int | setPseudocolorClassColor (Layer *pLayer, int32_t id, uint32_t color) |
| EXPORT_SYMBOL int | setPseudocolorClassDisplayed (Layer *pLayer, int32_t id, int display) |
| EXPORT_SYMBOL int | getRasterLayerStretchInfo (Layer *pLayer, uint32_t channel, struct RasterLayerStretchInfo *pInfo) |
| EXPORT_SYMBOL int | setRasterLayerStretchInfo (Layer *pLayer, uint32_t channel, struct RasterLayerStretchInfo *pInfo) |
| EXPORT_SYMBOL uint32_t | getRasterLayerComplexComponent (Layer *pLayer) |
| EXPORT_SYMBOL int | setRasterLayerComplexComponent (Layer *pLayer, uint32_t component) |
| EXPORT_SYMBOL uint32_t | getRasterLayerColormapName (Layer *pLayer, char *pName, uint32_t nameSize) |
| EXPORT_SYMBOL int | setRasterLayerColormapName (Layer *pLayer, const char *pName) |
| EXPORT_SYMBOL int | getRasterLayerColormapValues (Layer *pLayer, uint32_t *pColormap) |
| EXPORT_SYMBOL int | setRasterLayerColormapValues (Layer *pLayer, const char *pName, uint32_t *pColormap) |
| EXPORT_SYMBOL int | isRasterLayerRgbDisplayed (Layer *pLayer) |
| EXPORT_SYMBOL int | setRasterLayerRgbDisplayed (Layer *pLayer, int rgb) |
| EXPORT_SYMBOL uint32_t | getRasterLayerDisplayedBand (Layer *pLayer, uint32_t channel, DataElement **pElement) |
| EXPORT_SYMBOL int | setRasterLayerDisplayedBand (Layer *pLayer, uint32_t channel, uint32_t band, DataElement *pElement) |
| EXPORT_SYMBOL int | getRasterLayerStatistics (Layer *pLayer, uint32_t channel, uint32_t component, struct RasterStatistics *pStatistics) |
| EXPORT_SYMBOL int | getRasterLayerGpuEnabled (Layer *pLayer) |
| EXPORT_SYMBOL int | setRasterLayerGpuEnabled (Layer *pLayer, int gpu) |
| EXPORT_SYMBOL uint32_t | getRasterLayerFilterCount (Layer *pLayer, int enabled) |
| EXPORT_SYMBOL uint32_t | getRasterLayerFilterName (Layer *pLayer, uint32_t index, int enabled, char *pName, uint32_t nameSize) |
| EXPORT_SYMBOL int | setRasterLayerFilters (Layer *pLayer, uint32_t count, const char **pFilters) |
| EXPORT_SYMBOL int | resetRasterLayerFilter (Layer *pLayer, const char *pFilterName) |
| EXPORT_SYMBOL int | setRasterLayerFilterFrozen (Layer *pLayer, const char *pFilterName, int freeze) |
| EXPORT_SYMBOL View * | getView (const char *pName, const char *pType) |
| EXPORT_SYMBOL View * | createView (const char *pName, const char *pType, DataElement *pElement) |
| EXPORT_SYMBOL void | destroyView (View *pView) |
| EXPORT_SYMBOL uint32_t | getViewName (View *pView, char *pName, uint32_t nameSize) |
| EXPORT_SYMBOL int | setViewName (View *pView, const char *pName) |
| EXPORT_SYMBOL uint32_t | getViewType (View *pView, char *pType, uint32_t typeSize) |
| EXPORT_SYMBOL DataElement * | getViewPrimaryRasterElement (View *pView) |
| EXPORT_SYMBOL Layer * | createLayer (View *pView, DataElement *pElement, const char *pType, const char *pName) |
| EXPORT_SYMBOL uint32_t | getViewLayerCount (View *pView) |
| EXPORT_SYMBOL Layer * | getViewLayer (View *pView, uint32_t index) |
Some C++ classes are passed around and may be treated as opaque pointers but their partial declarations may cause compilation errors. In most cases you can create a preprocessor definition for the class keyword which resolves to typedef void* to resolve these compilation problems.
| #define SIMPLE_BAD_PARAMS 3 |
| #define SIMPLE_BUFFER_SIZE 4 |
| #define SIMPLE_EXISTS 6 |
| #define SIMPLE_NO_ERROR 0 |
| #define SIMPLE_NO_MEM 5 |
| #define SIMPLE_NOT_FOUND 2 |
| #define SIMPLE_OTHER_FAILURE -1 |
| #define SIMPLE_WRONG_TYPE 1 |
| #define SIMPLE_WRONG_VIEW_TYPE 7 |
A SpatialDataView is required.
This is a common View/Layer error so it is distinct from SIMPLE_WRONG_TYPE
Definition at line 76 of file SimpleApiErrors.h.
| typedef void(* animation_callback_t)(const char *pAnimation, const char *pFrameName, uint32_t frameNumber, double frameTime, void *pUser) |
Animation callback function prototype.
Passed a pointer to the Animation which caused the callback to execute. The name, number, and time for the frame are passed in but may be invalid depending on the AnimationController type. (frame type does not have valid frame times). A caller specified value is also passed.
Definition at line 42 of file SimpleAnimation.h.
| EXPORT_SYMBOL int activateAnimationController | ( | AnimationController * | pController | ) |
Activate an AnimationController so that it is controlled by the animation toolbar.
| pController | The AnimationController to activate. |
| EXPORT_SYMBOL int activateLayer | ( | Layer * | pLayer | ) |
Make the specified Layer active.
| pLayer | The Layer to activate. Must be contained in a SpatialDataView. |
| EXPORT_SYMBOL int32_t addPseudocolorClass | ( | Layer * | pLayer, | |
| const char * | pName, | |||
| int32_t * | pValue, | |||
| uint32_t * | pColor, | |||
| int * | pDisplayed | |||
| ) |
Add a new pseudocolor class.
If the new class should be uninitialized, all parameters except pLayer must be NULL. The new class should be initialized, all parameters must be non-NULL.
| pLayer | The PseudocolorLayer to mutate. | |
| pName | If not NULL, the NULL terminated name for the new class. | |
| pValue | If not NULL, the value for the new class. | |
| pColor | If not NULL, the color for the new class. See setPseudocolorClassColor() for this value's encoding. | |
| pDisplayed | If not NULL, set the display state of the new class. Zero will be hidden, non-zero will be displayed. |
| EXPORT_SYMBOL void* attachCallbackToAnimationController | ( | AnimationController * | pController, | |
| const char * | pName, | |||
| animation_callback_t | pCallback, | |||
| void * | pUser, | |||
| uint32_t | frameCount, | |||
| double * | pFrameTimes | |||
| ) |
Attach a callback function to an AnimationController.
| pController | The AnimationController to mutate. | |
| pName | The NULL terminate name of the Animation which attaches the callback. If an attachment with this name exists already, an error will occur. | |
| pCallback | The callback function. | |
| pUser | Handle to pass to the pUser field in the callback. This may be NULL. | |
| frameCount | The number of frames which will be animated. | |
| pFrameTimes | If pController is a frame based AnimationController, this should be NULL. If pController is a time based AnimationController, this is an array of length frameCount with the frame times or if NULL, the start time (or current system time) will be user to generate frameCount times 1 second appart. |
NULL on error or a callback handle. This must be passed to destroyAnimationControllerAttachment() to clean up and release the allocated memory. | EXPORT_SYMBOL int attachRasterLayerToAnimationController | ( | AnimationController * | pController, | |
| Layer * | pLayer | |||
| ) |
Attach a RasterLayer to an AnimationController.
If the controller if frame based, this will attach frames on a one-to-one basis. If the controller is time based, this will attach frames starting at the AnimationController's start time (or current system time if there are no frames in the controller) with a frame rate of 1fps. If the RasterElement in the RasterLayer has a metadata entry in "Special/Band/FrameTimes" which is a vector<double> with a frame time for each frame in the RasterElement, those frame times will be used.
The name of the Animation which attaches the RaseterLayer will be the same as the Layer. If an attachment with this name exists already, an error will occur.
| pController | The AnimationController to mutate. | |
| pLayer | The RasterLayer to attach. |
| EXPORT_SYMBOL int canAnimationControllerDropFrames | ( | AnimationController * | pController | ) |
Will the AnimationController drop frames to maintain the play rate?
| pController | The AnimationController to query. |
| EXPORT_SYMBOL void* castDataElement | ( | DataElement * | pElement, | |
| const char * | pType | |||
| ) |
Cast a DataElement to a sub-type.
| pElement | The DataElement to cast. | |
| pType | The name of the sub-type. |
NULL if the cast is invalid. | EXPORT_SYMBOL void* castLayer | ( | Layer * | pLayer, | |
| const char * | pType | |||
| ) |
| EXPORT_SYMBOL DataElement* castToDataElement | ( | void * | pElement, | |
| const char * | pType | |||
| ) |
Cast a DataElement sub-type to a DataElement.
| pElement | The sub-type to cast as a void*. | |
| pType | The name of the sub-type. |
NULL if the cast is invalid. | EXPORT_SYMBOL void clearMetadata | ( | DynamicObject * | pMeta | ) |
Remove all attributes from a DynamicObject.
| pMeta | The DynamicObject to clear. |
Convert a Layer to a different Layer type.
This actually creates a new Layer of the given type with the same DataElement.
| pLayer | The Layer to convert. Must be contained in a SpatialDataView. This handle will be invalid after a successful return from convertLayer() | |
| pType | The new NULL terminated Layer type name. This uses the XML encoding for LayerType. |
NULL on error or the new Layer handle. | EXPORT_SYMBOL void copyClassification | ( | DataElement * | pCopyFrom, | |
| DataElement * | pCopyTo | |||
| ) |
Copy the classification from a data element to another data element.
| pCopyFrom | The DataElement from which the classification is to be copied. | |
| pCopyTo | The DataElement to which the classification is to be copied. |
| EXPORT_SYMBOL int copyConfigurationSetting | ( | const char * | pSettingKey, | |
| DynamicObject * | pDynamicObject | |||
| ) |
Add the current value of a setting to a DynamicObject for serialization to a defaults file.
| pSettingKey | The NULL terminated setting key. | |
| pDynamicObject | The DynamicObject which will hold the copy. |
| EXPORT_SYMBOL int copyDataToRasterElement | ( | DataElement * | pElement, | |
| DataPointerArgs * | pArgs, | |||
| void * | pData | |||
| ) |
Copy data from a contiguous C array in a RasterElement.
The caller should call updateRasterElement() to redisplay the data.
| pElement | The RasterElement to access. | |
| pArgs | The structure containing information to process the request. This specifies the parameters for the DataAccessor which will be used to write to the RasterElement. If this is NULL and RasterElement::getRawData() returns a valid pointer, a single memcpy() will be used to replace the contents of the RasterElement. | |
| pData | A pointer to a three-dimensional matrix containing raster data. The format of this data must match the information in pArgs or the RasterElement parameters if pArgs is NULL. If necessary, the caller must reformat this data prior to copying it to the RasterElement. |
| EXPORT_SYMBOL AnimationController* createAnimationController | ( | const char * | pName, | |
| int | timeBased | |||
| ) |
Create a new AnimationController.
| pName | NULL terminated name for the animation controller. If this exists, an error will be set. | |
| timeBased | If non-zero, a time based controller is created (using real numbers for times). If zero, a frame based controller is created (using intergers for frame numbers). |
NULL on error. | EXPORT_SYMBOL BitMaskIterator* createAoiIteratorOverBoundingBox | ( | DataElement * | pElement, | |
| int32_t | x1, | |||
| int32_t | y1, | |||
| int32_t | x2, | |||
| int32_t | y2 | |||
| ) |
Get an iterator over an AOI.
| pElement | The AoiElement to access. If this is NULL, create an iterator over the entire bounding box. | |
| x1 | The starting X value for the bounding box. | |
| y1 | The starting Y value for the bounding box. | |
| x2 | The ending X value for the bounding box. | |
| y2 | The ending Y value for the bounding box. |
| EXPORT_SYMBOL BitMaskIterator* createAoiIteratorOverRaster | ( | DataElement * | pElement, | |
| DataElement * | pRaster | |||
| ) |
Get an iterator over an AOI.
| pElement | The AoiElement to access. If this is NULL, create an iterator over the entire raster element. | |
| pRaster | A raster element whose size will determine the bounding box. |
| EXPORT_SYMBOL DataAccessorImpl* createDataAccessor | ( | DataElement * | pElement, | |
| DataAccessorArgs * | pArgs | |||
| ) |
Create a DataAccessor for accessing raster data which must be destroyed by calling destroyDataAccessor().
| pElement | The RasterElement to access. | |
| pArgs | The structure containing information to process the request or NULL to use default arguments. Default arguments are determined heuristically based on the data set. |
NULL is returned and getLastError() may be queried for information on the error. Note this is actually a DataAccessorImpl since DataAccessor is used for reference counting in C++.| EXPORT_SYMBOL DataInfo* createDataInfo | ( | DataElement * | pElement | ) |
Obtain data dimensions for the given RasterElement.
| pElement | The RasterElement to query. |
NULL is returned and getLastError() may be queried for information on the error. Ownership is transfered to the called and the memory must be freed by calling destroyDataInfo().| EXPORT_SYMBOL void* createDataPointer | ( | DataElement * | pElement, | |
| DataPointerArgs * | pArgs, | |||
| int * | pOwn | |||
| ) |
Obtain a writable pointer to raw data in memory which must be destroyed by calling destroyDataPointer().
In some cases this method returns a pointer to the original data. In other cases a copy must be created.
| pElement | The RasterElement to access. | |
| pArgs | The structure containing information to process the request or NULL to access the entire cube. | |
| pOwn | An output parameter which will contain 0 if the caller does not take ownership of the return value and a non-zero if the caller takes ownership of the return value. If this is non-zero, the caller must release the memory by calling destroyDataPointer(). If this is 0, the return value points to the original data and any modifications to this buffer will modify the original data. |
NULL is returned and getLastError() may be queried for information on the error. | EXPORT_SYMBOL DataVariant* createDataVariant | ( | const char * | pType, | |
| const void * | pValue | |||
| ) |
Create a new DataVariant and deep copies the value.
Sets an error message if the DataVariant can't be created.
| pType | The type of the object to wrap in the variant. The format of the string should match that used by DataVariant::getTypeName(). | |
| pValue | A pointer to the object to copy into the variant. If this is NULL, a default initialized object of the specified type will be created. |
NULL if an error occured. Must be freed with freeDataVariant() if ownership is not explicitly transfered. | EXPORT_SYMBOL DataVariant* createDataVariantFromString | ( | const char * | pType, | |
| const char * | pValue, | |||
| int | xml | |||
| ) |
Create a DataVariant from a string.
Sets an error message if the DataVariant can't be created.
| pType | The type string for the DataVariant. | |
| pValue | The string data to convert. | |
| xml | If 0, convert using the display string conversion, otherwise convert using the XML string conversion. |
NULL if an error occured. Must be freed with freeDataVariant() if ownership is not explicitly transfered. | EXPORT_SYMBOL DynamicObject* createDynamicObject | ( | ) |
Create a new, blank DynamicObject.
| EXPORT_SYMBOL Layer* createLayer | ( | View * | pView, | |
| DataElement * | pElement, | |||
| const char * | pType, | |||
| const char * | pName | |||
| ) |
| pView | The View which will contain the new Layer. This must be a SpatialDataView. | |
| pElement | The DataElement which will be displayed by the Layer. | |
| pType | The NULL terminated type for the new Layer. Must not be NULL. | |
| pName | The NULL terminated name for the new Layer. If this is NULL, the name of pElement will be used. |
NULL if an error occurred. | EXPORT_SYMBOL ExecutableAgent* createPlugIn | ( | const char * | pName, | |
| int | batch | |||
| ) |
Create a new PlugIn handle.
| pName | The NULL terminated name of the plug-in to create. | |
| batch | Create an interactive plug-in if this is 0 otherwise create a batch plug-in. |
NULL if an error occured. Must be freed with freePlugIn() if ownership is not explicitly transfered. | EXPORT_SYMBOL DataElement* createRasterElement | ( | const char * | pName, | |
| RasterElementArgs | args | |||
| ) |
Creates a RasterElement with the given parameters that can be immediately used.
This method should only be used by plug-ins that need to programmatically create a RasterElement to store results of an algorithm. It should NOT be used by importers or exporters to create a RasterElement It should also NOT be used to create a RasterElement that corresponds to a data file on the filesystem.
| pName | A NULL terminated C-style string containing the name for the new RasterElement. This cannot be NULL. | |
| args | The structure containing information to process the request. |
| EXPORT_SYMBOL View* createView | ( | const char * | pName, | |
| const char * | pType, | |||
| DataElement * | pElement | |||
| ) |
Create a new View.
| pName | NULL terminated name for the View. | |
| pType | NULL terminated type for the View. This uses the XML encoding of ViewType. | |
| pElement | If not NULL, this DataElement will be used as the primary DataElement for the new View. If the View type does not need a primary DataElement, this will be ignored. Currently, only SpatialDataView requires a primary DataElement which must be a RasterElement. |
NULL if an error occurred. Derive a new Layer and add it to the Layer's View.
If the new Layer type is the same as the current type, a copy is made.
| pLayer | The Layer to derive. Must be contained in a SpatialDataView. | |
| pName | The name for the new Layer. If this is NULL, the new Layer will have the same name. | |
| pType | The new NULL terminated Layer type name. This uses the XML encoding for LayerType. |
NULL on error or the new Layer handle. | EXPORT_SYMBOL void destroyAnimationController | ( | AnimationController * | pController | ) |
Permanently destroy an AnimationController.
Suitable for use as a cleanup callback.
| pController | The AnimationController to destroy. No error checking is performed on this value and a NULL will cause a NOOP. |
| EXPORT_SYMBOL void destroyAnimationControllerAttachment | ( | AnimationController * | pController, | |
| const char * | pName, | |||
| void * | pHandler | |||
| ) |
Permanently destroy an attachment point from an AnimationController.
Suitable for use as a cleanup callback.
| pController | The AnimationController to mutate. No error checking is performed on this value and a NULL will cause a NOOP. | |
| pName | The name of the Animation attachment point to destroy. No error checking is performed on this value and a NULL will cause a NOOP. | |
| pHandler | If the attachment was a callback attachment, this is the return value of attachCallbackToAnimationController(). If the attachment was not a callback attachment, this is NULL. |
| EXPORT_SYMBOL void destroyDataAccessor | ( | DataAccessorImpl * | pAccessor | ) |
Destroy a DataAccessorImpl created with createDataAccessor().
Suitable for use as a cleanup callback.
| pAccessor | The DataAccessorImpl to destroy. |
| EXPORT_SYMBOL void destroyDataElement | ( | DataElement * | pElement | ) |
Permanently destroy a DataElement.
Suitable for use as a cleanup callback.
| pElement | The DataElement to destroy. No error checking is performed on this value and a NULL will cause a NOOP. |
| EXPORT_SYMBOL void destroyDataInfo | ( | DataInfo * | pDataInfo | ) |
Destroy a pointer obtained by calling createDataInfo().
Suitable for use as a cleanup callback.
| pDataInfo | A DataInfo obtained by calling createDataInfo. |
| EXPORT_SYMBOL void destroyDataPointer | ( | void * | pData | ) |
Destroy a pointer obtained by calling createDataPointer().
Suitable for use as a cleanup callback.
| pData | The value returned by createDataPointer(). |
| EXPORT_SYMBOL void destroyLayer | ( | Layer * | pLayer | ) |
| EXPORT_SYMBOL void destroyView | ( | View * | pView | ) |
| EXPORT_SYMBOL int executePlugIn | ( | ExecutableAgent * | pPlugin | ) |
Execute a PlugIn.
A SIMPLE_OTHER_FAILURE indicates std::logic_error was caught.
| pPlugin | The PlugIn to execute. |
| EXPORT_SYMBOL int executeWizard | ( | WizardObject * | pWizard | ) |
Execute a wizard.
| pWizard | The wizard to execute. |
| EXPORT_SYMBOL void freeAoiIterator | ( | BitMaskIterator * | pIter | ) |
Free an AOI iterator.
Suitable for use as a cleanup callback.
| pIter | The BitMaskIterator to free. No error checking is performed on this value and a NULL will cause a NOOP. |
| EXPORT_SYMBOL void freeDataVariant | ( | DataVariant * | pDv | ) |
Free a DataVariant created with createDataVariant().
Suitable for use as a cleanup callback.
| pDv | The DataVariant to free. No error checking is performed on this value and a NULL will cause a NOOP. |
| EXPORT_SYMBOL void freeDynamicObject | ( | DynamicObject * | pDynamicObject | ) |
Free a DynamicObject.
Suitable for use as a cleanup callback.
| pDynamicObject | The DynamicObject to free. No error checking is performed on this value and a NULL will cause a NOOP. |
| EXPORT_SYMBOL void freePlugIn | ( | ExecutableAgent * | pPlugin | ) |
Free a PlugIn handle created with createPlugIn().
Suitable for use as a cleanup callback.
| pPlugin | The PlugIn to free. No error checking is performed on this value and a NULL will cause a NOOP. |
| EXPORT_SYMBOL void freePlugInArgList | ( | PlugInArgList * | pPial | ) |
Free a PlugInArgList which has had ownership transfered to the caller.
Suitable for use as a cleanup callback.
| pPial | The PlugInArgList to free. No error checking is performed on this value and a NULL will cause a NOOP. |
| EXPORT_SYMBOL void freeWizard | ( | WizardObject * | pWizard | ) |
Free a WizardObject created with loadWizard().
Suitable for use as a cleanup callback.
| pWizard | The wizard to free. No error checking is performed on this value and a NULL will cause a NOOP. |
| EXPORT_SYMBOL AnimationController* getAnimationController | ( | const char * | pName | ) |
Get a handle to a named AnimationController.
| pName | NULL terminated name of the animation controller. If this is NULL the active controller will be returned. |
NULL on error. | EXPORT_SYMBOL uint32_t getAnimationControllerCycle | ( | AnimationController * | pController | ) |
Get the cycle mode of the AnimationController.
| pController | The AnimationController to query. |
| EXPORT_SYMBOL double getAnimationControllerIntervalMultiplier | ( | AnimationController * | pController | ) |
Get the interval multiplier of an AnimationController.
| pController | The AnimationController to query. |
| EXPORT_SYMBOL uint32_t getAnimationControllerState | ( | AnimationController * | pController | ) |
Get the state of the AnimationController.
| pController | The AnimationController to query. |
| EXPORT_SYMBOL int getAoiIteratorLocation | ( | BitMaskIterator * | pIter, | |
| int32_t * | pX, | |||
| int32_t * | pY | |||
| ) |
Access the current AOI iterator position.
| pIter | The BitMaskIterator to query. | |
| pX | Output parameter which will contain the current X location. | |
| pY | Output parameter which will contain the current Y location. |
| EXPORT_SYMBOL int getAoiMinimalBoundingBox | ( | DataElement * | pElement, | |
| int32_t * | pX1, | |||
| int32_t * | pY1, | |||
| int32_t * | pX2, | |||
| int32_t * | pY2 | |||
| ) |
Access the minimal bounding box required to contain the AOI's unique data.
| pElement | The AoiElement to access. | |
| pX1 | The start column. | |
| pY1 | The start row. | |
| pX2 | The end column. | |
| pY2 | The end row. |
| EXPORT_SYMBOL int getAoiValue | ( | DataElement * | pElement, | |
| int32_t | x, | |||
| int32_t | y | |||
| ) |
Get the value at a particular location in an AOI.
The indices are relative to the origin of the AOI. Negative indices are possible and will always return the value of BitMask::isOutsideSelected().
| pElement | The AoiElement to access. | |
| x | The column requested. | |
| y | The row requested. |
| EXPORT_SYMBOL DataVariant* getConfigurationSetting | ( | const char * | pSettingKey | ) |
Access ConfigurationSettings values.
| pSettingKey | The NULL terminated setting key to access. |
NULL if there was an error. This is a borrowed reference and should be copied if changes will be made. | EXPORT_SYMBOL void* getDataAccessorColumn | ( | DataAccessorImpl * | pAccessor | ) |
Gets a column of values.
This method returns a pointer to the first element in an array that is guaranteed to be at least the number of bands in size for BIP data and one in size for BSQ data.
| pAccessor | The DataAccessorImpl to use. |
NULL is returned and getLastError() may be queried for information on the error.| EXPORT_SYMBOL RasterElement* getDataAccessorRasterElement | ( | DataAccessorImpl * | pAccessor | ) |
Returns the RasterElement associated with this DataAccessor.
| pAccessor | The DataAccessor to use. |
NULL is returned and getLastError() may be queried for information on the error.| EXPORT_SYMBOL void* getDataAccessorRow | ( | DataAccessorImpl * | pAccessor | ) |
Gets a row of values.
This method returns a pointer to the first element in an array that is guaranteed to be at least (concurrent columns * number of bands) in size for BIP data and (concurrent columns) in size for BSQ data.
| pAccessor | The DataAccessorImpl to use. |
NULL is returned and getLastError() may be queried for information on the error.| EXPORT_SYMBOL uint32_t getDataAccessorRowSize | ( | DataAccessorImpl * | pAccessor | ) |
Access the size in bytes of a row of data.
This includes the number of bytes of actual data in a row and excludes preline and postline bytes.
| pAccessor | The DataAccessorImpl to use. |
| EXPORT_SYMBOL DataElement* getDataElement | ( | const char * | pName, | |
| const char * | pType, | |||
| int | create | |||
| ) |
Get a DataElement pointer given an identifying name.
| pName | First, an attempt will be made to use this as a session ID. Next, this will be split into an item name path with a | delimiter. The DataElement tree is traversed until the requested item is found or an error occurs. Each item in the name path will be treated as a DataElement name. If an item is not found, each child of the current parent is checked against a display name. | |
| pType | If not NULL or empty, an element of this type will be returned. See TypeConverter for valid type names. | |
| create | If the element does not exists, should it be created? If zero, an element will not be created. If non-zero, an attempt will be made to create the element. pType must not be NULL if an element is to be created. Certain elements can't be created this way, most notably RasterElement. |
NULL if the element is not found. If the element is not found, getLastError() may be queried for information on the error.| EXPORT_SYMBOL DataElement* getDataElementChild | ( | DataElement * | pElement, | |
| uint32_t | index | |||
| ) |
Get a child of a DataElement.
| pElement | The parent DataElement. | |
| index | The index of the child. This may change as children are added and removed. |
| EXPORT_SYMBOL uint32_t getDataElementChildCount | ( | DataElement * | pElement | ) |
Get the number of child DataElements of a given DataElement.
| pElement | The DataElement to query. |
| EXPORT_SYMBOL uint32_t getDataElementFilename | ( | DataElement * | pElement, | |
| char * | pFilename, | |||
| uint32_t | filenameSize | |||
| ) |
Get the name of the file corresponding to the given DataElement.
| pElement | The DataElement to query. | |
| pFilename | Buffer to store the filename. This will be NULL terminated. | |
| filenameSize | The size of the Buffer. If the filename is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL DynamicObject* getDataElementMetadata | ( | DataElement * | pElement | ) |
Get the metadata for a DataElement.
| pElement | The DataElement to access. |
NULL if an error occurred. This is a borrowed reference. | EXPORT_SYMBOL uint32_t getDataElementName | ( | DataElement * | pElement, | |
| char * | pName, | |||
| uint32_t | nameSize | |||
| ) |
Get the name of the given DataElement.
| pElement | The DataElement to query. | |
| pName | Buffer to store the name. This will be NULL terminated. | |
| nameSize | The size of the buffer. If the name is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL uint32_t getDataElementType | ( | DataElement * | pElement, | |
| char * | pType, | |||
| uint32_t | typeSize | |||
| ) |
Get the type name of the given DataElement.
| pElement | The DataElement to query. | |
| pType | Buffer to store the type name. This will be NULL terminated. | |
| typeSize | The size of the buffer. If the type name is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL uint32_t getDataVariantTypeName | ( | DataVariant * | pDv, | |
| char * | pType, | |||
| uint32_t | typeSize | |||
| ) |
Get the type name of the value stored in the DataVariant.
| pDv | The DataVariant whose type should be accessed. | |
| pType | Buffer to store the type name. This will be NULL terminated. | |
| typeSize | The size of the Buffer. If the type name is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL void* getDataVariantValue | ( | DataVariant * | pDv | ) |
Get a pointer to the object stored in the DataVariant.
Sets an error message if the value can not be accessed.
| pDv | The DataVariant whose type should be accessed. |
NULL if an error occurred. This pointer should not be modified. | EXPORT_SYMBOL uint32_t getDataVariantValueString | ( | DataVariant * | pDv, | |
| int | xml, | |||
| char * | pValue, | |||
| uint32_t | valueSize | |||
| ) |
Convert the variant value to a string.
Sets an error if the inputs are invalid, the data can't be accessed, or another error occurs. SIMPLE_BAD_PARAMS - The passed in parameters are invalid. SIMPLE_WRONG_TYPE - The value has no string conversion for the specified string type. SIMPLE_BUFFER_SIZE - The value buffer is not large enough to hold the value string. SIMPLE_OTHER_FAILURE - The conversion to a string failed for an unknown reason.
| pDv | The DaraVariant whose type should be accessed. | |
| xml | If 0, convert using the display string conversion, otherwise convert using the XML string conversion. | |
| pValue | A buffer to store the result. | |
| valueSize | The size of pValue. |
| EXPORT_SYMBOL const char* getErrorString | ( | int | code | ) |
Translate an error code into a string which can be displayed to the user.
| code | The error code to translate. Usually obtained with getLastError(). |
| EXPORT_SYMBOL uint32_t getGcpCount | ( | DataElement * | pList | ) |
Get the number of GCP points in a GcpList.
| pList | Handle for the GcpList being accessed. This handle should be obtained using getDataElement(). |
| EXPORT_SYMBOL struct Gcp getGcpPoint | ( | DataElement * | pList, | |
| uint32_t | index | |||
| ) | [read] |
Get a GCP point from a GcpList.
| pList | Handle for the GcpList being accessed. This handle should be obtained using getDataElement(). | |
| index | The zero based index for the requested GcpPoint. This must be less than the size returned by getGcpCount() |
| EXPORT_SYMBOL uint32_t getGcpPoints | ( | DataElement * | pList, | |
| struct Gcp * | pPoints | |||
| ) |
Get an array of all the GCP points in a GcpList.
| pList | Handle for the GcpList being accessed. This handle should be obtained using getDataElement(). | |
| pPoints | Output parameter which will contain the array of GcpPoints in pList. This shall be pre-allocated and must be at least (sizeof(struct Gcp) * getGcpCount()) bytes long. |
| EXPORT_SYMBOL int getLastError | ( | ) |
Get the error code for the most recent error.
| EXPORT_SYMBOL Layer* getLayer | ( | const char * | pName, | |
| const char * | pType | |||
| ) |
Layers ////////////////.
Get a Layer given an identifying name.
| pName | The name of a view and optional layer. First, the name will be checked as a session id. Next, the view name is checked against all views. If a | is present, the name after is used to obtain a Layer with the given name. If no view name is specified, the active view is used. If no layer name is specified, the behavior depends on the value of pType. If the type is a RasterLayer, the primary RasterLayer will be the default. If another type is specified, the active layer is the default if it is the correct type, otherwise the top-most layer of the proper type is specified. | |
| pType | If not NULL or empty, a Layer of this type will be returned. See TypeConverter for valid type names. |
NULL if the layer is not found. If the layer is not found, getLastError() may be queried for information on the error. | EXPORT_SYMBOL uint32_t getLayerDisplayIndex | ( | Layer * | pLayer | ) |
Get the display order of a Layer.
| pLayer | The Layer to access. Must be in a SpatialDataView. |
| EXPORT_SYMBOL DataElement* getLayerElement | ( | Layer * | pLayer | ) |
Get the DataElement displayed by a Layer.
| pLayer | The Layer to query. |
NULL on error. | EXPORT_SYMBOL uint32_t getLayerName | ( | Layer * | pLayer, | |
| char * | pName, | |||
| uint32_t | nameSize | |||
| ) |
Get the name of the given Layer.
| pLayer | The Layer to query. | |
| pName | Buffer to store the name. This will be NULL terminated. | |
| nameSize | The size of the buffer. If the name is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL int getLayerScaleOffset | ( | Layer * | pLayer, | |
| double * | pScaleX, | |||
| double * | pScaleY, | |||
| double * | pOffsetX, | |||
| double * | pOffsetY | |||
| ) |
Get the scale and offset factors for a Layer.
| pLayer | The Layer to query. | |
| pScaleX | Output parameter which will contain the scale factor in the X direction. May be NULL if this value is not needed. | |
| pScaleY | Output parameter which will contain the scale factor in the Y direction. May be NULL if this value is not needed. | |
| pOffsetX | Output parameter which will contain the offset in the X direction. May be NULL if this value is not needed. | |
| pOffsetY | Output parameter which will contain the offset in the Y direction. May be NULL if this value is not needed. |
| EXPORT_SYMBOL uint32_t getLayerType | ( | Layer * | pLayer, | |
| char * | pType, | |||
| uint32_t | typeSize | |||
| ) |
Get the type name of the given Layer.
This uses the XML encoding of LayerType.
| pLayer | The Layer to query. | |
| pType | Buffer to store the type. This will be NULL terminated. | |
| typeSize | The size of the buffer. If the type is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL DataVariant* getMetadataAttribute | ( | DynamicObject * | pMeta, | |
| const char * | pName | |||
| ) |
Get a child attribute.
| pMeta | The DynamicObject to access. | |
| pName | The name of the attribute to access. Should be NULL terminated. |
NULL if an error occurred. | EXPORT_SYMBOL DataVariant* getMetadataAttributeByPath | ( | DynamicObject * | pMeta, | |
| const char * | pPath | |||
| ) |
Get an attribute from the entire sub-tree of a DynamicObject.
| pMeta | The DynamicObject to access. | |
| pPath | The full path name of the attribute to access. Should be NULL terminated. |
NULL if an error occurred. | EXPORT_SYMBOL uint32_t getMetadataAttributeCount | ( | DynamicObject * | pMeta | ) |
Get the number of immediate child attributes.
| pMeta | The DynamicObject to access. |
| EXPORT_SYMBOL uint32_t getMetadataAttributeName | ( | DynamicObject * | pMeta, | |
| uint32_t | attributeIndex, | |||
| char * | pName, | |||
| uint32_t | nameSize | |||
| ) |
Get the name of the name of a child attribute.
| pMeta | The DynamicObject to access. | |
| attributeIndex | The index of the attribute. | |
| pName | Buffer to store the name. This will be NULL terminated. | |
| nameSize | The size of the Buffer. If the name is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL uint32_t getOpticksVersion | ( | char * | pVersion, | |
| uint32_t | versionSize | |||
| ) |
Get the application version number as a string.
| pVersion | Buffer to store the version string. This will be NULL terminated. | |
| versionSize | The size of the buffer. If the version string is too long an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL void* getPlugInArgActualValue | ( | PlugInArg * | pPia | ) |
| EXPORT_SYMBOL PlugInArg* getPlugInArgByIndex | ( | PlugInArgList * | pPial, | |
| uint32_t | argNum | |||
| ) |
Get a PlugInArg from a PlugInArgList.
| pPial | The PlugInArgList. | |
| argNum | The index of the PlugInArg. |
NULL if an error occurred. | EXPORT_SYMBOL PlugInArg* getPlugInArgByName | ( | PlugInArgList * | pPial, | |
| const char * | pArgName | |||
| ) |
Get a PlugInArg from a PlugInArgList.
| pPial | The PlugInArgList. | |
| pArgName | The name of the PlugInArg. |
NULL if an error occurred. | EXPORT_SYMBOL uint32_t getPlugInArgCount | ( | PlugInArgList * | pPial | ) |
Get the number of PlugInArgs in a PlugInArgList.
| pPial | The PlugInArgList. |
| EXPORT_SYMBOL void* getPlugInArgDefaultValue | ( | PlugInArg * | pPia | ) |
| EXPORT_SYMBOL uint32_t getPlugInArgDescription | ( | PlugInArg * | pPia, | |
| char * | pDesc, | |||
| uint32_t | descSize | |||
| ) |
Get a description of a PlugInArg suitable for display to the user.
| pPia | The PlugInArg whose description should be accessed. | |
| pDesc | Buffer to store the description. This will be NULL terminated. | |
| descSize | The size of the Buffer. If the description is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL uint32_t getPlugInArgName | ( | PlugInArg * | pPia, | |
| char * | pName, | |||
| uint32_t | nameSize | |||
| ) |
Get the name of a PlugInArg.
| pPia | The PlugInArg whose type should be accessed. | |
| pName | Buffer to store the name. This will be NULL terminated. | |
| nameSize | The size of the Buffer. If the name is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL uint32_t getPlugInArgTypeName | ( | PlugInArg * | pPia, | |
| char * | pType, | |||
| uint32_t | typeSize | |||
| ) |
Get the type name of a PlugInArg.
| pPia | The PlugInArg whose type should be accessed. | |
| pType | Buffer to store the type name. This will be NULL terminated. | |
| typeSize | The size of the Buffer. If the type name is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL void* getPlugInArgValue | ( | PlugInArg * | pPia | ) |
A convenience function which returns the actual value if set, otherwise the default value if set, otherwise an error.
| pPia | The PlugInArg whose value should be accessed. |
NULL if an error occurred. This pointer should not be modified. An error will be set if there is no actual value and no default value. | EXPORT_SYMBOL PlugInArgList* getPlugInInputArgList | ( | ExecutableAgent * | pPlugin | ) |
Access the input argument list for a PlugIn.
A SIMPLE_OTHER_FAILURE indicates std::logic_error was caught.
| pPlugin | The PlugIn whose argument list will be returned. |
NULL if an error occurs. | EXPORT_SYMBOL PlugInArgList* getPlugInOutputArgList | ( | ExecutableAgent * | pPlugin | ) |
Access the output argument list for a PlugIn.
A SIMPLE_OTHER_FAILURE indicates std::logic_error was caught.
| pPlugin | The PlugIn whose argument list will be returned. |
NULL if an error occurs. | EXPORT_SYMBOL uint32_t getPseudocolorClassColor | ( | Layer * | pLayer, | |
| int32_t | id | |||
| ) |
Get the color of a given pseudocolor class.
| pLayer | The PseudocolorLayer to query. | |
| id | The pseudocolor class id to query. |
| EXPORT_SYMBOL uint32_t getPseudocolorClassCount | ( | Layer * | pLayer | ) |
Pseudocolor Layers ///////////////////.
Get the number of pseudocolor classes attached to a PseudocolorLayer.
| pLayer | A PseudocolorLayer to access. |
| EXPORT_SYMBOL int32_t getPseudocolorClassId | ( | Layer * | pLayer, | |
| uint32_t | index | |||
| ) |
Get the pseudocolor class id for a given index.
| pLayer | A PseudocolorLayer to access. | |
| index | The zero based index to query. |
| EXPORT_SYMBOL uint32_t getPseudocolorClassName | ( | Layer * | pLayer, | |
| int32_t | id, | |||
| char * | pName, | |||
| uint32_t | nameSize | |||
| ) |
Get the name of the given pseudocolor class.
| pLayer | The PseudocolorLayer to query. | |
| id | The pseudocolor class id to query. | |
| pName | Buffer to store the name. This will be NULL terminated. | |
| nameSize | The size of the buffer. If the name is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL int32_t getPseudocolorClassValue | ( | Layer * | pLayer, | |
| int32_t | id | |||
| ) |
Get the value of the given pseudocolor class.
| pLayer | The PseudocolorLayer to query. | |
| id | The pseudocolor class id to query. |
| EXPORT_SYMBOL uint32_t getRasterLayerColormapName | ( | Layer * | pLayer, | |
| char * | pName, | |||
| uint32_t | nameSize | |||
| ) |
Get the name of the displayed colormap.
A colormap is used when the RasterLayer is in grayscale/colormap/indexed mode. The name may be the name of an internal colormap or a full path to a colormap file.
| pLayer | The RasterLayer to query. | |
| pName | Buffer to store the name. This will be NULL terminated. | |
| nameSize | The size of the buffer. If the name is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL int getRasterLayerColormapValues | ( | Layer * | pLayer, | |
| uint32_t * | pColormap | |||
| ) |
Get the displayed colormap values.
A colormap is used when the RasterLayer is in grayscale/colormap/indexed mode.
| pLayer | The RasterLayer to query. | |
| pColormap | An array of 256 x 32-bit unsigned integers. Each integer represents an RGBA color quad where red is the high order byte and alpha is the low order byte. Encoding is in native endian. The must not be NULL. |
| EXPORT_SYMBOL uint32_t getRasterLayerComplexComponent | ( | Layer * | pLayer | ) |
Get the complex component displayed in a RasterLayer.
| pLayer | A RasterLayer to query. |
| EXPORT_SYMBOL uint32_t getRasterLayerDisplayedBand | ( | Layer * | pLayer, | |
| uint32_t | channel, | |||
| DataElement ** | pElement | |||
| ) |
Get the displayed elements and bands of a RasterLayer.
| pLayer | A RasterLayer to query. | |
| channel | The color channel. 0 -> gray/index, 1 -> red, 2 -> green, 3 -> blue | |
| pElement | Output argument containing the RasterElement displayed in the channel. Ignore if NULL. |
| EXPORT_SYMBOL uint32_t getRasterLayerFilterCount | ( | Layer * | pLayer, | |
| int | enabled | |||
| ) |
Query the number of filters supported by a RasterLayer.
| pLayer | A RasterLayer to query. | |
| enabled | If zero, query all supported filters. If non-zero, query enabled filters. |
| EXPORT_SYMBOL uint32_t getRasterLayerFilterName | ( | Layer * | pLayer, | |
| uint32_t | index, | |||
| int | enabled, | |||
| char * | pName, | |||
| uint32_t | nameSize | |||
| ) |
Query the name of the filter with a given index.
| pLayer | A RasterLayer to query. | |
| index | The filter index to query. | |
| enabled | If zero, query all supported filters. If non-zero, query enabled filters. | |
| pName | Buffer to store the name. This will be NULL terminated. | |
| nameSize | The size of the buffer. If the name is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL int getRasterLayerGpuEnabled | ( | Layer * | pLayer | ) |
Is the RasterLayer rendered on the GPU?
| pLayer | A RasterLayer to query. |
| EXPORT_SYMBOL int getRasterLayerStatistics | ( | Layer * | pLayer, | |
| uint32_t | channel, | |||
| uint32_t | component, | |||
| struct RasterStatistics * | pStatistics | |||
| ) |
The raster statistics for a RasterLayer.
| pLayer | A RasterLayer to query. | |
| channel | The color channel. 0 -> gray/index, 1 -> red, 2 -> green, 3 -> blue | |
| component | The complex component to query. This should be 0 for non-complex data types. 0 -> magnitude, 1 -> phase, 2 -> in-phase, 3 -> quadrature. | |
| pStatistics | Output parameter for the statistics. Arrays in this structure are borrowed references and may change when statistics are recalculated. A copy should be made if these will be used long term. |
| EXPORT_SYMBOL int getRasterLayerStretchInfo | ( | Layer * | pLayer, | |
| uint32_t | channel, | |||
| struct RasterLayerStretchInfo * | pInfo | |||
| ) |
Get the raster stretch properties.
| pLayer | A RasterLayer to query. | |
| channel | The raster channel to query. 0 -> gray, 1 -> red, 2 -> green, 3 -> blue | |
| pInfo | Structure containing the raster stretch parameters. Must not be NULL. |
| EXPORT_SYMBOL DataVariant* getSignatureDataSet | ( | DataElement * | pSig, | |
| const char * | pName | |||
| ) |
Get the signature data set with the specified name.
| pSig | The signature DataElement to access. | |
| pName | The NULL terminated name of the dataset to access. |
NULL will be returned on error. | EXPORT_SYMBOL uint32_t getSignatureDataSetCount | ( | DataElement * | pSig | ) |
Access the number of data sets in a signature.
| pSig | The signature DataElement to access. |
| EXPORT_SYMBOL uint32_t getSignatureDataSetName | ( | DataElement * | pSig, | |
| uint32_t | index, | |||
| char * | pName, | |||
| uint32_t | nameSize | |||
| ) |
Get the name of the indexed data set.
The index to name correspondence should not be considered static. The index is used to access an std::set which sorted alphanumerically by name. Adding or removing a data set to a signature may result in a reodering of the names.
This only accesses the data names (via Signature::getDataNames()). The unit names are not accessible but generally there are no units without a corresponding data set so this should not cause problems.
| pSig | The signature DataElement to access. | |
| index | The index of the data set. | |
| pName | Buffer to store the name. This will be NULL terminated. | |
| nameSize | The size of the buffer. If the name is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL uint32_t getSignatureSetCount | ( | DataElement * | pSet | ) |
Access the number of signatures in a signature set.
| pSet | The signature set to access. |
| EXPORT_SYMBOL DataElement* getSignatureSetSignature | ( | DataElement * | pSet, | |
| uint32_t | index | |||
| ) |
Get the indexed signature.
| pSet | The signature set to access. | |
| index | The index of the signature. |
NULL on error. | EXPORT_SYMBOL uint32_t getTestDataPath | ( | char * | pPath, | |
| uint32_t | pathSize | |||
| ) |
Get the test data path.
| pPath | Buffer to store the path. This will be NULL terminated. | |
| pathSize | The size of the Buffer. If the name is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL int getThresholdLayerInfo | ( | Layer * | pLayer, | |
| struct ThresholdLayerInfo * | pInfo | |||
| ) |
Get the threshold properties.
| pLayer | A threshold Layer to query. | |
| pInfo | Structure containing the threshold parameters. Must not be NULL. |
| EXPORT_SYMBOL View* getView | ( | const char * | pName, | |
| const char * | pType | |||
| ) |
Views ////////////////.
Get a View given an identifying name.
| pName | The name of the view. First the name will be checked as a session id. Next the view name is checked against all views. If a | delimited is present, the first item is used as the name. This way, a Layer name specifier may be passed to obtain the View that will contain that layer. | |
| pType | If not NULL or empty, a View of this type will be returned. See TypeConverter for valid type names. |
NULL if the view is not found. If the view is not found, getLastError() may be queried for information on the error. | EXPORT_SYMBOL uint32_t getViewLayerCount | ( | View * | pView | ) |
Get the number of layers in a View.
| pView | The View to query. This must be a SpatialDataView. |
| EXPORT_SYMBOL uint32_t getViewName | ( | View * | pView, | |
| char * | pName, | |||
| uint32_t | nameSize | |||
| ) |
Get the name of the given View.
| pView | The View to query. | |
| pName | Buffer to store the name. This will be NULL terminated. | |
| nameSize | The size of the buffer. If the name is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL DataElement* getViewPrimaryRasterElement | ( | View * | pView | ) |
Access the primary RasterElement.
| pView | The View to query. This must be a SpatialDataView. |
NULL if an error occurred. | EXPORT_SYMBOL uint32_t getViewType | ( | View * | pView, | |
| char * | pType, | |||
| uint32_t | typeSize | |||
| ) |
Get the type name of the given View.
This uses the XML encoding of ViewType.
| pView | The View to query. | |
| pType | Buffer to store the type. This will be NULL terminated. | |
| typeSize | The size of the buffer. If the type is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL WizardNode* getWizardInputNodeByIndex | ( | WizardObject * | pWizard, | |
| uint32_t | idx | |||
| ) |
Get an input node.
Input nodes correspond to value items in the wizard.
| pWizard | The WizardObject to query. | |
| idx | The 0 based index of the input node. Must be less than the return value of getWizardInputNodeCount(). |
| EXPORT_SYMBOL WizardNode* getWizardInputNodeByName | ( | WizardObject * | pWizard, | |
| const char * | pName | |||
| ) |
Get an input node with a given name.
Input nodes correspond to value items in the wizard. The name is the name associated with the value item.
| pWizard | The WizardObject to query. | |
| pName | The NULL terminated name of the input node. |
| EXPORT_SYMBOL uint32_t getWizardInputNodeCount | ( | WizardObject * | pWizard | ) |
Get the number of input nodes in a wizard.
Input nodes correspond to value items in the wizard.
| pWizard | The WizardObject to query. |
| EXPORT_SYMBOL uint32_t getWizardName | ( | WizardObject * | pWizard, | |
| char * | pName, | |||
| uint32_t | nameSize | |||
| ) |
Get the name of a wizard.
| pWizard | The WizardObject to query. | |
| pName | Buffer to store the name. This will be NULL terminated. | |
| nameSize | The size of the Buffer. If the name is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL uint32_t getWizardNodeName | ( | WizardNode * | pNode, | |
| char * | pName, | |||
| uint32_t | nameSize | |||
| ) |
Get the name of a wizard node.
| pNode | The WizardNode to query. | |
| pName | Buffer to store the name. This will be NULL terminated. | |
| nameSize | The size of the Buffer. If the name is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL uint32_t getWizardNodeType | ( | WizardNode * | pNode, | |
| char * | pType, | |||
| uint32_t | typeSize | |||
| ) |
Get the type string of a wizard node.
| pNode | The WizardNode to query. | |
| pType | Buffer to store the type. This will be NULL terminated. | |
| typeSize | The size of the Buffer. If the type is too long, an error will be set. If this is 0, the minimum size of the buffer including the trailing NULL will be returned. |
| EXPORT_SYMBOL void* getWizardNodeValue | ( | WizardNode * | pNode | ) |
Get the value of a wizard node.
| pNode | The WizardNode to query. |
| EXPORT_SYMBOL WizardNode* getWizardOutputNodeByIndex | ( | WizardObject * | pWizard, | |
| uint32_t | idx | |||
| ) |
Get an output node.
Output nodes for value items are not counted.
| pWizard | The WizardObject to query. | |
| idx | The 0 based index of the output node. Must be less than the return value of getWizardOutputNodeCount(). |
| EXPORT_SYMBOL WizardNode* getWizardOutputNodeByName | ( | WizardObject * | pWizard, | |
| const char * | pName | |||
| ) |
Get an output node with a given name.
Output nodes for value items are not counted. The name is the name of the wizard item followed by a | and the name of the output node. Wizard item names which contain a | can't be accessed with the method, use getWizardOutputNodeByIndex() instead. If there are multiple items with the same name, the first one (ordered by execution order) will be selected. Use getWizardOutputNodeByIndex() to access the other items. For example: Principal Component Analysis|Corrected Data Cube
| pWizard | The WizardObject to query. | |
| pName | The NULL terminated name of the output node. |
| EXPORT_SYMBOL uint32_t getWizardOutputNodeCount | ( | WizardObject * | pWizard | ) |
Get the number of output nodes in a wizard.
Output nodes for value items are not counted.
| pWizard | The WizardObject to query. |
| EXPORT_SYMBOL void* handle | ( | ) |
Get the services pointer for future initialization.
| EXPORT_SYMBOL int isDataAccessorValid | ( | DataAccessorImpl * | pAccessor | ) |
Determines if the DataAccessor is valid.
| pAccessor | The DataAccessorImpl to use. |
| EXPORT_SYMBOL int isDataVariantValid | ( | DataVariant * | pDv | ) |
Does the DataVariant contain a valid value?
Sets an error message if the DataVariant is NULL.
| pDv | The DataVariant to check. |
| EXPORT_SYMBOL int isLayerActive | ( | Layer * | pLayer | ) |
Is the Layer active?
| pLayer | The Layer to query. Must be contained in a SpatialDataView. |
| EXPORT_SYMBOL int isLayerDisplayed | ( | Layer * | pLayer | ) |
Is the layer displayed?
| pLayer | The Layer to access. Must be contained in a SpatialDataView. |
| EXPORT_SYMBOL int isPlugInArgActualSet | ( | PlugInArg * | pPia | ) |
| EXPORT_SYMBOL int isPlugInArgDefaultSet | ( | PlugInArg * | pPia | ) |
| EXPORT_SYMBOL int isPseudocolorClassDisplayed | ( | Layer * | pLayer, | |
| int32_t | id | |||
| ) |
Is the pseudocolor class displayed?
| pLayer | The PseudocolorLayer to query. | |
| id | The pseudocolor class id to query. |
| EXPORT_SYMBOL int isRasterLayerRgbDisplayed | ( | Layer * | pLayer | ) |
Get the display mode of a RasterLayer.
| pLayer | A RasterLayer to query. |
| EXPORT_SYMBOL uint32_t loadFile | ( | const char * | pFilename, | |
| int | batch | |||
| ) |
Load a file using the autoimporter.
| pFilename | The filename to load. | |
| batch | If zero, load in interactive mode, otherwise load in batch mode. |
| EXPORT_SYMBOL WizardObject* loadWizard | ( | const char * | pFilename | ) |
Load a wizard from a file.
| pFilename | The NULL terminated filename of the wizard to load. An attempt will be made to determine if this is an absolute or relative path by first opening pFilename directly. If this fails, the wizard path setting will be prepended to the filename and this will be opened. |
NULL if an error occured. Must be freed with freeWizard(). | EXPORT_SYMBOL int nextAoiIterator | ( | BitMaskIterator * | pIter | ) |
Advance an AOI iterator to the next selected pixel.
| pIter | The BitMaskIterator to advance. |
| EXPORT_SYMBOL void nextDataAccessorColumn | ( | DataAccessorImpl * | pAccessor, | |
| uint32_t | count | |||
| ) |
Advances to a succeeding column in the dataset.
| pAccessor | The DataAccessorImpl to use. | |
| count | The number of columns to advance. |
| EXPORT_SYMBOL void nextDataAccessorRow | ( | DataAccessorImpl * | pAccessor, | |
| uint32_t | count, | |||
| int | resetColumn | |||
| ) |
Advances to a succeeding row in the dataset.
| pAccessor | The DataAccessorImpl to use. | |
| count | The number of rows to advance. | |
| resetColumn | non-zero -> Reset the column to the beginning column of the accessor, 0 -> Maintain the current column. |
| EXPORT_SYMBOL int pauseAnimationController | ( | AnimationController * | pController | ) |
Pause playback of an animation controller.
| pController | The AnimationController to mutate. |
| EXPORT_SYMBOL int playAnimationController | ( | AnimationController * | pController | ) |
Begin playback of an animation controller in the current direction.
| pController | The AnimationController to mutate. |
| EXPORT_SYMBOL void removeMetadataAttribute | ( | DynamicObject * | pMeta, | |
| const char * | pName | |||
| ) |
Remove an immediate child attribute.
Will set: SIMPLE_BAD_PARAMS any of the input values is NULL SIMPLE_OTHER_FAILURE if the attribute remove fails
| pMeta | The DynamicObject to access. | |
| pName | The name of the attribute to remove. Should be NULL terminated. |
| EXPORT_SYMBOL void removeMetadataAttributeByPath | ( | DynamicObject * | pMeta, | |
| const char * | pPath | |||
| ) |
Remove an attribute from the sub-tree of a DynamicObject.
Will set: SIMPLE_BAD_PARAMS any of the input values is NULL SIMPLE_OTHER_FAILURE if the attribute remove fails
| pMeta | The DynamicObject to access. | |
| pPath | The full path name of the attribute to remove. Should be NULL terminated. |
| EXPORT_SYMBOL int resetRasterLayerFilter | ( | Layer * | pLayer, | |
| const char * | pFilterName | |||
| ) |
Reset a feedback filter.
| pLayer | A RasterLayer to mutate. | |
| pFilterName | The NULL terminated name of the filter to mutate. If this filter is not a feedback filter, nothing occurs and no error is generated. |
| EXPORT_SYMBOL int serializeConfigurationSettingDefaults | ( | const char * | pFilename, | |
| DynamicObject * | pDynamicObject | |||
| ) |
Serialize a DynamicObject to a file suitable for use as a setting defaults file.
| pFilename | The NULL terminated filename. If this is relative, the application's current working directory will be used as the base path. | |
| pDynamicObject | The DynamicObject to serialize. |
| EXPORT_SYMBOL int setAnimationControllerCanDropFrames | ( | AnimationController * | pController, | |
| int | dropFrames | |||
| ) |
Allow the AnimationController to drop frames to maintain the play rate/.
| pController | The AnimationController to mutate. | |
| dropFrames | Zero if the controller should slow playback instead of dropping frames. Non-zero if the controller should drop frames to maintain the playback rate. |
| EXPORT_SYMBOL int setAnimationControllerCycle | ( | AnimationController * | pController, | |
| uint32_t | cycle | |||
| ) |
Set the cycle mode of the AnimationController.
| pController | The AnimationController to mutate. | |
| cycle | The new cycle mode of the controller. 0 -> Play once and reset, 1 -> Repeat play, 2 -> Reverse direction at end, |
| EXPORT_SYMBOL int setAnimationControllerIntervalMultiplier | ( | AnimationController * | pController, | |
| double | multiplier | |||
| ) |
Set the interval multiplier of an AnimationController.
| pController | The AnimationController to query. | |
| multiplier | The interval multiplier. This speeds up or slows down the playback in a linear fashion. For example: a value of 2.0 doubles the playback rate and a value of 0.5 halves the playback rate. |
| EXPORT_SYMBOL int setAnimationControllerState | ( | AnimationController * | pController, | |
| uint32_t | state | |||
| ) |
Set the state of the AnimationController.
| pController | The AnimationController to mutate. | |
| state | The new state of the controller. 0 -> Stop, 1 -> Play forward, 2 -> Play backward, 3 -> Pause and play forward on resume, 4 -> Pause and will play backward on resume |
| EXPORT_SYMBOL int setAoiValue | ( | DataElement * | pElement, | |
| uint32_t | x, | |||
| uint32_t | y, | |||
| int | value | |||
| ) |
Set the value at a particular location in an AOI.
The indices are relative to the origin of the AOI.
| pElement | The AoiElement to access. | |
| x | The column to set. | |
| y | The row to set. | |
| value | The new value. A zero clears the point from the AOI and a non-zero adds the point to the AOI. |
| EXPORT_SYMBOL int setConfigurationSetting | ( | const char * | pSettingKey, | |
| DataVariant * | pValue | |||
| ) |
Change ConfigurationSettings values.
| pSettingKey | The NULL terminated setting key to mutate. | |
| pValue | The value to set. This value will be adopted and after this function returned, pValue will contain the previous setting or an invalid DataVariant if there was no previous setting. |
| EXPORT_SYMBOL uint32_t setGcpPoints | ( | DataElement * | pList, | |
| uint32_t | count, | |||
| struct Gcp * | pPoints | |||
| ) |
Set the GCP points in a GcpList, replacing any existing points.
| pList | Handle for the GcpList being modified. This handle should be obtained using getDataElement(). | |
| count | The number of GCP points in pPoints. | |
| pPoints | The array of GcpPoints to set in pList. This shall be at least (sizeof(struct Gcp) * count) bytes long. This may be NULL if count is 0. |
| EXPORT_SYMBOL void setHandle | ( | void * | pExternal | ) |
Initialize the services pointer.
| pExternal | Opaque handle obtained from ModuleManager::instance()->getServices() called from the main Opticks module. This generally needs to be called when loading the simple API from a DSO. If a static library is used, this may not be needed. |
| EXPORT_SYMBOL void setLastError | ( | int | code | ) |
Set the error code for the most recent error.
If an API function wishes to define a new code, an appropriate #define should be added to SimpleApiErrors and a message should be added to SimpleApiError.cpp.
| code | The error code to set. |
| EXPORT_SYMBOL int setLayerDisplayed | ( | Layer * | pLayer, | |
| int | displayed | |||
| ) |
Shown/hide a Layer.
This will do nothing and return with no error if the requested state equals the current state.
| pLayer | The Layer to mutate. Must be contained in a SpatialDataView. | |
| displayed | If non-zero, the Layer will be shown, if zero it will be hidden. |
| EXPORT_SYMBOL int setLayerDisplayIndex | ( | Layer * | pLayer, | |
| uint32_t | newIndex | |||
| ) |
Set the display order of a Layer.
| pLayer | The Layer to mutate. Must be in a SpatialDataView. | |
| newIndex | The new zero based index of the Layer. |
| EXPORT_SYMBOL int setLayerScaleOffset | ( | Layer * | pLayer, | |
| double | scaleX, | |||
| double | scaleY, | |||
| double | offsetX, | |||
| double | offsetY | |||
| ) |
Set the scale and offset factors for a Layer.
| pLayer | The Layer to mutate. | |
| scaleX | The new scale factor in the X direction. If this is NaN, the value will not be changed. | |
| scaleY | The new scale factor in the Y direction. If this is NaN, the value will not be changed. | |
| offsetX | The new offset in the X direction. If this is NaN, the value will not be changed. | |
| offsetY | The new offset in the Y direction. If this is NaN, the value will not be changed. |
| EXPORT_SYMBOL void setMetadataAttribute | ( | DynamicObject * | pMeta, | |
| const char * | pName, | |||
| DataVariant * | pValue | |||
| ) |
Set an attribute by taking ownership of a DataVariant.
Will set: SIMPLE_BAD_PARAMS any of the input values is NULL SIMPLE_OTHER_FAILURE if the attribute set fails
| pMeta | The DynamicObject to access. | |
| pName | The name of the attribute to access. Should be NULL terminated. | |
| pValue | The new value of the attribute. This will be modified to contain the previous value of the attribute or an invalid DataVariant if no previous value exists. |
| EXPORT_SYMBOL void setMetadataAttributeByPath | ( | DynamicObject * | pMeta, | |
| const char * | pPath, | |||
| DataVariant * | pValue | |||
| ) |
Set an attribute by taking ownership of a DataVariant.
Will set: SIMPLE_BAD_PARAMS any of the input values is NULL SIMPLE_OTHER_FAILURE if the attribute set fails
| pMeta | The DynamicObject to access. | |
| pPath | The full path name of the attribute to access. Should be NULL terminated. | |
| pValue | The new value of the attribute. This will be modified to contain the previous value of the attribute or an invalid DataVariant if no previous value exists. |
| EXPORT_SYMBOL void setPlugInArgActualValueFromDataVariant | ( | PlugInArg * | pPia, | |
| DataVariant * | pValue | |||
| ) |
Set the actual value of a PlugInArg using a DataVariant.
NULL pPia SIMPLE_OTHER_FAILURE - After attempting to set the value, PlugInArg::isActualSet() is false. SIMPLE_WRONG_TYPE - The DataVariant type does not match the PlugInArg type.
| pPia | The PlugInArg whose value should be set. | |
| pValue | A pointer to a DataVariant which will be deep copied to the PlugInArg value. |
| EXPORT_SYMBOL void setPlugInArgActualValueFromVoid | ( | PlugInArg * | pPia, | |
| void * | pValue | |||
| ) |
Set the actual value of a PlugInArg.
NULL pPia SIMPLE_OTHER_FAILURE - After attempting to set the value, PlugInArg::isActualSet() is false.
| pPia | The PlugInArg whose value should be set. | |
| pValue | A pointer to the value. |
| EXPORT_SYMBOL void setPlugInArgDefaultValueFromDataVariant | ( | PlugInArg * | pPia, | |
| DataVariant * | pValue | |||
| ) |
Set the default value of a PlugInArg using a DataVariant.
NULL pPia SIMPLE_OTHER_FAILURE - After attempting to set the value, PlugInArg::isDefaultSet() is false. SIMPLE_WRONG_TYPE - The DataVariant type does not match the PlugInArg type.
| pPia | The PlugInArg whose value should be set. | |
| pValue | A pointer to a DataVariant which will be deep copied to the PlugInArg value. |
| EXPORT_SYMBOL void setPlugInArgDefaultValueFromVoid | ( | PlugInArg * | pPia, | |
| void * | pValue | |||
| ) |
Set the default value of a PlugInArg.
NULL pPia SIMPLE_OTHER_FAILURE - After attempting to set the value, PlugInArg::isDefaultSet() is false.
| pPia | The PlugInArg whose value should be set. | |
| pValue | A pointer to the value. |
| EXPORT_SYMBOL int setPseudocolorClassColor | ( | Layer * | pLayer, | |
| int32_t | id, | |||
| uint32_t | color | |||
| ) |
Set the color of a given pseudocolor class.
| pLayer | The PseudocolorLayer to mutate. | |
| id | The pseudocolor class id to mutate. | |
| color | 8 The color for the pseudocolor class. This is a 4 byte value in native endian. Red Green Blue Alpha ordering. |
| EXPORT_SYMBOL int setPseudocolorClassDisplayed | ( | Layer * | pLayer, | |
| int32_t | id, | |||
| int | display | |||
| ) |
Show or hide the pseudocolor class.
| pLayer | The PseudocolorLayer to mutate. | |
| id | The pseudocolor class id to mutate. | |
| display | Non-zero to display the class, zero to hide the class. |
| EXPORT_SYMBOL int setPseudocolorClassName | ( | Layer * | pLayer, | |
| int32_t | id, | |||
| const char * | pName | |||
| ) |
Set the name of the given pseudocolor class.
| pLayer | The PseudocolorLayer to mutate. | |
| id | The pseudocolor class id to mutate. | |
| pName | The NULL terminated name for the pseudocolor class |
| EXPORT_SYMBOL int setPseudocolorClassValue | ( | Layer * | pLayer, | |
| int32_t | id, | |||
| int32_t | value | |||
| ) |
Set the value of the given pseudocolor class.
| pLayer | The PseudocolorLayer to mutate. | |
| id | The pseudocolor class id to mutate. | |
| value | The value for the pseudocolor class. |
| EXPORT_SYMBOL int setRasterLayerColormapName | ( | Layer * | pLayer, | |
| const char * | pName | |||
| ) |
Set the displayed colormap.
A colormap is used when the RasterLayer is in grayscale/colormap/indexed mode. The name may be the name of an internal colormap or a full path to a colormap file.
| pLayer | The RasterLayer to mutate. | |
| pName | NULL terminate name or full pathname of the colormap to display. |
| EXPORT_SYMBOL int setRasterLayerColormapValues | ( | Layer * | pLayer, | |
| const char * | pName, | |||
| uint32_t * | pColormap | |||
| ) |
Set the displayed colormap values.
A colormap is used when the RasterLayer is in grayscale/colormap/indexed mode.
| pLayer | The RasterLayer to mutate. | |
| pName | The NULL terminate name for the new colormap. If this is NULL, no name will be associated with the new colormap. | |
| pColormap | An array of 256 x 32-bit unsigned integers. Each integer represents an RGBA color quad where red is the high order byte and alpha is the low order byte. Encoding is in native endian. The must not be NULL. |
| EXPORT_SYMBOL int setRasterLayerComplexComponent | ( | Layer * | pLayer, | |
| uint32_t | component | |||
| ) |
Set the complex component displayed in a RasterLayer.
| pLayer | A RasterLayer to mutate. | |
| component | The complex component. 0 -> magnitude, 1 -> phase, 2 -> in-phase, 3 -> quadrature. |
| EXPORT_SYMBOL int setRasterLayerDisplayedBand | ( | Layer * | pLayer, | |
| uint32_t | channel, | |||
| uint32_t | band, | |||
| DataElement * | pElement | |||
| ) |
Set the displayed elements and bands of a RasterLayer.
| pLayer | A RasterLayer to mutate. | |
| channel | The color channel. 0 -> gray/index, 1 -> red, 2 -> green, 3 -> blue | |
| band | The active band number to display. | |
| pElement | The RasterElement to display in the channel. If NULL, the currently displayed element will be maintained. |
| EXPORT_SYMBOL int setRasterLayerFilterFrozen | ( | Layer * | pLayer, | |
| const char * | pFilterName, | |||
| int | freeze | |||
| ) |
Freeze or unfreeze a feedback filter.
| pLayer | A RasterLayer to mutate. | |
| pFilterName | The NULL terminated name of the filter to mutate. If this filter is not a feedback filter, nothing occurs and no error is generated. | |
| freeze | If zero unfreeze the filter or if non-zero freeze the filter. |
| EXPORT_SYMBOL int setRasterLayerFilters | ( | Layer * | pLayer, | |
| uint32_t | count, | |||
| const char ** | pFilters | |||
| ) |
Enable the specified filters.
| pLayer | A RasterLayer to mutate. | |
| count | The number of filters in the array. | |
| pFilters | Array of NULL terminated filter names of length count. This may be NULL iff count is 0. |
| EXPORT_SYMBOL int setRasterLayerGpuEnabled | ( | Layer * | pLayer, | |
| int | gpu | |||
| ) |
Set the RasterLayer render target.
| pLayer | A RasterLayer to query. | |
| gpu | Zero to enable CPU rendering, non-zero to enable GPU rendering. |
| EXPORT_SYMBOL int setRasterLayerRgbDisplayed | ( | Layer * | pLayer, | |
| int | rgb | |||
| ) |
Set the display mode of a RasterLayer.
| pLayer | A RasterLayer to mutate. | |
| rgb | A zero to set the display to grayscale/colormap/indexed or a non-zero to set the display to RGB. |
| EXPORT_SYMBOL int setRasterLayerStretchInfo | ( | Layer * | pLayer, | |
| uint32_t | channel, | |||
| struct RasterLayerStretchInfo * | pInfo | |||
| ) |
Set the raster stretch properties.
| pLayer | A RasterLayer to mutate. | |
| channel | The raster channel to mutate. 0 -> gray, 1 -> red, 2 -> green, 3 -> blue | |
| pInfo | Structure containing the raster stretch parameters. Must not be NULL. |
| EXPORT_SYMBOL int setSignatureDataSet | ( | DataElement * | pSig, | |
| const char * | pName, | |||
| DataVariant * | pValue | |||
| ) |
Set the signature data set with the specified name.
| pSig | The signature DataElement to mutate. | |
| pName | The NULL terminated name of the dataset to mutate. | |
| pValue | The DataVariant with the new value. After returning, pValue will contain the data previously in the data set named by pName. If the data set did not exist, pValue will be an invalid DataVariant. |
| EXPORT_SYMBOL int setThresholdLayerInfo | ( | Layer * | pLayer, | |
| struct ThresholdLayerInfo * | pInfo | |||
| ) |
Set the threshold properties.
| pLayer | A threshold Layer to mutate. | |
| pInfo | Structure containing the threshold parameters. Must not be NULL. |
| EXPORT_SYMBOL int setViewName | ( | View * | pView, | |
| const char * | pName | |||
| ) |
| EXPORT_SYMBOL int setWizardNodeValue | ( | WizardNode * | pNode, | |
| void * | pValue | |||
| ) |
Set the value of a wizard node.
| pNode | The WizardNode to query. | |
| pValue | A void* to the value. The type of this data is determined by getWizardNodeType(). |
| EXPORT_SYMBOL int stopAnimationController | ( | AnimationController * | pController | ) |
Stop playback of an animation controller.
| pController | The AnimationController to mutate. |
| EXPORT_SYMBOL void toDataAccessorPixel | ( | DataAccessorImpl * | pAccessor, | |
| uint32_t | row, | |||
| uint32_t | column | |||
| ) |
Jumps to the specified pixel.
| pAccessor | The DataAccessorImpl to use. | |
| row | The row to access. This must be less than the total number of rows. | |
| column | The column to access. This must be less than the total number of columns. |
| EXPORT_SYMBOL void updateRasterElement | ( | DataElement * | pElement | ) |
Notfiy Opticks that a RasterElement's data has changed.
| pElement | The RasterElement to update. |
| EXPORT_SYMBOL uint32_t vectorToArray | ( | void * | pValue, | |
| const char * | pType, | |||
| void ** | pOutValue | |||
| ) |
Unwrap an std::vector.
DataVariant can hold an std::vector of certain types but std::vector is a C++ class so manipulation can be difficult. This method returns a C array of the underlying datatype given an std::vector. i.e. an std::vector<double> will be turned into a double* of length std::vector<double>::size().
| pValue | The void* that is a pointer to a vector. | |
| pType | The NULL terminated string which is a vector type. Must be std::vector<type>. | |
| pOutValue | An output parameter which will contain a C array of the underlying data type. This is equavalent to &value.front(). A deep copy is not performed so this is a borrow reference. |