#include <DynamicArray.hpp>

Inheritance diagram for ledger::core::api::DynamicArray:

Public Member Functions
virtual int64_t	size ()=0

virtual std::shared_ptr< DynamicArray >	pushInt (int32_t value)=0

virtual std::shared_ptr< DynamicArray >	pushLong (int64_t value)=0

virtual std::shared_ptr< DynamicArray >	pushString (const std::string &value)=0

virtual std::shared_ptr< DynamicArray >	pushDouble (double value)=0

virtual std::shared_ptr< DynamicArray >	pushData (const std::vector< uint8_t > &value)=0

virtual std::shared_ptr< DynamicArray >	pushBoolean (bool value)=0

virtual std::shared_ptr< DynamicArray >	pushObject (const std::shared_ptr< DynamicObject > &value)=0

virtual std::shared_ptr< DynamicArray >	pushArray (const std::shared_ptr< DynamicArray > &value)=0

virtual std::experimental::optional< std::string >	getString (int64_t index)=0

virtual std::experimental::optional< int32_t >	getInt (int64_t index)=0

virtual std::experimental::optional< int64_t >	getLong (int64_t index)=0

virtual std::experimental::optional< double >	getDouble (int64_t index)=0

virtual std::experimental::optional< std::vector< uint8_t > >	getData (int64_t index)=0

virtual std::experimental::optional< bool >	getBoolean (int64_t index)=0

virtual std::shared_ptr< DynamicObject >	getObject (int64_t index)=0

virtual std::shared_ptr< DynamicArray >	getArray (int64_t index)=0

virtual std::shared_ptr< DynamicArray >	concat (const std::shared_ptr< DynamicArray > &array)=0

virtual std::experimental::optional< DynamicType >	getType (int64_t index)=0

virtual bool	remove (int64_t index)=0

virtual std::string	dump ()=0

virtual std::vector< uint8_t >	serialize ()=0

virtual bool	isReadOnly ()=0

Static Public Member Functions
static std::shared_ptr< DynamicArray >	newInstance ()

static std::shared_ptr< DynamicArray >	load (const std::vector< uint8_t > &serialized)

Detailed Description

A collection of dynamic values in an array. Values can be retrieved via their indexes.

Member Function Documentation

◆ concat()

virtual std::shared_ptr<DynamicArray> ledger::core::api::DynamicArray::concat ( const std::shared_ptr< DynamicArray > & array )

pure virtual

Concatenate current DynamicArray with another one.

Parameters

array,DynamicArray object to concatenate with

Returns: DynamicArray object, concatenated DynamicArray

◆ dump()

virtual std::string ledger::core::api::DynamicArray::dump ( )

pure virtual

Dump whole object's content as string.

Returns: string, the string representation of the array

Implemented in ledger::core::DynamicArray.

◆ getArray()

virtual std::shared_ptr<DynamicArray> ledger::core::api::DynamicArray::getArray ( int64_t index )

pure virtual

Get DynamicArray object at a given index.

Parameters

index,64-bit integer

Returns: Optional DynamicArray

Implemented in ledger::core::DynamicArray.

◆ getBoolean()

virtual std::experimental::optional<bool> ledger::core::api::DynamicArray::getBoolean ( int64_t index )

pure virtual

Get bool at a given index.

Parameters

index,64-bit integer

Returns: Optional bool

Implemented in ledger::core::DynamicArray.

◆ getData()

virtual std::experimental::optional<std::vector<uint8_t> > ledger::core::api::DynamicArray::getData ( int64_t index )

pure virtual

Get binary at a given index.

Parameters

index,64-bit integer

Returns: Optional binary

Implemented in ledger::core::DynamicArray.

◆ getDouble()

virtual std::experimental::optional<double> ledger::core::api::DynamicArray::getDouble ( int64_t index )

pure virtual

Get double at a given index.

Parameters

index,64-bit integer

Returns: Optional double

Implemented in ledger::core::DynamicArray.

◆ getInt()

virtual std::experimental::optional<int32_t> ledger::core::api::DynamicArray::getInt ( int64_t index )

pure virtual

Get 32-bit integer at a given index.

Parameters

index,64-bit integer

Returns: Optional 32-bit integer

Implemented in ledger::core::DynamicArray.

◆ getLong()

virtual std::experimental::optional<int64_t> ledger::core::api::DynamicArray::getLong ( int64_t index )

pure virtual

Get 64-bit integer at a given index.

Parameters

index,64-bit integer

Returns: Optional 64-bit integer

Implemented in ledger::core::DynamicArray.

◆ getObject()

virtual std::shared_ptr<DynamicObject> ledger::core::api::DynamicArray::getObject ( int64_t index )

pure virtual

Get DynamicObject object at a given index.

Parameters

index,64-bit integer

Returns: Optional DynamicObject

Implemented in ledger::core::DynamicArray.

◆ getString()

virtual std::experimental::optional<std::string> ledger::core::api::DynamicArray::getString ( int64_t index )

pure virtual

Get a string at a given index.

Parameters

index,64-bit integer

Returns: Optional string

Implemented in ledger::core::DynamicArray.

◆ getType()

virtual std::experimental::optional<DynamicType> ledger::core::api::DynamicArray::getType ( int64_t index )

pure virtual

Get type of value stored at a given index.

Parameters

index,64 bits integer

Returns: Optional DynamicType enum entry

Implemented in ledger::core::DynamicArray.

◆ isReadOnly()

virtual bool ledger::core::api::DynamicArray::isReadOnly ( )

pure virtual

Get readonly status of object.

Returns: bool, whether the array is in read-only mode

Implemented in ledger::core::DynamicArray.

◆ load()

std::shared_ptr< api::DynamicArray > ledger::core::api::DynamicArray::load ( const std::vector< uint8_t > & serialized )

static

Parse a binary to a DynamicArray.

Parameters

serialized,binary to parse

Returns: Optional, the unserialized dynamic array

◆ newInstance()

std::shared_ptr< api::DynamicArray > ledger::core::api::DynamicArray::newInstance ( )

static

Create a new instance of DynamicArray class.

Returns: DynamicArray, a brand new instance of a dynamic array

◆ pushArray()

virtual std::shared_ptr<DynamicArray> ledger::core::api::DynamicArray::pushArray ( const std::shared_ptr< DynamicArray > & value )

pure virtual

Push a dynamic array.

Parameters

value,DynamicArray

Returns: DynamicArray with value stored in it

◆ pushBoolean()

virtual std::shared_ptr<DynamicArray> ledger::core::api::DynamicArray::pushBoolean ( bool value )

pure virtual

Push a bool.

Parameters

value,bool

Returns: DynamicArray with value stored in it

Implemented in ledger::core::DynamicArray.

◆ pushData()

virtual std::shared_ptr<DynamicArray> ledger::core::api::DynamicArray::pushData ( const std::vector< uint8_t > & value )

pure virtual

Push a binary.

Parameters

value,binary

Returns: DynamicArray with value stored in it

Implemented in ledger::core::DynamicArray.

◆ pushDouble()

virtual std::shared_ptr<DynamicArray> ledger::core::api::DynamicArray::pushDouble ( double value )

pure virtual

Push a double.

Parameters

value,double

Returns: DynamicArray with value stored in it

Implemented in ledger::core::DynamicArray.

◆ pushInt()

virtual std::shared_ptr<DynamicArray> ledger::core::api::DynamicArray::pushInt ( int32_t value )

pure virtual

Push a 32-bit integer.

Parameters

value,32-bit integer

Returns: DynamicArray with value stored in it

Implemented in ledger::core::DynamicArray.

◆ pushLong()

virtual std::shared_ptr<DynamicArray> ledger::core::api::DynamicArray::pushLong ( int64_t value )

pure virtual

Push a 64-bit integer.

Parameters

value,64-bit integer

Returns: DynamicArray with value stored in it

Implemented in ledger::core::DynamicArray.

◆ pushObject()

virtual std::shared_ptr<DynamicArray> ledger::core::api::DynamicArray::pushObject ( const std::shared_ptr< DynamicObject > & value )

pure virtual

Push a dynamic object.

Parameters

value,DynamicObject

Returns: DynamicArray with value stored in it

◆ pushString()

virtual std::shared_ptr<DynamicArray> ledger::core::api::DynamicArray::pushString ( const std::string & value )

pure virtual

Push a string.

Parameters

value,string

Returns: DynamicArray with value stored in it

Implemented in ledger::core::DynamicArray.

◆ remove()

virtual bool ledger::core::api::DynamicArray::remove ( int64_t index )

pure virtual

Delete value stored at given index.

Parameters

index,64 bits integer

Returns: bool, true if deletion succeeded

Implemented in ledger::core::DynamicArray.

◆ serialize()

virtual std::vector<uint8_t> ledger::core::api::DynamicArray::serialize ( )

pure virtual

Serialize whole object to a binary.

Returns: binary, the serialized array

Implemented in ledger::core::DynamicArray.

◆ size()

virtual int64_t ledger::core::api::DynamicArray::size ( )

pure virtual

Get count of values.

Returns: 64-bit integer

Implemented in ledger::core::DynamicArray.

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

src/api/DynamicArray.hpp
src/collections/DynamicArray.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ concat()

◆ dump()

◆ getArray()

◆ getBoolean()

◆ getData()

◆ getDouble()

◆ getInt()

◆ getLong()

◆ getObject()

◆ getString()

◆ getType()

◆ isReadOnly()

◆ load()

◆ newInstance()

◆ pushArray()

◆ pushBoolean()

◆ pushData()

◆ pushDouble()

◆ pushInt()

◆ pushLong()

◆ pushObject()

◆ pushString()

◆ remove()

◆ serialize()

◆ size()