Skip to main content

DPF C++ client library 2023 R2

ansys::dpf::Location Struct Reference

Last update: 10.07.2023

User defined location quantity. More...

#include <dpf_api_base.h>

Public Member Functions

 Location (std::string const &name="")
 
 Location (Location const &)=default
 
bool operator== (Location const &) const
 
bool operator< (Location const &) const
 
bool operator<= (Location const &) const
 
bool operator!= (Location const &) const
 
 operator std::string () const
 
bool empty () const
 
const char * c_str () const
 

Detailed Description

User defined location quantity.

The location is the type of topology associated with the data container. This allows for the definition of a new location quantity. Many location quantities are predefined.

See also
locations
Examples
DataApis.cpp.

Constructor & Destructor Documentation

◆ Location()

ansys::dpf::Location::Location ( std::string const &  name = "")
explicit

Create new location.

Parameters
[in]nameOptional name of location.

Member Function Documentation

◆ c_str()

const char * ansys::dpf::Location::c_str ( ) const

Gets name of location.

Returns
Name of location.
Examples
AveragingTest.cpp, and ModelTest.cpp.

◆ operator std::string()

ansys::dpf::Location::operator std::string ( ) const

Name of location.