axom::sidre::Attribute Class Reference

An Attribute holds scalar metadata describing a View. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/sidre/core/Attribute.hpp>

Public Member Functions
const std::string &	getName () const
	Return const reference to name of Attribute object. More...
IndexType	getIndex () const
	Return the unique index of this Attribute object. More...
template<typename ScalarType >
bool	setDefaultScalar (ScalarType value)
	Set default value of Attribute. Return true if successfully changed. More...
bool	setDefaultString (const std::string &value)
	Set default value of Attribute. Return true if successfully changed. More...
bool	setDefaultNodeRef (Node &node)
	Set default value of Attribute to a Node. More...
const Node &	getDefaultNodeRef () const
	Return default value of Attribute. More...
TypeID	getTypeID () const
	Return type of Attribute. More...

Friends
class	DataStore

Detailed Description

An Attribute holds scalar metadata describing a View.

Member Function Documentation

getName()

const std::string& axom::sidre::Attribute::getName ( ) const

inline

Return const reference to name of Attribute object.

getIndex()

IndexType axom::sidre::Attribute::getIndex ( ) const

inline

Return the unique index of this Attribute object.

setDefaultScalar()

template<typename ScalarType >

bool axom::sidre::Attribute::setDefaultScalar ( ScalarType  value )

inline

Set default value of Attribute. Return true if successfully changed.

The type of the default cannot be changed after the attribute is created.

References SLIC_CHECK_MSG.

setDefaultString()

bool axom::sidre::Attribute::setDefaultString ( const std::string &  value )

inline

Set default value of Attribute. Return true if successfully changed.

The type of the default cannot be changed after the attribute is created.

References axom::sidre::CHAR8_STR_ID, and SLIC_CHECK_MSG.

setDefaultNodeRef()

bool axom::sidre::Attribute::setDefaultNodeRef ( Node &  node )

inline

Set default value of Attribute to a Node.

getDefaultNodeRef()

const Node& axom::sidre::Attribute::getDefaultNodeRef ( ) const

inline

Return default value of Attribute.

getTypeID()

TypeID axom::sidre::Attribute::getTypeID ( ) const

inline

Return type of Attribute.

Friends And Related Function Documentation

DataStore

friend class DataStore

friend

Friend declarations to constrain usage via controlled access to private members.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/sidre/core/Attribute.hpp