Pepper_31_C++_interfaces
Public Member Functions | List of all members
pp::VarArray Class Reference

#include <var_array.h>

Inheritance diagram for pp::VarArray:
Inheritance graph
Collaboration diagram for pp::VarArray:
Collaboration graph

Public Member Functions

 VarArray ()
 Constructs a new array var. More...
 
 VarArray (const Var &var)
 
 VarArray (const PP_Var &var)
 
 VarArray (const VarArray &other)
 Copy constructor. More...
 
virtual ~VarArray ()
 
VarArrayoperator= (const VarArray &other)
 Assignment operator. More...
 
virtual Varoperator= (const Var &other)
 
Var Get (uint32_t index) const
 
bool Set (uint32_t index, const Var &value)
 
uint32_t GetLength () const
 
bool SetLength (uint32_t length)
 
- Public Member Functions inherited from pp::Var
 Var ()
 
 Var (Null)
 A constructor used to create a Var of type Null. More...
 
 Var (bool b)
 
 Var (int32_t i)
 
 Var (double d)
 
 Var (const char *utf8_str)
 A constructor used to create a UTF-8 character Var. More...
 
 Var (const std::string &utf8_str)
 A constructor used to create a UTF-8 character Var. More...
 
 Var (PassRef, const PP_Var &var)
 
 Var (const PP_Var &var)
 A constructor that increments the reference count. More...
 
 Var (DontManage, const PP_Var &var)
 
 Var (const Var &other)
 A constructor for copying a Var. More...
 
virtual ~Var ()
 Destructor. More...
 
bool operator== (const Var &other) const
 
bool is_undefined () const
 
bool is_null () const
 
bool is_bool () const
 
bool is_string () const
 
bool is_object () const
 
bool is_array () const
 
bool is_dictionary () const
 
bool is_int () const
 
bool is_double () const
 
bool is_number () const
 
bool is_array_buffer () const
 This function determines if this Var is an ArrayBuffer. More...
 
bool AsBool () const
 
int32_t AsInt () const
 
double AsDouble () const
 
std::string AsString () const
 
const PP_Varpp_var () const
 
PP_Var Detach ()
 
std::string DebugString () const
 

Additional Inherited Members

- Protected Attributes inherited from pp::Var
PP_Var var_
 
bool is_managed_
 

Detailed Description

Definition at line 17 of file var_array.h.

Constructor & Destructor Documentation

pp::VarArray::VarArray ( )

Constructs a new array var.

pp::VarArray::VarArray ( const Var var)
explicit

Constructs a VarArray given a var for which is_array() is true. This will refer to the same array var, but allow you to access methods specific to arrays.

Parameters
[in]varAn array var.
pp::VarArray::VarArray ( const PP_Var var)
explicit

Constructs a VarArray given a PP_Var of type PP_VARTYPE_ARRAY.

Parameters
[in]varA PP_Var of type PP_VARTYPE_ARRAY.
pp::VarArray::VarArray ( const VarArray other)

Copy constructor.

virtual pp::VarArray::~VarArray ( )
virtual

Member Function Documentation

Var pp::VarArray::Get ( uint32_t  index) const

Gets an element from the array.

Parameters
[in]indexAn index indicating which element to return.
Returns
The element at the specified position. If index is larger than or equal to the array length, an undefined var is returned.

Referenced by pp::ext::internal::ArrayVarOutputAdapterWithStorage< T >::output().

uint32_t pp::VarArray::GetLength ( ) const

Gets the array length.

Returns
The array length.

Referenced by pp::ext::internal::ArrayVarOutputAdapterWithStorage< T >::output().

VarArray& pp::VarArray::operator= ( const VarArray other)

Assignment operator.

virtual Var& pp::VarArray::operator= ( const Var other)
virtual

The Var assignment operator is overridden here so that we can check for assigning a non-array var to a VarArray.

Parameters
[in]otherThe array var to be assigned.
Returns
The resulting VarArray (as a Var&).

Reimplemented from pp::Var.

bool pp::VarArray::Set ( uint32_t  index,
const Var value 
)

Sets the value of an element in the array.

Parameters
[in]indexAn index indicating which element to modify. If index is larger than or equal to the array length, the length is updated to be index + 1. Any position in the array that hasn't been set before is set to undefined, i.e., PP_Var of type PP_VARTYPE_UNDEFINED.
[in]valueThe value to set.
Returns
A bool indicating whether the operation succeeds.
bool pp::VarArray::SetLength ( uint32_t  length)

Sets the array length.

Parameters
[in]lengthThe new array length. If length is smaller than its current value, the array is truncated to the new length; any elements that no longer fit are removed. If length is larger than its current value, undefined vars are appended to increase the array to the specified length.
Returns
A bool indicating whether the operation succeeds.

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