Cancels the specified job. Currently, only IVolumeSegmentationContext::FindPath() supports this operation.

Parameters:

jobID

The job to cancel.

Creates a connection to a server with no timeout.

Parameters:

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

Creates a connection to a server with a timeout.

Parameters:

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.

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.

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.

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.

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.

Placeholder for CreatePolygonUtil()

Creates a new IRenderEngineContext of the speficied type.

Creates an ITextureMapContext pointer and returns it into the variable at the address pTextureMapContext.

Parameters

pTextureMapContext

The address to return the ITextureMapContext pointer.

Creates an IVertexCallListContext pointer and returns it into the variable at the address pVertexCallListContext.

Parameters

pVertexCallListContext

The address to return the IVertexCallListContext pointer.

Creates an IVolumeSegmentation object. Don't forget to call IVolumeSegmentation::SetVolumeData() once it's been created.

Decreases the reference count on this object by 1. If the reference count reaches 0, the object is deallocated.

Implements IRoot.

Sets the volume data for this engine. Either parameter may be null. This is important because MPR engines do not require an Octree

Parameters

pData	The volume data.
pOctree	An initialized octree for the previously specified volume data.

Waits for an asynchronous octree creation operation to finish.

Parameters:

job	The job ID.
pOctreeContext	The address of the IOctreeContext* to receive the location of the new object.

Waits for an asynchronous load operation to finish.

Parameters:

job	The job ID.
pData	The address of the IVolumeDataContext* to receive the location of the new object.

Waits for an asynchronous load operation to finish.

Parameters:

job	The job ID.
pData	The address of the IVolumeDataContext* to receive the location of the new object.

Waits for an asynchronous load operation to finish.

Parameters:

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.

Waits for an asynchronous load operation to finish.

Parameters:

job	The job ID.
pData	The address of the IVolumeDataContext* to receive the location of the new object.

Waits for an asynchronous load operation to finish.

Parameters:

job	The job ID.
pData	The address of the IVolumeDataContext* to receive the location of the new object.

Waits for an asynchronous scan operation to finish.

Parameters:

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.

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.

The version parameter will get the version of the server that we are currently connected to.

Returns:

If successful, S_OK. If version is NULL, E_INVALIDARG. If we're not connected to a server, E_UNEXPECTED.

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.

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.

Parameters

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

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().

Loads up DICOM file objects from a list of paths to the file objects.

Parameters:

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.

Exceptions:

IOException

Loads an XML preset file stored on the server into the specified RENDER_PARAMS structu.

Parameters

path	Path to the XML file.
rp	The address of a RENDER_PARAMS that will get the data stored at path.

Performs a synchronous load of a RAW file.

Performs a synchronous load of a RAW dataset that may have multiple files.

Parameters

rdd	Raw dataset description to load
pData	Receives the address of an IVolumeDataContext representing the data on the server

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.

Parameters:

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.

Saves the current RENDER_PARAMS into an XML file on the server.

Parameters

path	Path to the location the file should be stored.
rp	The preset to save.

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.

Begins an asynchronous load of a dataset. 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.

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.

Parameters:

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.

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.

Parameters:

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.

Starts an asynchronous load of a RAW file. See StartJobLoadCustomDataset() for more information on this process.

Parameters:

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.

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.

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.

Parameters:

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.

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.

Parameters:

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.

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.

Parameters:

numVertexCallLists	The number of call lists to update.
arrVertices	An array of IVertexCallListContext to update on the server.

Placeholder for UpdateVertexCallListsEx()