Sparksee 6.1.0
Attribute Class Reference

Attribute data class. More...

#include <Graph_data.h>

Public Member Functions

 ~Attribute ()
 Destructor.
attr_t GetId () const
 Gets the Sparksee attribute identifier.
type_t GetTypeId () const
 Gets the Sparksee type identifier.
const std::wstring & GetName () const
 Gets the unique attribute name.
DataType GetDataType () const
 Gets the data type.
int64_t GetSize () const
 Gets the number of different values.
int64_t GetCount () const
 Gets the number of non-NULL values.
AttributeKind GetKind () const
 Gets the attribute kind.
bool_t IsSessionAttribute () const
 Check if it's a session attribute or a persistent one.
ValueGetDefaultValue () const
 Gets the default value for this attribute.
bool_t IsArrayAttribute () const
 Check if it's an array attribute.
int32_t GetArraySize () const
 Gets the number of elements in the array.

Static Public Attributes

static const attr_t InvalidAttribute
 Invalid attribute identifier constant.

Friends

class Graph

Detailed Description

Attribute data class.

It contains information about an attribute.

Author
Sparsity Technologies http://www.sparsity-technologies.com

Member Function Documentation

◆ GetArraySize()

int32_t Attribute::GetArraySize ( ) const
inline

Gets the number of elements in the array.

Returns
The size of the array

◆ GetCount()

int64_t Attribute::GetCount ( ) const
inline

Gets the number of non-NULL values.

Returns
The number of non-NULL values.

◆ GetDataType()

DataType Attribute::GetDataType ( ) const
inline

Gets the data type.

Returns
The DataType.

◆ GetDefaultValue()

Value * Attribute::GetDefaultValue ( ) const
inline

Gets the default value for this attribute.

Returns
A new Value instance with the default value, or NULL if none is set.

◆ GetId()

attr_t Attribute::GetId ( ) const
inline

Gets the Sparksee attribute identifier.

Returns
The Sparksee attribute identifier.

◆ GetKind()

AttributeKind Attribute::GetKind ( ) const
inline

Gets the attribute kind.

Returns
The AttributeKind.

◆ GetName()

const std::wstring & Attribute::GetName ( ) const
inline

Gets the unique attribute name.

Returns
The unique attribute name.

◆ GetSize()

int64_t Attribute::GetSize ( ) const
inline

Gets the number of different values.

Returns
The number of different values.

◆ GetTypeId()

type_t Attribute::GetTypeId ( ) const
inline

Gets the Sparksee type identifier.

Returns
The Sparksee type identifier.

◆ IsArrayAttribute()

bool_t Attribute::IsArrayAttribute ( ) const
inline

Check if it's an array attribute.

Returns
True if it's an array attribute, or false otherwise.

◆ IsSessionAttribute()

bool_t Attribute::IsSessionAttribute ( ) const
inline

Check if it's a session attribute or a persistent one.

Returns
True if it's a session attribute, or false otherwise.

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