Fovia's C++ Client/Server API
|
Public Member Functions | |
virtual signed int | AskInterface (const BGUID *piid, IRoot **ppr)=0 |
virtual signed int | BeginMultiplexing ()=0 |
virtual signed int | BeginServerCall ()=0 |
virtual signed int | CancelJob (signed long long jobID)=0 |
virtual signed int | Connect (const char *host, const unsigned short port, ILogger *pLogger, signed int *serverResponse)=0 |
virtual signed int | ConnectEx (const char *host, const unsigned short port, ILogger *pLogger, signed int *serverResponse, const unsigned int timeout)=0 |
virtual signed int | CreateFreehandCutAdaptor (IFreehandCutAdaptor **pFreehandCutAdaptor)=0 |
virtual signed int | CreateInteractiveSegAdaptor (IInteractiveSegAdaptor **pInteractiveSegAdaptor)=0 |
virtual signed int | CreateOctree (IOctreeContext **pOctreeContext, IVolumeDataContext *pData)=0 |
virtual signed int | CreateOctreeEx (IOctreeContext **pOctreeContext, IVolumeDataContext *pData, ENUM_SMOOTH_PARAM smoothType)=0 |
virtual signed int | CreateOctreeEx2 (IOctreeContext **pOctreeContext, IVolumeDataContext *pData, signed int bSaveMemory, ENUM_SMOOTH_PARAM smoothType)=0 |
virtual signed int | CreateOctreeEx2Dep (IOctreeContext **pOctreeContext, signed long long dataID, signed int bSaveMemory, ENUM_SMOOTH_PARAM smoothType)=0 |
virtual signed int | CreatePolygonUtil (IPolygonUtilContext **pPolygonUtil)=0 |
virtual signed int | CreateRenderEngine (IRenderEngineContext **pRenderEngine, ENUM_RENDER_ENGINE_CLASSID Type)=0 |
virtual signed int | CreateTextureMap (ITextureMapContext **pTextureMapContext)=0 |
virtual signed int | CreateVertexCallList (IVertexCallListContext **pVertexCallListContext)=0 |
virtual signed int | CreateVolumeSegmentation (IVolumeSegmentationContext **pvolumeSegmentationContext)=0 |
virtual signed int | CreateVolumeShadow (IVolumeShadowContext **pShadow)=0 |
virtual signed int | DecRef ()=0 |
virtual signed int | Disconnect ()=0 |
virtual signed int | EndMultiplexing ()=0 |
virtual signed int | EndServerCall ()=0 |
virtual signed int | FinishJobCreateOctree (IOctreeContext **pOctreeContext, signed long long job)=0 |
virtual signed int | FinishJobCustomLoadDataset (IVolumeDataContext **pData, const signed long long job)=0 |
virtual signed int | FinishJobLoadDicomDirectory (IVolumeDataContext **pData, const signed long long job)=0 |
virtual signed int | FinishJobLoadDICOMFromFileList (ILiteDICOMFileContext ***files, signed long long job, const signed int numPaths, IAllocator *piAlloc)=0 |
virtual signed int | FinishJobLoadRawFiles (IVolumeDataContext **pData, const signed long long job)=0 |
virtual signed int | FinishJobLoadSeriesFromDICOMList (IVolumeDataContext **pData, signed long long job)=0 |
virtual signed int | FinishJobScanDICOMDirectory (ILiteDICOMFileContext ***files, char ***paths, unsigned int *numfiles, signed long long job, IAllocator *pAlloc)=0 |
virtual signed int | GetJobInfo (signed long long jobID, JOBINFO *jobInfo)=0 |
virtual signed int | GetObjectDataHolder (IDataHolderContext **pData, signed int idData)=0 |
virtual signed int | GetServerVersion (unsigned int *version)=0 |
virtual signed int | GetStream (ISimpleStream **pStream)=0 |
virtual signed int | IncRef ()=0 |
virtual signed int | LoadCustomDataset (IVolumeDataContext **pData, ENUM_LOAD_DATASET_OPTIONS type, const char *path)=0 |
virtual signed int | LoadDicomDirectory (IVolumeDataContext **pData, const char *path)=0 |
virtual signed int | LoadDicomDirUTF8 (IVolumeDataContext **pData, ENUM_LOAD_DATASET_OPTIONS type, const unsigned char *path)=0 |
virtual signed int | LoadDICOMFromFileList (ILiteDICOMFileContext ***files, char **paths, unsigned int numPaths, IAllocator *pAlloc)=0 |
virtual signed int | LoadPreset (const char *path, RENDER_PARAMS *rp)=0 |
virtual signed int | LoadRawData (IVolumeDataContext **pData, const char *path)=0 |
virtual signed int | LoadRawFiles (IVolumeDataContext **pData, RAW_DATASET_DESCRIPTION *rdd)=0 |
virtual signed int | LoadSeriesFromDICOMList (IVolumeDataContext **pData, const signed int numFiles, ILiteDICOMFileContext **files, const char *seriesUID)=0 |
virtual signed int | SavePreset (const char *path, RENDER_PARAMS *rp)=0 |
virtual signed int | ScanDICOMDirectory (ILiteDICOMFileContext ***files, char ***paths, unsigned int *numfiles, const char *path, IAllocator *pAlloc)=0 |
virtual signed int | StartJobCreateOctree (signed long long *jobID, IVolumeDataContext *pData, signed int bSaveMemory, ENUM_SMOOTH_PARAM smoothType)=0 |
virtual signed int | StartJobCreateOctreeDep (signed long long *jobID, signed long long dataID, signed int bSaveMemory, ENUM_SMOOTH_PARAM smoothType)=0 |
virtual signed int | StartJobLoadCustomDataset (signed long long *jobID, ENUM_LOAD_DATASET_OPTIONS loadtype, const char *path)=0 |
virtual signed int | StartJobLoadDicomDirectory (signed long long *jobID, const char *path)=0 |
virtual signed int | StartJobLoadDICOMFromFileList (signed long long *jobID, const signed int numPaths, const char **paths)=0 |
virtual signed int | StartJobLoadRawData (signed long long *jobID, const char *path)=0 |
virtual signed int | StartJobLoadRawFiles (signed long long *jobID, RAW_DATASET_DESCRIPTION *rdd)=0 |
virtual signed int | StartJobLoadSeriesFromDICOMList (signed long long *jobID, const signed int numFiles, ILiteDICOMFileContext **files, const char *seriesUID)=0 |
virtual signed int | StartJobScanDICOMDirectory (signed long long *jobID, const char *path)=0 |
virtual signed int | TestFunction (signed long long Id, signed int objectType, signed int testType)=0 |
virtual signed int | UpdateVertexCallLists (const unsigned int numVertexCallLists, IVertexCallListContext **arrVertices)=0 |
virtual signed int | UpdateVertexCallListsEx (const signed int bUpdatingServer, const unsigned int toTransfer, const unsigned int numVertexCallLists, IVertexCallListContext **arrVertices)=0 |
![]() | |
template<class T > | |
signed int | AskInterface (T **pp) |
Represents a connection to an hdrcsrvd server. This object should be the starting point for creation of all other server-side data objects in your application. Use ILibrary::CreateObject() to create this object.
|
pure virtual |
Public for implementation reasons. Do not call.
|
pure virtual |
Cancels the specified job. Currently, only IVolumeSegmentationContext::FindPath() supports this operation.
jobID | The job to cancel. |
|
pure virtual |
Creates a connection to a server with no timeout.
host | The network address of the host computer. |
port | The port in which the host is listening. This number will be communicated when the server first starts up and is 6778 by default. |
pLogger | A pointer to a class that iplements ILogger for logging purposes |
serverResponse | 0 if the server has too many connections, -3 if the license file is invalid and -1 if everything is fine |
|
pure virtual |
Creates a connection to a server with a timeout.
host | The network address of the host computer. |
port | The port in which the host is listening. This number will be communicated when the server first starts up and is 6778 by default. |
pLogger | A pointer to a class that iplements ILogger for logging purposes |
serverResponse | 0 if the server has too many connections, -3 if the license file is invalid and -1 if everything is fine |
timeout | How long to wait before giving up on connecting in milliseconds. |
|
pure virtual |
Creates an IFreehandCutAdaptor pointer and returns it into the variable at the address pFreehandCutAdaptor.
pFreehandCutAdaptor | The address to return the IFreehandCutAdaptor pointer. |
|
pure virtual |
Creates an IInteractiveSegAdaptor pointer and returns it into the variable at the address pInteractiveSegAdaptor.
pInteractiveSegAdaptor | The address to return the IInteractiveSegAdaptor pointer. |
|
pure virtual |
Creates an IOctreeContext object from an IVolumeDataContext. Once this call completes, the octree will be initialized and ready to be passed to a render engine.
|
pure virtual |
Creates an IOctreeContext object from an IVolumeDataContext. Once this call completes, the octree will be initialized and ready to be passed to a render engine.
|
pure virtual |
Creates an IOctreeContext object from an IVolumeDataContext. Once this call completes, the octree will be initialized and ready to be passed to a render engine. bSaveMemory is deprecated and not necessary. It can be safely ignored.
|
pure virtual |
Creates an IOctreeContext object from an IVolumeDataContext. Once this call completes, the octree will be initialized and ready to be passed to a render engine. This overload of this function is deprecated.
|
pure virtual |
Placeholder for CreatePolygonUtil()
|
pure virtual |
Creates a new IRenderEngineContext of the speficied type.
|
pure virtual |
Creates an ITextureMapContext pointer and returns it into the variable at the address pTextureMapContext.
pTextureMapContext | The address to return the ITextureMapContext pointer. |
|
pure virtual |
Creates an IVertexCallListContext pointer and returns it into the variable at the address pVertexCallListContext.
pVertexCallListContext | The address to return the IVertexCallListContext pointer. |
|
pure virtual |
Creates an IVolumeSegmentation object. Don't forget to call IVolumeSegmentation::SetVolumeData() once it's been created.
|
pure virtual |
Decreases the reference count on this object by 1. If the reference count reaches 0, the object is deallocated.
Implements IRoot.
|
pure virtual |
Disconnets from the server. The server will clean up all objects you have not called ReleaseSessionResources() at this point in time.
|
pure virtual |
Public for implementation reasons. Do not call.
|
pure virtual |
Waits for an asynchronous octree creation operation to finish.
job | The job ID. |
pOctreeContext | The address of the IOctreeContext* to receive the location of the new object. |
|
pure virtual |
Waits for an asynchronous load operation to finish.
job | The job ID. |
pData | The address of the IVolumeDataContext* to receive the location of the new object. |
|
pure virtual |
Waits for an asynchronous load operation to finish.
job | The job ID. |
pData | The address of the IVolumeDataContext* to receive the location of the new object. |
|
pure virtual |
Waits for an asynchronous load operation to finish.
job | The job ID. |
files | The address of an ILiteDICOMFileContext** that will receive the array of ILiteDICOMFileContext* objects. |
numPaths | The number of files expected in the return parameter files. |
piAlloc | The allocator to use when creating the returned array. |
|
pure virtual |
Waits for an asynchronous load operation to finish.
job | The job ID. |
pData | The address of the IVolumeDataContext* to receive the location of the new object. |
|
pure virtual |
Waits for an asynchronous load operation to finish.
job | The job ID. |
pData | The address of the IVolumeDataContext* to receive the location of the new object. |
|
pure virtual |
Waits for an asynchronous scan operation to finish.
job | The job ID. |
files | The address of an ILiteDICOMFileContext** that will receive the array of ILiteDICOMFileContext* objects. |
paths | The address of an array of strings to get the path of each file returned in the parameter files. |
numfiles | The address of an integer to get the number of files describes in the parameter files. |
pAlloc | The allocator to use when creating the returned array. |
|
pure virtual |
Returns information about the status of a current asynchronous operation. If progress is 100, the job has completed. Errors can also be returned in the jobInfo structure.
|
pure virtual |
Returns a IDataHolderContext for the given object id. This interface is not currently functional.
|
pure virtual |
The version parameter will get the version of the server that we are currently connected to.
|
pure virtual |
Public for implementation reasons. Do not call.
|
pure virtual |
Increases the reference count on this object by 1. You do not need to call this after an object is first created. It is 1 by default.
Implements IRoot.
|
pure virtual |
Performs a synchronous load of data of the specified type. Use LoadRawData() for loading .raw files and LoadDicomDirectory() for loading DICOM directories. Type 1001 is to load via the Fovia .ini file shared memory function.
type | Type of data to load. This is generally the integer ID value set with IHdrcServer::SetDatasetLoadFunc(). |
path | Path of the data. This can be literally any string you like if you've written your own load function. For type 1001 it's the path to the .ini file on the server. |
pData | Receives the address of an IVolumeDataContext representing the data on the server |
|
pure virtual |
Performs a synchronous load of a DICOM directory. The folder is expected to contain exactly one DICOM series. The folder should not contain any non-DICOM files such as text based index files, etc. If your folder structure is more complicated than that, use ScanDICOMDirectory() and LoadSeriesFromDICOMList().
|
pure virtual |
Performs a synchronous load of a memory mapped files on Windows only. The memory mapped files are expected to contain exactly one DICOM series. The memory mapped should not contain any non-DICOM files such as text based index files, etc. It accepts a path to ini file with names of memory mapped files and the exact size of each file
|
pure virtual |
Loads up DICOM file objects from a list of paths to the file objects.
paths | Paths to the files on the server |
numPaths | The number of paths described in the parameter numPaths. |
files | Address of an ILiteDICOMFileContext** that will receive an array of ILiteDICOMFileContext* objects representing the valid DICOM files found. |
pAlloc | The allocator to use when allocating the ILiteDICOMFileContext* array. |
IOException |
|
pure virtual |
Loads an XML preset file stored on the server into the specified RENDER_PARAMS structu.
path | Path to the XML file. |
rp | The address of a RENDER_PARAMS that will get the data stored at path. |
|
pure virtual |
Performs a synchronous load of a RAW file.
|
pure virtual |
Performs a synchronous load of a RAW dataset that may have multiple files.
rdd | Raw dataset description to load |
pData | Receives the address of an IVolumeDataContext representing the data on the server |
|
pure virtual |
Loads a series from a list of DICOM files loaded into memory. Only files with the seriesUID will be loaded for inclusion in the data set. NOTE: This releases the ILiteDICOMFiles from memory on the server. You may no longer use any of the objects passed in after calling this function.
files | Files to scan. |
numFiles | The number of files described in the parameter files. |
seriesUID | UID of the series to load. You can qeury this by getting the DCM_SeriesInstanceUID from a file in the series. |
pData | Address of an IVolumeDataContext* to receive the newly loaded volume data. |
|
pure virtual |
Saves the current RENDER_PARAMS into an XML file on the server.
path | Path to the location the file should be stored. |
rp | The preset to save. |
|
pure virtual |
Scans a directory for DICOM files. This is a recursive scan, so subfolders will be searched as well.
path | Path to the directory on the server |
paths | Address of a char** that will receive an array of char arrays containing the paths of the loaded objects. |
files | Address of an ILiteDICOMFileContext** that will receive an array of ILiteDICOMFileContext* objects representing the valid DICOM files found. |
numfiles | Address of an integer that will get the number of files described in the parameter files. |
pAlloc | The allocator to use when allocating the ILiteDICOMFileContext* and char* arrays. |
IOException |
|
pure virtual |
Start an octree creation job. Use the job ID returned by this function and GetJobInfo() to query the status of the operation. See CreateOctree() for parameter definitions.
|
pure virtual |
Start an octree creation job. Use the job ID returned by this function and GetJobInfo() to query the status of the operation. See CreateOctree() for parameter definitions. This overload of this function is deprecated.
|
pure virtual |
Begins an asynchronous load of a dataset. See LoadCustomDataset() for more information about loading custom datasets. Use the job ID returned by this function and GetJobInfo() to query the status of the load operation.
|
pure virtual |
Starts an asynchronous load of a DICOM directory. The folder is expected to contain exactly one DICOM series. If your folder structure is more complicated than that, use ScanDICOMDirectory() and LoadSeriesFromDICOMList(). See StartJobLoadCustomDataset() for more information on this process.
jobID | Gets the job id for this operation. Use it for reference when getting the job info or calling the finish function. |
path | Path to the DICOM directory to load. |
|
pure virtual |
Begins Loading a list of DICOM files from a specified list of paths. Use the job ID returned by this function and GetJobInfo() to query the status of the load operation.
jobID | Gets the job id for this operation. Use it for reference when getting the job info or calling the finish function. |
numPaths | The number of paths specified in the parameter paths. |
paths | Location on the server of each of the files to load. |
|
pure virtual |
Starts an asynchronous load of a RAW file. See StartJobLoadCustomDataset() for more information on this process.
jobID | Gets the job id for this operation. Use it for reference when getting the job info or calling the finish function. |
path | Path to the RAW file to load. |
|
pure virtual |
Begins an asynchronous load of a RAW dataset that may have multiple files. Use the job ID returned by this function and GetJobInfo() to query the status of the load operation.
|
pure virtual |
Begins loading a DICOM series into memory for volume rendering. NOTE: This releases the ILiteDICOMFiles from memory on the server. You may no longer use any of the objects passed in after calling this function. Use the job ID returned by this function and GetJobInfo() to query the status of the load operation.
jobID | Gets the job id for this operation. Use it for reference when getting the job info or calling the finish function. |
numFiles | The number of files in the parameter files. |
files | The files that contain the series. Note that this can contain a sub-sequence of the series. |
seriesUID | UID of the series to load. You can qeury this by getting the DCM_SeriesInstanceUID from a file in the series. |
|
pure virtual |
Begins an asynchronous recursive scan of a directory for DICOM files. Use the job ID returned by this function and GetJobInfo() to query the status of the load operation.
jobID | Gets the job id for this operation. Use it for reference when getting the job info or calling the finish function. |
path | Location of the DICOM directory on the server. |
|
pure virtual |
Undocumented test function
|
pure virtual |
Updates the server state of the specified vertex call lists. Note that you normally should not have to call this function explicitly as the state is automatically updated as you set it in the appropriate SetRenderParams() calls.
numVertexCallLists | The number of call lists to update. |
arrVertices | An array of IVertexCallListContext to update on the server. |
|
pure virtual |
Placeholder for UpdateVertexCallListsEx()