Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::StringArrayData Class Reference

Array data of a unicode character string (specialization). More...

Inheritance diagram for Arcane::StringArrayData:
Collaboration diagram for Arcane::StringArrayData:

Classes

class  Impl

Public Types

typedef String DataType
typedef StringArrayData ThatClass
typedef IArrayDataT< String > DataInterfaceType
Public Types inherited from Arcane::IArrayDataT< String >
typedef IArrayDataT< String > ThatClass

Public Member Functions

 StringArrayData (ITraceMng *trace)
 StringArrayData (const DataStorageBuildInfo &dsbi)
 StringArrayData (const StringArrayData &rhs)
Integer dimension () const override
 Dimension. 0 for a scalar, 1 for a mono-dim array, 2 for a bi-dim array.
Integer multiTag () const override
 Multi-tag. 0 if not multiple, 1 if multiple, 2 if multiple for MultiArray variables (obsolete).
eDataType dataType () const override
 Data type.
void serialize (ISerializer *sbuf, IDataOperation *operation) override
 Serializes the data by applying the operation.
void serialize (ISerializer *sbuf, Int32ConstArrayView ids, IDataOperation *operation) override
 Serialize the data for the indices ids.
Array< DataType > & value () override
 Data value.
const Array< DataType > & value () const override
 Constant data value.
ConstArrayView< DataType > view () const override
 Constant view on the data.
ArrayView< DataType > view () override
 View on the data.
void resize (Integer new_size) override
 Resize the data.
IData * clone () override
 Clone the data. The created instance must be destroyed by the 'delete' operator.
IData * cloneEmpty () override
 Clone the data but without elements. The created instance must be destroyed by the 'delete' operator.
Ref< IData > cloneRef () override
 Clone the data.
Ref< IData > cloneEmptyRef () override
 Clone the data but without elements.
DataInterfaceType * cloneTrue () override
 Clone the data.
DataInterfaceType * cloneTrueEmpty () override
 Clone the data but without elements.
Ref< DataInterfaceType > cloneTrueRef () override
 Clone the data.
Ref< DataInterfaceType > cloneTrueEmptyRef () override
 Clone the data but without elements.
DataStorageTypeInfo storageTypeInfo () const override
 Information about the data container type.
void fillDefault () override
 Fills the data with its default value.
void setName (const String &name) override
 Sets the name of the data (internal).
Ref< ISerializedData > createSerializedDataRef (bool use_basic_type) const override
 Serialize the data.
void allocateBufferForSerializedData (ISerializedData *sdata) override
 Allocate memory to read the serialized values sdata.
void assignSerializedData (const ISerializedData *sdata) override
 Assign the serialized values sdata to the data.
void copy (const IData *data) override
 Copy the data data into the current instance.
void swapValues (IData *data) override
 Swap the values of data with those of the instance.
void computeHash (IHashAlgorithm *algo, ByteArray &output) const override
 Compute a hash key on this data.
void computeHash (DataHashInfo &hash_info) const
ArrayShape shape () const override
 Array shape for a 1D or 2D data item.
void setShape (const ArrayShape &) override
 Sets the array shape.
void setAllocationInfo (const DataAllocationInfo &v) override
 Sets the allocation information.
DataAllocationInfo allocationInfo () const override
 Allocation information.
void visit (IArrayDataVisitor *visitor) override
 Applies the visitor to the data.
void visit (IDataVisitor *visitor) override
 Applies the visitor to the data.
void visitScalar (IScalarDataVisitor *visitor) override
 Apply the visitor to the data.
void visitArray (IArrayDataVisitor *visitor) override
 Apply the visitor to the data.
void visitArray2 (IArray2DataVisitor *visitor) override
 Apply the visitor to the data.
IArrayDataInternalT< DataType > * _internal () override
IDataInternal * _commonInternal () override
Public Member Functions inherited from Arcane::ReferenceCounterImpl
void addReference ()
void removeReference ()
void _internalAddReference ()
bool _internalRemoveReference ()
Public Member Functions inherited from Arcane::IData
virtual void visitMultiArray2 (IMultiArray2DataVisitor *visitor)
 Apply the visitor to the data.

Static Public Member Functions

static DataStorageTypeInfo staticStorageTypeInfo ()

Private Member Functions

 ARCCORE_DEFINE_REFERENCE_COUNTED_INCLASS_METHODS ()
ThatClass * _cloneTrue () const
ThatClass * _cloneTrueEmpty () const

Private Attributes

UniqueArray< DataType > m_value
 Data.
ITraceMng * m_trace
IArrayDataInternalT< String > * m_internal
DataAllocationInfo m_allocation_info

Friends

class Impl

Detailed Description

Array data of a unicode character string (specialization).

Definition at line 50 of file StringArrayData.cc.

Member Typedef Documentation

◆ DataInterfaceType

typedef IArrayDataT<String> Arcane::StringArrayData::DataInterfaceType

Definition at line 62 of file StringArrayData.cc.

◆ DataType

typedef String Arcane::StringArrayData::DataType

Definition at line 60 of file StringArrayData.cc.

◆ ThatClass

typedef StringArrayData Arcane::StringArrayData::ThatClass

Definition at line 61 of file StringArrayData.cc.

Constructor & Destructor Documentation

◆ StringArrayData() [1/3]

Arcane::StringArrayData::StringArrayData ( ITraceMng * trace)
explicit

Definition at line 190 of file StringArrayData.cc.

◆ StringArrayData() [2/3]

Arcane::StringArrayData::StringArrayData ( const DataStorageBuildInfo & dsbi)
explicit

Definition at line 183 of file StringArrayData.cc.

◆ StringArrayData() [3/3]

Arcane::StringArrayData::StringArrayData ( const StringArrayData & rhs)

Definition at line 196 of file StringArrayData.cc.

◆ ~StringArrayData()

Arcane::StringArrayData::~StringArrayData ( )
override

Definition at line 204 of file StringArrayData.cc.

Member Function Documentation

◆ _cloneTrue()

ThatClass * Arcane::StringArrayData::_cloneTrue ( ) const
inlineprivate

Definition at line 143 of file StringArrayData.cc.

◆ _cloneTrueEmpty()

ThatClass * Arcane::StringArrayData::_cloneTrueEmpty ( ) const
inlineprivate

Definition at line 144 of file StringArrayData.cc.

◆ _commonInternal()

IDataInternal * Arcane::StringArrayData::_commonInternal ( )
inlineoverridevirtual

Implements Arcane::IData.

Definition at line 128 of file StringArrayData.cc.

◆ _internal()

IArrayDataInternalT< DataType > * Arcane::StringArrayData::_internal ( )
inlineoverridevirtual

Implements Arcane::IArrayDataT< String >.

Definition at line 127 of file StringArrayData.cc.

◆ allocateBufferForSerializedData()

void Arcane::StringArrayData::allocateBufferForSerializedData ( ISerializedData * sdata)
overridevirtual

Allocate memory to read the serialized values sdata.

This method sets sdata->setBuffer(), which will contain the memory needed to read the serialized data.

Implements Arcane::IData.

Definition at line 278 of file StringArrayData.cc.

References Arcane::ISerializedData::allocateMemory(), Arcane::ISerializedData::baseDataType(), Arcane::DT_Byte, and Arcane::ISerializedData::memorySize().

Here is the call graph for this function:

◆ allocationInfo()

DataAllocationInfo Arcane::StringArrayData::allocationInfo ( ) const
inlineoverridevirtual

Allocation information.

Implements Arcane::IData.

Definition at line 112 of file StringArrayData.cc.

◆ assignSerializedData()

void Arcane::StringArrayData::assignSerializedData ( const ISerializedData * sdata)
overridevirtual

Assign the serialized values sdata to the data.

The buffer containing the serialization values must have be allocated by calling allocateBufferForSerializedData().

Implements Arcane::IData.

Definition at line 291 of file StringArrayData.cc.

References Arcane::ISerializedData::baseDataType(), Arcane::ISerializedData::constBytes(), Arcane::DT_Byte, Arcane::ISerializedData::extents(), m_value, and Arcane::ConstArrayView< T >::size().

Here is the call graph for this function:

◆ clone()

IData * Arcane::StringArrayData::clone ( )
inlineoverridevirtual

Clone the data. The created instance must be destroyed by the 'delete' operator.

Implements Arcane::IData.

Definition at line 83 of file StringArrayData.cc.

References cloneTrue().

Here is the call graph for this function:

◆ cloneEmpty()

IData * Arcane::StringArrayData::cloneEmpty ( )
inlineoverridevirtual

Clone the data but without elements. The created instance must be destroyed by the 'delete' operator.

Implements Arcane::IData.

Definition at line 84 of file StringArrayData.cc.

References cloneTrueEmpty().

Here is the call graph for this function:

◆ cloneEmptyRef()

Ref< IData > Arcane::StringArrayData::cloneEmptyRef ( )
inlineoverridevirtual

Clone the data but without elements.

Implements Arcane::IData.

Definition at line 86 of file StringArrayData.cc.

References cloneTrueEmpty(), and Arcane::makeRef().

Here is the call graph for this function:

◆ cloneRef()

Ref< IData > Arcane::StringArrayData::cloneRef ( )
inlineoverridevirtual

Clone the data.

Implements Arcane::IData.

Definition at line 85 of file StringArrayData.cc.

References cloneTrue(), and Arcane::makeRef().

Here is the call graph for this function:

◆ cloneTrue()

DataInterfaceType * Arcane::StringArrayData::cloneTrue ( )
inlineoverridevirtual

Clone the data.

Implements Arcane::IArrayDataT< String >.

Definition at line 87 of file StringArrayData.cc.

Referenced by clone(), and cloneRef().

Here is the caller graph for this function:

◆ cloneTrueEmpty()

DataInterfaceType * Arcane::StringArrayData::cloneTrueEmpty ( )
inlineoverridevirtual

Clone the data but without elements.

Implements Arcane::IArrayDataT< String >.

Definition at line 88 of file StringArrayData.cc.

Referenced by cloneEmpty(), and cloneEmptyRef().

Here is the caller graph for this function:

◆ cloneTrueEmptyRef()

Ref< DataInterfaceType > Arcane::StringArrayData::cloneTrueEmptyRef ( )
inlineoverridevirtual

Clone the data but without elements.

Implements Arcane::IArrayDataT< String >.

Definition at line 94 of file StringArrayData.cc.

References Arcane::makeRef().

Here is the call graph for this function:

◆ cloneTrueRef()

Ref< DataInterfaceType > Arcane::StringArrayData::cloneTrueRef ( )
inlineoverridevirtual

Clone the data.

Implements Arcane::IArrayDataT< String >.

Definition at line 89 of file StringArrayData.cc.

References Arcane::makeRef().

Here is the call graph for this function:

◆ computeHash() [1/2]

void Arcane::StringArrayData::computeHash ( DataHashInfo & hash_info) const

Definition at line 386 of file StringArrayData.cc.

◆ computeHash() [2/2]

void Arcane::StringArrayData::computeHash ( IHashAlgorithm * algo,
ByteArray & output ) const
overridevirtual

Compute a hash key on this data.

The key is added to output. The length of the key depends on the algorithm used.

Implements Arcane::IData.

Definition at line 374 of file StringArrayData.cc.

References createSerializedDataRef().

Here is the call graph for this function:

◆ copy()

void Arcane::StringArrayData::copy ( const IData * data)
overridevirtual

Copy the data data into the current instance.

The data data must be of the same type as the instance.

Implements Arcane::IData.

Definition at line 398 of file StringArrayData.cc.

References ARCANE_THROW, and m_value.

◆ createSerializedDataRef()

Ref< ISerializedData > Arcane::StringArrayData::createSerializedDataRef ( bool use_basic_type) const
overridevirtual

Serialize the data.

For performance reasons, the returned instance may directly reference the memory area of this data. Consequently, it is only valid as long as this data is not modified. If you wish to modify this instance, you must first clone it (via IData::cloneRef()) and then serialize the cloned data.

If use_basic_type is true, the data is serialized for a basic type, namely DT_Byte, DT_Int16, DT_Int32, DT_Int64 or DT_Real. Otherwise, the type can be a POD, namely DT_Byte, DT_Int16, DT_Int32, DT_Int64, DT_Real, DT_Real2, DT_Real3, DT_Real2x2, DT_Real3x3.

Implements Arcane::IData.

Definition at line 238 of file StringArrayData.cc.

References Arcane::arcaneCreateSerializedDataRef(), Arcane::DT_Byte, m_value, and Arcane::SpanImpl< T, SizeType, Extent >::size().

Referenced by computeHash().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ dataType()

eDataType Arcane::StringArrayData::dataType ( ) const
inlineoverridevirtual

Data type.

Implements Arcane::IData.

Definition at line 75 of file StringArrayData.cc.

◆ dimension()

Integer Arcane::StringArrayData::dimension ( ) const
inlineoverridevirtual

Dimension. 0 for a scalar, 1 for a mono-dim array, 2 for a bi-dim array.

Implements Arcane::IData.

Definition at line 73 of file StringArrayData.cc.

◆ fillDefault()

void Arcane::StringArrayData::fillDefault ( )
inlineoverridevirtual

Fills the data with its default value.

Implements Arcane::IData.

Definition at line 100 of file StringArrayData.cc.

References m_value.

◆ multiTag()

Integer Arcane::StringArrayData::multiTag ( ) const
inlineoverridevirtual

Multi-tag. 0 if not multiple, 1 if multiple, 2 if multiple for MultiArray variables (obsolete).

Implements Arcane::IData.

Definition at line 74 of file StringArrayData.cc.

◆ resize()

void Arcane::StringArrayData::resize ( Integer new_size)
inlineoverridevirtual

Resize the data.

This operation only makes sense for data of dimension 1 or more. If the new number of elements is greater than the old one, the values added to the data are not initialized.

Implements Arcane::IData.

Definition at line 82 of file StringArrayData.cc.

References m_value.

◆ serialize() [1/2]

void Arcane::StringArrayData::serialize ( ISerializer * sbuf,
IDataOperation * operation )
overridevirtual

Serializes the data by applying the operation.

Implements Arcane::IData.

Definition at line 315 of file StringArrayData.cc.

References ARCANE_THROW, Arcane::ISerializer::get(), Arcane::ISerializer::getInteger(), m_value, Arcane::ISerializer::mode(), Arcane::ISerializer::ModeGet, Arcane::ISerializer::ModePut, Arcane::ISerializer::put(), Arcane::ISerializer::putInteger(), Arcane::ISerializer::ReadAdd, Arcane::ISerializer::readMode(), Arcane::ISerializer::ReadReplace, and Arcane::ISerializer::reserve().

Here is the call graph for this function:

◆ serialize() [2/2]

void Arcane::StringArrayData::serialize ( ISerializer * sbuf,
Int32ConstArrayView ids,
IDataOperation * operation )
overridevirtual

Serialize the data for the indices ids.

This operation only makes sense for data of dimension 1 or more.

Implements Arcane::IData.

Definition at line 353 of file StringArrayData.cc.

◆ setAllocationInfo()

void Arcane::StringArrayData::setAllocationInfo ( const DataAllocationInfo & v)
inlineoverridevirtual

Sets the allocation information.

Implements Arcane::IData.

Definition at line 111 of file StringArrayData.cc.

◆ setName()

void Arcane::StringArrayData::setName ( const String & name)
overridevirtual

Sets the name of the data (internal).

Implements Arcane::IData.

Definition at line 365 of file StringArrayData.cc.

◆ setShape()

void Arcane::StringArrayData::setShape ( const ArrayShape & new_shape)
inlineoverridevirtual

Sets the array shape.

Implements Arcane::IData.

Definition at line 110 of file StringArrayData.cc.

◆ shape()

ArrayShape Arcane::StringArrayData::shape ( ) const
inlineoverridevirtual

Array shape for a 1D or 2D data item.

The shape is only considered for dimensions greater than 1. For a 1D data item, the shape is therefore by default {1}. For a 2D array, the shape defaults to {dim2_size}. It is possible to change the rank of the shape and its values as long as shape().totalNbElement()==dim2_size. For example, if the number of values dim2_size is 12, then it is possible to have { 12 }, { 6, 2 } or { 3, 2, 2 } as the shape.

The values are not preserved during a restart, so the shape must be repositioned in this case. It is up to the user to ensure that the shape is homogeneous across sub-domains.

Implements Arcane::IData.

Definition at line 109 of file StringArrayData.cc.

◆ staticStorageTypeInfo()

DataStorageTypeInfo Arcane::StringArrayData::staticStorageTypeInfo ( )
static

Definition at line 216 of file StringArrayData.cc.

◆ storageTypeInfo()

DataStorageTypeInfo Arcane::StringArrayData::storageTypeInfo ( ) const
overridevirtual

Information about the data container type.

Implements Arcane::IData.

Definition at line 229 of file StringArrayData.cc.

◆ swapValues()

void Arcane::StringArrayData::swapValues ( IData * data)
overridevirtual

Swap the values of data with those of the instance.

The data IData must be of the same type as the instance. Only the values are swapped and other possible properties (such as the name, for example) are not modified.

Implements Arcane::IData.

Definition at line 410 of file StringArrayData.cc.

References ARCANE_THROW, and m_value.

◆ value() [1/2]

const Array< DataType > & Arcane::StringArrayData::value ( ) const
inlineoverridevirtual

Constant data value.

Implements Arcane::IArrayDataT< String >.

Definition at line 79 of file StringArrayData.cc.

References m_value.

◆ value() [2/2]

Array< DataType > & Arcane::StringArrayData::value ( )
inlineoverridevirtual

Data value.

Implements Arcane::IArrayDataT< String >.

Definition at line 78 of file StringArrayData.cc.

References m_value.

◆ view() [1/2]

ConstArrayView< DataType > Arcane::StringArrayData::view ( ) const
inlineoverridevirtual

Constant view on the data.

Implements Arcane::IArrayDataT< String >.

Definition at line 80 of file StringArrayData.cc.

References m_value.

◆ view() [2/2]

ArrayView< DataType > Arcane::StringArrayData::view ( )
inlineoverridevirtual

View on the data.

Implements Arcane::IArrayDataT< String >.

Definition at line 81 of file StringArrayData.cc.

References m_value.

◆ visit() [1/2]

void Arcane::StringArrayData::visit ( IArrayDataVisitor * visitor)
inlineoverridevirtual

Applies the visitor to the data.

Implements Arcane::IArrayData.

Definition at line 113 of file StringArrayData.cc.

◆ visit() [2/2]

void Arcane::StringArrayData::visit ( IDataVisitor * visitor)
inlineoverridevirtual

Applies the visitor to the data.

Implements Arcane::IArrayData.

Definition at line 117 of file StringArrayData.cc.

◆ visitArray()

void Arcane::StringArrayData::visitArray ( IArrayDataVisitor * visitor)
overridevirtual

Apply the visitor to the data.

If the data is not a 1D array, an exception NotSupportedException is thrown.

Implements Arcane::IData.

Definition at line 431 of file StringArrayData.cc.

◆ visitArray2()

void Arcane::StringArrayData::visitArray2 ( IArray2DataVisitor * visitor)
overridevirtual

Apply the visitor to the data.

If the data is not a 2D array, an exception NotSupportedException is thrown.

Implements Arcane::IData.

Definition at line 440 of file StringArrayData.cc.

References ARCANE_THROW.

◆ visitScalar()

void Arcane::StringArrayData::visitScalar ( IScalarDataVisitor * visitor)
overridevirtual

Apply the visitor to the data.

If the data is not scalar, a NotSupportedException is thrown.

Implements Arcane::IData.

Definition at line 422 of file StringArrayData.cc.

References ARCANE_THROW.

◆ Impl

friend class Impl
friend

Definition at line 56 of file StringArrayData.cc.

Member Data Documentation

◆ m_allocation_info

DataAllocationInfo Arcane::StringArrayData::m_allocation_info
private

Definition at line 139 of file StringArrayData.cc.

◆ m_internal

IArrayDataInternalT<String>* Arcane::StringArrayData::m_internal
private

Definition at line 138 of file StringArrayData.cc.

◆ m_trace

ITraceMng* Arcane::StringArrayData::m_trace
private

Definition at line 137 of file StringArrayData.cc.

◆ m_value

UniqueArray<DataType> Arcane::StringArrayData::m_value
private

Data.

Definition at line 136 of file StringArrayData.cc.

Referenced by assignSerializedData(), copy(), createSerializedDataRef(), fillDefault(), resize(), serialize(), swapValues(), value(), value(), view(), and view().

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