Click or drag to resize
SoLDMReader Class
Inheritance Hierarchy

Namespace: OIV.LDM.Readers
Assembly: OIV.LDM (in OIV.LDM.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public abstract class SoLDMReader : SoVolumeReader

The SoLDMReader type exposes the following members.

Constructors
  NameDescription
Public methodSoLDMReader
Default constructor.
Top
Methods
  NameDescription
Public methodCloseAllHandles
Close all file handles currently opened by the reader.
(Inherited from SoVolumeReader.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetBbox
Returns the bounding box of the data associated with the specified file ID. The file ID corresponds to the tile ID in an LDM data file. If returns FALSE, not supported.
Public methodGetBorderFlag
Returns the border flag. If 0, tiles do not overlap. If not 0, they do.
(Overrides SoVolumeReaderGetBorderFlag.)
Public methodGetCenter
Returns the center of the data associated with the specified file ID. If returns FALSE, not supported.
Public methodGetConfiguredWriter
Returns a writer that correspond to this reader (same format, same parameters, etc...).
(Inherited from SoVolumeReader.)
Public methodGetDataChar
Gets the characteristics (file header) of the data volume. size is the size of the actual volume. type is the type of the data. dim is the dimension of the data.
(Overrides SoVolumeReaderGetDataChar(SbBox3f, SoDataSetDataTypes, SbVec3i32).)
Public methodGetDimension
Returns the dimension of the data.
Public methodGetDirectCoordSys
Return whether the coordinate system used is direct or not.
(Inherited from SoVolumeReader.)
Public methodGetDirectCoordSysAutoDetection
Return automatic detection value.
(Inherited from SoVolumeReader.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetHistogram
Returns the distribution of data values, i.e., the number of voxels per data value. numVox(0) is the number of voxels with value 0, numVox(1) is the number of voxels with value 1, and so on.
(Overrides SoVolumeReaderGetHistogram(Queue).)
Public methodGetMinMax(Double, Double)
Returns min max if stored in file for float data type
(Overrides SoVolumeReaderGetMinMax(Double, Double).)
Public methodGetMinMax(Int32, Int32)
Returns min max if stored in file (obsolete)
(Overrides SoVolumeReaderGetMinMax(Int32, Int32).)
Public methodGetMinMax(Int64, Int64)
Returns min max if stored in file for integer data type
(Overrides SoVolumeReaderGetMinMax(Int64, Int64).)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNumSignificantBits
This method is optional. It returns the number of significant bits of the volume data.
(Inherited from SoVolumeReader.)
Public methodGetOriginalFilename
Returns original file name from which the data has been converted to LDM format if stored in file.
(Overrides SoVolumeReaderGetOriginalFilename.)
Public methodGetReaderType
Returns the reader type.
(Overrides SoVolumeReaderGetReaderType.)
Public methodGetSize
Returns the bounding box of the total data in world coordinates.
Public methodGetStringName (Inherited from SoBase.)
Public methodGetSubSlice
Note: SoLDMReader does not implement this method.
(Overrides SoVolumeReaderGetSubSlice(SbBox2i32, Int32, SbNativeArrayByte).)
Public methodGetTileMinMax
Returns the minimum and maximum data values for the given tile. It allows to profit of optimizations.
(Overrides SoVolumeReaderGetTileMinMax(Int32).)
Public methodGetTileSize
Returns the size of a data tile.
(Overrides SoVolumeReaderGetTileSize(SbVec3i32).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetXmlTag
Gets the first occurrence of the XML element whose tag name is specified by tagName. Then the associated value or subtags can be fetched using the SbXmlElement methods. Custom XML tags can be added to the LDM header file by using the method SoLDMConverter.SetXmlCallback().
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsLittleEndian
Returns whether the bytes of the data are stored in big or little endian order. The order is little endian if the function returns true.
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodReadTile(Int32, SbBox3i32)
Given an index, reads a tile if the data is organized in tiles (for LDM).
(Inherited from SoVolumeReader.)
Public methodReadTile(Int32, SbNativeArrayByte, SbBox3i32) (Overrides SoVolumeReaderReadTile(Int32, SbNativeArrayByte, SbBox3i32).)
Public methodSet

Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

(Inherited from SoFieldContainer.)
Public methodSetDirectCoordSysAutoDetection
Sets whether or not the reader should automatically try to detect if the coordinate system used is direct or not. The function will return FALSE if the feature is not supported by the current reader. Default is false.
(Inherited from SoVolumeReader.)
Public methodSetDirectCoorSys
Specify if the coordinate system used is direct or not. The function will return FALSE if the feature is not supported by the current reader. Default is false.
(Inherited from SoVolumeReader.)
Public methodSetFilename
Specifies the path of the file. Returns 0 for success. Any other return value indicates failure.
(Inherited from SoVolumeReader.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOutputDataType
Sets the output data type. Returns FALSE if the reader does not support this feature.
(Inherited from SoVolumeReader.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodSetUserData
Sets user data. Usually this is a filename. The simplest approach is to call the setFileName method to handle file I/O and then access the file in memory, but it is possible to write your own method.
(Overrides SoVolumeReaderSetUserData(Object).)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoBase.)
Top
Properties
  NameDescription
Public propertyDataConverted
The returned boolean indicates if the data is already organized for the LDM module. If TRUE, VolumeViz will use the readTile method.
(Inherited from SoVolumeReader.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertyIsThreadSafe
Let the system know if the reader is thread safe or not. this function is called by VolumeViz when using the multiIO mode.
(Inherited from SoVolumeReader.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
See Also