#include <PlugIn.h>
Collaboration diagram for nvutil::UPIID:
Public Member Functions | |
UPIID () | |
Default constructor. | |
NVSG_API | UPIID (const char idstr[8], UPITID pitid) |
Constructor. | |
NVSG_API UPIID & | operator= (const UPIID &rhs) |
Assignment operator. | |
const char * | getPlugSpecificIDString () const |
Receive specific identifier string. | |
const UPITID & | getPlugInterfaceType () const |
Receive the unique interface type. | |
Friends | |
bool | operator< (const UPIID &lhs, const UPIID &rhs) |
"Less than" comparison | |
bool | operator== (const UPIID &lhs, const UPIID &rhs) |
Comparison. | |
bool | operator!= (const UPIID &lhs, const UPIID &rhs) |
Comparison. |
A helper class for assembling unique IDs that identify a certain plug interface. An 8 byte specific identifier string will be concatenated to a UPITID to define a unique plug interface identifier, client code can query for.
|
Default constructor. Default constructs a UPIID object. |
|
Constructor. Constructs a UPIID object from a specific identifier string (8 bytes) and a UPITID which identifies the certain type of the interface a plug-in provides.
|
|
Assignment operator. Assigning a new UPIID.
|
|
Receive specific identifier string. Get hold of the identifier that is specific for a plug interface provided by a certain plug-in. Client code can take this additional information to decide which plug-in best matches the client's requirements concerning a certain plug interface type. The kind of information stored in the specific identifier string and how a certain client can use it, must be documented in detail by the plug-in writer.
|
|
Receive the unique interface type. This is for a client to verify if the plug interface type stored in this interface ID is the same, it was querying for. |
|
"Less than" comparison Compares two UPIID objects. This operator is required e.g. if it is intended to store UPIID objects in ordered containers.
|
|
Comparison. Tests two UPIID objects on equality.
|
|
Comparison. Tests two UPIID objects on inequality.
|