<Float64VectorArray> Data Interface

Provides script language access to C++ objects of this type.

Class HierarchyNo registered superclass.

Function Members

Function members are as follows:

Return Type Function Name Documentation
<Float64VectorArray>Float64VectorArrayConstructs a <Float64VectorArray> object with the specified count and X, Y, Z, and W values.
int32AddAdds a <Float64Vector> to the end of the array.
int32BindIteratorsBinds iterators to this object.
int32BindPointerBinds a <MemoryPointer> or subclass to this object. The <MemoryPointer> becomes a pointer to this object that can be passed to compatible functions.
int32ClearClears the array and frees the underlying memory, but does not destroy the <Float64VectorArray> object.
int32CombineGiven ArrayA ( this array ) and ArrayB ( not this array ), combines ArrayB with ArrayA at the specified index in ArrayA.
int32ConvertBytesToCountSets the array count to a value guaranteed to be large enough to store an array of N bytes. Will round up to the nearest positive <int32> if the byte count provided does not align with the number of bytes per element. For example, ints are 4 bytes each, so providing a value of 16 bytes ensures the array count is set to 4.
int32CopyCopies the value of the source <Float64VectorArray> into this <Float64VectorArray>.
int32DelRemoves an item from the array at the specified index.
int32ElementSizeReturns the size of the element of which the array is composed. In this case, it returns sizeof( <Float64Vector> ), which is 32 bytes ( 4 * sizeof( <float64> ) ).
int32FillSets all the items in the <Float64VectorArray> to this value.
int32FindFinds a <Float64Vector> in the <Float64VectorArray>.
<Float64Iterator>FirstReturns an iterator positioned at the start of the collection.
<Float64Vector>GetReturns a pointer to the <Float64Vector> object at the specified index.
int32GetCountReturns the count of the underlying array object.
<Float64Vector>GetFirstReturns a pointer to the first object in the array or returns nullptr if the array is empty.
<Float64Vector>GetLastReturns a pointer to the last object in the array or returns nullptr if the array is empty.
<Float64Pointer>GetPointerReturns a pointer to this object. The pointer object is allocated with new so you must use auto in the declaration or you must manually delete the pointer object. For example: auto Float64Pointer ptr = object.GetPointer().
<Float64ArrayView>GetViewReturns a <Float64ArrayView> that contains first and last iterators for the collection.
int32InsertInserts a <Float64Vector> object into the array. May incur re-allocation costs depending on the size of any allocated reserve.
<Float64Iterator>LastReturns an iterator positioned at the end of the collection.
int32MergeAdds a <Float64Vector> object to the end if the value is not already in the <Float64VectorArray>.
int32MoveMoves the memory from the source array to the destination array. Leaves the source array empty with a count of zero.
int32PopPops the first item off the top of the stack.
int32Print1DPrints the array in 1D into a <StrList> object.
int32Print2DPrints the array in 2D into a <StrList> object.
int32PushPushes an item onto the stack ( at the end ).
int32RelocateRelocates a chunk of the array to a new index.
<Float64Vector>RemoveRemoves a <Float64Vector> object from the array, but does not destroy it. Returns a pointer to the <Float64Vector> object that was removed from the array.
int32SetSets the value at the specified index.
int32SetViewInternal use only.
int32ShrinkShrinks the array to a sub-range.
int32SizeInBytesReturns the size in bytes of the <Float64VectorArray>, which is the total number of bytes currently being used by the <Float64VectorArray>, and does not include any allocated reserve.

Object Members

Object members are as follows:

Type Name Accessor Name Documentation
Float64Vector[]Objects[ index ]Gets or sets the value of an element in the array at the specified index. The syntax is array.Objects[ n ], where n is a valid index into the array.
<Float64VectorArray>ValueReturns the value of this object's underlying array. For example: to assign the value of this object to another <Float64VectorArray>.
int32CountGets or sets the number of <float64> values in the <Float64VectorArray>. Setting the count to zero frees all the memory owned by the <Float64VectorArray>, but does not destroy the <Float64VectorArray> object.
int32ReserveGets or sets the reserve allocation. Note: this does not change the array count, it merely changes the size of the underlying buffer.