Skip to main content

DPF Cpp Client Library 2026 R1

Class ansys::dpf::CollectionBase

Last update: 25.03.2026

Inherits from:

Inherited by:

Members

Friends

Friend internal::set_prop

Public functions

Function ~CollectionBase

virtual ansys::dpf::CollectionBase::~CollectionBase()=default

Return type:

Function size

dp_int ansys::dpf::CollectionBase::size() const

Get Number of entries in container. Returns:

Number of entries.

Return type: dp_int

Function reserve

void ansys::dpf::CollectionBase::reserve(dp_int size)

Reserve space for entries

Parameters:

  • dp_int size: [in] Number of entries for which to reserve space.

Return type: void

Function resize

void ansys::dpf::CollectionBase::resize(dp_int size)

Resize container to given size.

Parameters:

  • dp_int size: [in] Set container to number of entries.

Return type: void

Function addLabel

void ansys::dpf::CollectionBase::addLabel(std::string const &label)

Add new label to field.

Parameters:

  • std::string const & label: [in] New label.

Return type: void

Function addLabel

void ansys::dpf::CollectionBase::addLabel(std::string const &label, dp_id default_value)

Add new label with value.

Parameters:

  • std::string const & label: [in] New label.
  • dp_id default_value: [in] Value of label.

Return type: void

Function addLabels

void ansys::dpf::CollectionBase::addLabels(std::vector< std::string > const &labels)

Add vector of labels to field.

Parameters:

  • std::vector< std::string > const & labels: [in] Vector of labels to add.

Return type: void

Function getSizeFor

dp_int ansys::dpf::CollectionBase::getSizeFor(LabelSpace const &lab_space) const

Returns:

Number of entries for given LabelSpace.

Parameters:

Return type: dp_int

Function labels

std::vector< std::string > ansys::dpf::CollectionBase::labels() const

Returns:

Vector of labels of entries container.

Return type: std::vector< std::string >

Function getLabelSpace

LabelSpace ansys::dpf::CollectionBase::getLabelSpace(dp_index index) const

Returns:

LabelSpace for given field index.

Parameters:

Return type: LabelSpace

Function labelScoping

Scoping ansys::dpf::CollectionBase::labelScoping(std::string const &label) const

Returns:

Scoping for field given by label.

Parameters:

  • std::string const & label: [in] Field for which to get scoping.

Return type: Scoping

Function hasLabel

bool ansys::dpf::CollectionBase::hasLabel(std::string const &label) const

Returns:

Indication that CollectionBase has field given by label.

Parameters:

  • std::string const & label: [in] Field label.

Return type: bool

Function support

Support ansys::dpf::CollectionBase::support(std::string const &label=labels::time) const

Returns:

Support for given label.

Parameters:

Return type: Support

Function setSupport

void ansys::dpf::CollectionBase::setSupport(ansys::dpf::Support const &support, std::string const &label=labels::time)

Set Support for given label.

Parameters:

Return type: void

Function setSupport

void ansys::dpf::CollectionBase::setSupport(ansys::dpf::TimeFreqSupport const &support, std::string const &label=labels::time)

Set TimeFreqSupport for given label.

Parameters:

Return type: void

Function name

std::string ansys::dpf::CollectionBase::name() const

Returns:

Name of CollectionBase.

Return type: std::string

Function setName

void ansys::dpf::CollectionBase::setName(std::string const &name)

Set name of CollectionBase.

Parameters:

  • std::string const & name: [in] New name.

Return type: void

Function id

dp_id ansys::dpf::CollectionBase::id() const

Returns:

Id of CollectionBase.

Return type: dp_id

Function setId

void ansys::dpf::CollectionBase::setId(dp_id id)

Set Id of CollectionBase.

Parameters:

Return type: void

Connect with Ansys