Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

nvutil::UPITID Class Reference

Unique Plug Interface Type ID. More...

#include <PlugIn.h>

List of all members.

Public Methods

 UPITID ()
 Default constructor. More...

NVSG_API UPITID (unsigned short pit, const char verStr[16])
 Constructor. More...

NVSG_API UPITID (const UPITID &rhs)
 Copy constructor. More...


Friends

bool operator< (const UPITID &lhs, const UPITID &rhs)
 "Less than" comparison. More...

bool operator== (const UPITID &lhs, const UPITID &rhs)
 Comparison. More...

bool operator!= (const UPITID &lhs, const UPITID &rhs)
 Comparison. More...


Detailed Description

Unique Plug Interface Type ID.

A helper class for assembling unique IDs that identify a certain plug interface type. A short numeric interface type ID and a 16 byte version string are concatenated to define a unique plug interface type identifier.

Note:
A UPITID must be defined by a client which wants to use a certain plug interface type provided by a plug-in.


Constructor & Destructor Documentation

nvutil::UPITID::UPITID   [inline]
 

Default constructor.

Default constructs a UPITID object.

NVSG_API nvutil::UPITID::UPITID unsigned short    pit,
const char    verStr[16]
 

Constructor.

Constructs a UPITID object from a plug interface type ID and a version string.

Parameters:
pit  Identifies a certain plug interface type
verStr  A 16 byte version string to maintain version safty

NVSG_API nvutil::UPITID::UPITID const UPITID &    rhs
 

Copy constructor.

Constructs a UPITID object from another UPITID object.


Friends And Related Function Documentation

bool operator< const UPITID &    lhs,
const UPITID &    rhs
[friend]
 

"Less than" comparison.

Compares two UPITID objects. This operator is required e.g. if it is intended to store UPITID objects in ordered containers.

Returns:
true if lhs is less than rhs, false otherwise.
Parameters:
lhs  Left operand
rhs  Right operand

bool operator== const UPITID &    lhs,
const UPITID &    rhs
[friend]
 

Comparison.

Tests two UPITID objects on equality.

Returns:
true if lhs is equal to rhs, false otherwise.
Parameters:
lhs  Left operand
rhs  Right operand

bool operator!= const UPITID &    lhs,
const UPITID &    rhs
[friend]
 

Comparison.

Tests two UPITID objects on inequality.

Returns:
true if lhs is unequal to rhs, false otherwise.
Parameters:
lhs  Left operand
rhs  Right operand


The documentation for this class was generated from the following file:
Generated on Tue Mar 1 13:20:44 2005 for NVSGSDK by NVIDIA