Class for handling Vendor Data.
More...
#include <GTXVendorData.hpp>
Class for handling Vendor Data.
- Examples:
- vendor.cpp.
GTXVendorData::GTXVendorData |
( |
const char * |
identifier, |
|
|
int |
version |
|
) |
| |
Vendor Data Constructor.
Constructs a vendor data from a string an a version number
- Exceptions
-
- Parameters
-
identifier | vendor data identifier |
version | vendor data version |
Vendor Data Copy Constructor.
Constructs a vendor data by copying an existing one
- Exceptions
-
- Parameters
-
GTXVendorData::~GTXVendorData |
( |
| ) |
|
Vendor Data Destructor.
Deletes a Vendor Data contents
void GTXVendorData::AddAttributeDouble |
( |
const char * |
name, |
|
|
double |
value |
|
) |
| |
Add a double attribute to a Vendor Data.
This function adds a double attribute to a Vendor Data
- Exceptions
-
- Parameters
-
name | Attribute name |
value | Value of the attribute |
- Examples:
- vendor.cpp.
void GTXVendorData::AddAttributeDoubleArray |
( |
const char * |
name, |
|
|
const GTXDoubleArray & |
values |
|
) |
| |
void GTXVendorData::AddAttributeInt |
( |
const char * |
name, |
|
|
int |
value |
|
) |
| |
Add an integer attribute to a Vendor Data.
This function adds an integer attribute to a Vendor Data
- Exceptions
-
- Parameters
-
name | Attribute name |
value | Value of the attribute |
- Examples:
- vendor.cpp.
void GTXVendorData::AddAttributeIntArray |
( |
const char * |
name, |
|
|
const GTXIntArray & |
values |
|
) |
| |
void GTXVendorData::AddAttributeString |
( |
const char * |
name, |
|
|
const char * |
value |
|
) |
| |
Add a string attribute to a Vendor Data.
This function adds a string attribute to a Vendor Data
- Exceptions
-
- Parameters
-
name | Attribute name |
value | Value of the attribute |
- Examples:
- vendor.cpp.
void GTXVendorData::AddAttributeStringArray |
( |
const char * |
name, |
|
|
const GTXStringArray & |
values |
|
) |
| |
double GTXVendorData::GetAttributeDouble |
( |
const char * |
name | ) |
const |
Get value from a double attribute of a Vendor Data.
This function reads the value from a double attribute of a Vendor Data
- Returns
- Returned double value
- Exceptions
-
- Parameters
-
name | Name of the attribute to read |
- Examples:
- vendor.cpp.
GTXDoubleArray GTXVendorData::GetAttributeDoubleArray |
( |
const char * |
name | ) |
const |
Get value from a double array attribute of a Vendor Data.
This function reads the value from a double array attribute of a Vendor Data
- Returns
- Returned doubles values
- Exceptions
-
- Parameters
-
name | Name of the attribute to read |
- Examples:
- vendor.cpp.
int GTXVendorData::GetAttributeInt |
( |
const char * |
name | ) |
const |
Get value from an integer attribute of a Vendor Data.
This function reads the value from an integer attribute of a Vendor Data
- Returns
- Returned integer value
- Exceptions
-
- Parameters
-
name | Name of the attribute to read |
- Examples:
- vendor.cpp.
GTXIntArray GTXVendorData::GetAttributeIntArray |
( |
const char * |
name | ) |
const |
Get value from an integer array attribute of a Vendor Data.
This function reads the value from an integer array attribute of a Vendor Data
- Returns
- Returned integer values
- Exceptions
-
- Parameters
-
name | Name of the attribute to read |
- Examples:
- vendor.cpp.
const char * GTXVendorData::GetAttributeString |
( |
const char * |
name | ) |
const |
Get value from a string attribute of a Vendor Data.
This function reads the value from a string attribute of a Vendor Data
- Returns
- Returned string value
- Exceptions
-
- Parameters
-
name | Name of the attribute to read |
- Remarks: returned value is a string from the vendor data contents, so
- it does not have to (and should not) be freed.
- Examples:
- vendor.cpp.
GTXStringArray GTXVendorData::GetAttributeStringArray |
( |
const char * |
name | ) |
const |
Get value from a string array attribute of a Vendor Data.
This function reads the value from a string array attribute of a Vendor Data
- Returns
- Returned strings values
- Exceptions
-
- Parameters
-
name | Name of the attribute to read |
- Examples:
- vendor.cpp.
const char * GTXVendorData::GetIdentifier |
( |
| ) |
const |
Get identifier string from a Vendor Data.
This function reads the identifier string of a Vendor Data
- Returns
- Returned Vendor Data identifier
int GTXVendorData::GetVersion |
( |
| ) |
const |
Get version string from a Vendor Data.
This function reads the version string of a Vendor Data
- Returns
- Returned Vendor Data version
Vendor Data Copy = operator.
Copies a vendor data to another one
- Exceptions
-
- Returns
- copied vendor data
- Parameters
-
The documentation for this class was generated from the following files: