|
| virtual void OMNI_PVD_CALL | setLogFunction (OmniPvdLogFunction logFunction)=0 |
| | Sets the log function to print the internal debug messages of the OmniPVD Reader instance.
|
| |
| virtual void OMNI_PVD_CALL | setReadStream (OmniPvdReadStream *stream)=0 |
| | Sets the read stream that contains the OmniPVD API command stream.
|
| |
| virtual bool OMNI_PVD_CALL | startReading (OmniPvdVersionType *majorVersion, OmniPvdVersionType *minorVersion, OmniPvdVersionType *patch)=0 |
| | Extracts the versions from the binary file ro read and tests if the file is older or equal to that of the reader.
|
| |
| virtual OmniPvdCommandEnum::Enum OMNI_PVD_CALL | getNextCommand ()=0 |
| | The heartbeat function of the reader class. As long as the command that is returned is not equal to OmniPvdCommandEnum::eOmniPvdInvalid, then one can safely extract the data fields from the command.
|
| |
| virtual OmniPvdCommandEnum::Enum OMNI_PVD_CALL | getCommandType ()=0 |
| | Returns the command type as an enumerator of the latest command.
|
| |
| virtual OmniPvdVersionType OMNI_PVD_CALL | getMajorVersion ()=0 |
| | Returns the major version of the stream.
|
| |
| virtual OmniPvdVersionType OMNI_PVD_CALL | getMinorVersion ()=0 |
| | Returns the minor version of the stream.
|
| |
| virtual OmniPvdVersionType OMNI_PVD_CALL | getPatch ()=0 |
| | Returns the patch number of the stream.
|
| |
| virtual OmniPvdContextHandle OMNI_PVD_CALL | getContextHandle ()=0 |
| | Returns the context handle of the latest commmnd, if it had one, else 0.
|
| |
| virtual OmniPvdObjectHandle OMNI_PVD_CALL | getObjectHandle ()=0 |
| | Returns the object handle of the latest commmnd, if it had one, else 0.
|
| |
| virtual OmniPvdClassHandle OMNI_PVD_CALL | getClassHandle ()=0 |
| | Returns the class handle of the latest commmnd, if it had one, else 0.
|
| |
| virtual OmniPvdClassHandle OMNI_PVD_CALL | getBaseClassHandle ()=0 |
| | Returns the base class handle of the latest commmnd, if it had one, else 0.
|
| |
| virtual OmniPvdAttributeHandle OMNI_PVD_CALL | getAttributeHandle ()=0 |
| | Returns the attribute handle of the latest commmnd, if it had one, else 0.
|
| |
| virtual char *OMNI_PVD_CALL | getClassName ()=0 |
| | Returns the class name of the latest commmnd, if it had one, else a null terminated string of length 0.
|
| |
| virtual char *OMNI_PVD_CALL | getAttributeName ()=0 |
| | Returns the attribute name of the latest commmnd, if it had one, else a null terminated string of length 0.
|
| |
| virtual char *OMNI_PVD_CALL | getObjectName ()=0 |
| | Returns the object name of the latest commmnd, if it had one, else a null terminated string of length 0.
|
| |
| virtual uint8_t *OMNI_PVD_CALL | getAttributeDataPointer ()=0 |
| | Returns the attribute data pointer, the data is undefined if the last command did not contain attribute data.
|
| |
| virtual OmniPvdAttributeDataType OMNI_PVD_CALL | getAttributeDataType ()=0 |
| | Returns the attribute data type, the data is undefined if the last command did not contain attribute data.
|
| |
| virtual uint32_t OMNI_PVD_CALL | getAttributeDataLength ()=0 |
| | Returns the attribute data length, the data length of the last command.
|
| |
| virtual uint32_t OMNI_PVD_CALL | getAttributeNumberElements ()=0 |
| | Returns the number of elements contained in the last set operation.
|
| |
| virtual OmniPvdClassHandle OMNI_PVD_CALL | getAttributeClassHandle ()=0 |
| | Returns the numberclass handle of the attribute class.
|
| |
| virtual uint64_t OMNI_PVD_CALL | getFrameTimeStart ()=0 |
| | Returns the frame start value.
|
| |
| virtual uint64_t OMNI_PVD_CALL | getFrameTimeStop ()=0 |
| | Returns the frame stop value.
|
| |
| virtual OmniPvdClassHandle OMNI_PVD_CALL | getEnumClassHandle ()=0 |
| | Returns the class handle containing the enum values.
|
| |
| virtual uint32_t OMNI_PVD_CALL | getEnumValue ()=0 |
| | Returns the enum value for a specific flag.
|
| |
Used to read debug information from an OmniPvdReadStream.
Using the getNextCommand function in a while loop for example one can traverse the stream one command after another. Given the command, different functions below will be available.
Using the OmniPvdCommandEnum one can determine the type of command and like that use the appropriate get functions to extract the payload from the command.
1.9.8