Class ansys::dpf::LabelSpace
Last update: 25.03.2026
Defines an indexation for fields container.
Inherits from:
Members
- add
- addAnyDomain
- addAnyTime
- at
- callAPI
- deep_copy
- describe
- empty
- emptyLabelSpace
- erase
- getClient
- has
- hasBeenMovedLocally
- hasInternalObject
- isOnCommonAPI
- isSameObject
- labelsName
- LabelSpace
- LabelSpace
- LabelSpace
- LabelSpace
- LabelSpace
- LabelSpace
- LabelSpace
- LabelSpace
- mergeWith
- operator=
- operator=
- set
- setComplex
- setDomain
- setTime
- size
- ~DpfTypes
- ~LabelSpace
Friends
Public functions
Function LabelSpace
ansys::dpf::LabelSpace::LabelSpace()
Return type:
Function LabelSpace
ansys::dpf::LabelSpace::LabelSpace(Client const *const client)
Create a new LabelSpace for a given client.
Parameters:
Return type:
Function LabelSpace
ansys::dpf::LabelSpace::LabelSpace(std::map< Label, dp_int > const &rhs, Client const *const client)
Consturct new LabelSpace from labels and values.
Parameters:
- std::map< Label, dp_int > const & rhs: [in] labels and values with which to construct space.
- Client const *const client: [in] Client instance designating the IP, port and protocol to use.
Return type:
Function LabelSpace
ansys::dpf::LabelSpace::LabelSpace(std::initializer_list< std::pair< const Label, int > > init, Client const *const client)
Construct new LabelSpace from pairs of labels and values.
Parameters:
- std::initializer_list< std::pair< const Label, int > > init: [in] List of label/value pairs.
- Client const *const client: [in] Client instance designating the IP, port and protocol to use.
Return type:
Function LabelSpace
ansys::dpf::LabelSpace::LabelSpace(std::map< Label, dp_int > const &rhs)
Consturct new LabelSpace from labels and values.
Parameters:
Return type:
Function LabelSpace
ansys::dpf::LabelSpace::LabelSpace(std::initializer_list< std::pair< const Label, int > > init)
Construct new LabelSpace from pairs of labels and values.
Parameters:
- std::initializer_list< std::pair< const Label, int > > init: [in] List of label/value pairs.
Return type:
Function ~LabelSpace
virtual ansys::dpf::LabelSpace::~LabelSpace()
Return type:
Function LabelSpace
ansys::dpf::LabelSpace::LabelSpace(LabelSpace const &)
Parameters:
- LabelSpace const &
Return type:
Function LabelSpace
ansys::dpf::LabelSpace::LabelSpace(LabelSpace &&) noexcept
Parameters:
- LabelSpace &&
Return type:
Function operator=
LabelSpace & ansys::dpf::LabelSpace::operator=(LabelSpace const &)
Parameters:
- LabelSpace const &
Return type: LabelSpace &
Function operator=
LabelSpace & ansys::dpf::LabelSpace::operator=(LabelSpace &&) noexcept
Parameters:
- LabelSpace &&
Return type: LabelSpace &
Function add
void ansys::dpf::LabelSpace::add(Label const &label, dp_int value)
Add a label with value. If label already exists, nothing happens.
Parameters:
- Label const & label: [in] Label to add to LabelSpace.
- dp_int value: [in] Value of label.
Return type: void
Function set
void ansys::dpf::LabelSpace::set(Label const &label, dp_int value)
Set an already existing label to value. If label does not exist it is added.
Parameters:
Return type: void
Function erase
void ansys::dpf::LabelSpace::erase(Label const &label)
Removes label from space.
Parameters:
Return type: void
Function size
dp_int ansys::dpf::LabelSpace::size() const
Returns:
Number of labels in space.
Return type: dp_int
Function has
bool ansys::dpf::LabelSpace::has(Label const &label) const
Returns:
Indication that label exists within space.
Parameters:
Return type: bool
Function at
dp_int ansys::dpf::LabelSpace::at(Label const &label) const
Returns:
Value of label within space.
Parameters:
Return type: dp_int
Function labelsName
std::string ansys::dpf::LabelSpace::labelsName(dp_index index) const
Returns:
name of label at given index.
Parameters:
- dp_index index: [in] Index of the wanted label.
Return type: std::string
Function setTime
LabelSpace & ansys::dpf::LabelSpace::setTime(dp_index i)
Set time label to value. Returns:
Reference to labelspace.
See also: labels
Parameters:
- dp_index i: [in] New value for time label.
Return type: LabelSpace &
Function setDomain
LabelSpace & ansys::dpf::LabelSpace::setDomain(dp_index i)
Set domain label to value Returns:
Reference to labelspace.
See also: labels
Parameters:
- dp_index i: [in] New value for domain label.
Return type: LabelSpace &
Function setComplex
LabelSpace & ansys::dpf::LabelSpace::setComplex(dp_index i)
Set complex label to value. Returns:
Reference to labelspace.
See also: labels
Parameters:
- dp_index i: [in] New value for complex label.
Return type: LabelSpace &
Function addAnyTime
LabelSpace & ansys::dpf::LabelSpace::addAnyTime()
Set time label to -1. Returns:
Reference to labelspace.
See also: labels
Return type: LabelSpace &
Function addAnyDomain
LabelSpace & ansys::dpf::LabelSpace::addAnyDomain()
Set domain label to -1. Returns:
Reference to labelspace.
See also: labels
Return type: LabelSpace &
Function deep_copy
LabelSpace ansys::dpf::LabelSpace::deep_copy(ansys::dpf::Client const *const client=nullptr) const
Create a new LabelSpace on a server by copying all the data of this LabelSpace.
Parameters:
- ansys::dpf::Client const *const client = nullptr : [in] Client instance designating the IP, port and protocol to use.
Return type: LabelSpace
Function mergeWith
void ansys::dpf::LabelSpace::mergeWith(ansys::dpf::LabelSpace const other)
Inserts all labels and ids of other in this.
Parameters:
- ansys::dpf::LabelSpace const other
Return type: void
Public static functions
Function emptyLabelSpace
static LabelSpace ansys::dpf::LabelSpace::emptyLabelSpace()
Create an empty LabelSpace Returns:
Empty LabelSpace
Return type: LabelSpace