ArcGIS Procedural Runtime  3.2.10650
List of all members | Public Member Functions
prt::AttributableSetter Class Referenceabstract

#include <Attributable.h>

Inheritance diagram for prt::AttributableSetter:
[legend]

Public Member Functions

virtual Status setBool (const wchar_t *key, bool value)=0
 
virtual Status setBoolArray (const wchar_t *key, const bool *value, size_t count)=0
 
virtual Status setFloat (const wchar_t *key, double value)=0
 
virtual Status setFloatArray (const wchar_t *key, const double *value, size_t count)=0
 
virtual Status setInt (const wchar_t *key, int32_t value)=0
 
virtual Status setIntArray (const wchar_t *key, const int32_t *value, size_t count)=0
 
virtual Status setString (const wchar_t *key, const wchar_t *value)=0
 
virtual Status setStringArray (const wchar_t *key, const wchar_t *const *value, size_t count)=0
 

Detailed Description

Interface for write-only attribute builder classes

Member Function Documentation

◆ setBool()

virtual Status prt::AttributableSetter::setBool ( const wchar_t *  key,
bool  value 
)
pure virtual

Sets a boolean.

Parameters
keyKey to set.
valueValue to copy.
Returns
STATUS_OK on success, STATUS_KEY_ALREADY_TAKEN or other status on failure.

◆ setBoolArray()

virtual Status prt::AttributableSetter::setBoolArray ( const wchar_t *  key,
const bool *  value,
size_t  count 
)
pure virtual

Sets an array of booleans.

Parameters
keyKey to set.
valuePointer to the array to copy.
countNumber of elements to copy.
Returns
STATUS_OK on success, STATUS_KEY_ALREADY_TAKEN or other status on failure.

◆ setFloat()

virtual Status prt::AttributableSetter::setFloat ( const wchar_t *  key,
double  value 
)
pure virtual

Sets a float value.

Parameters
keyKey to set.
valueValue to copy.
Returns
STATUS_OK on success, STATUS_KEY_ALREADY_TAKEN or other status on failure.

◆ setFloatArray()

virtual Status prt::AttributableSetter::setFloatArray ( const wchar_t *  key,
const double *  value,
size_t  count 
)
pure virtual

Sets an array of floats.

Parameters
keyKey to set.
valuePointer to the array to copy.
countNumber of elements to copy.
Returns
STATUS_OK on success, STATUS_KEY_ALREADY_TAKEN or other status on failure.

◆ setInt()

virtual Status prt::AttributableSetter::setInt ( const wchar_t *  key,
int32_t  value 
)
pure virtual

Sets an integer.

Parameters
keyKey to set.
valueValue to copy.
Returns
STATUS_OK on success, STATUS_KEY_ALREADY_TAKEN or other status on failure.

◆ setIntArray()

virtual Status prt::AttributableSetter::setIntArray ( const wchar_t *  key,
const int32_t *  value,
size_t  count 
)
pure virtual

Sets an array of integers.

Parameters
keyKey to set.
valuePointer to the array to copy.
countNumber of elements to copy.
Returns
STATUS_OK on success, STATUS_KEY_ALREADY_TAKEN or other status on failure.

◆ setString()

virtual Status prt::AttributableSetter::setString ( const wchar_t *  key,
const wchar_t *  value 
)
pure virtual

Sets a string.

Parameters
keyKey to set.
valuePointer to string to copy.
Returns
STATUS_OK on success, STATUS_KEY_ALREADY_TAKEN or other status on failure.

◆ setStringArray()

virtual Status prt::AttributableSetter::setStringArray ( const wchar_t *  key,
const wchar_t *const *  value,
size_t  count 
)
pure virtual

Sets an array of strings.

Parameters
keyKey to set.
valuePointer to the array to copy.
countNumber of elements to copy.
Returns
STATUS_OK on success, STATUS_KEY_ALREADY_TAKEN or other status on failure.

The documentation for this class was generated from the following file: