Attributes

Back to Helios Network Native C API

Attribute definition, lookup, categorization, and multi-category APIs.

function CXAttributeData Returns a pointer to the raw backing buffer for an attribute (or NULL when missing). function CXAttributeInterpolateFloatBuffer Interpolates a float attribute buffer toward target values and bumps the attribute version. Returns CXTrue when further interpolation steps are recommended based on minDisplacementRatio. function CXAttributeStride Returns the byte stride between consecutive entries of an attribute. function CXAttributeVersion Returns the version counter for an attribute descriptor. function CXNetworkBumpEdgeAttributeVersion Manually bumps an edge attribute version and returns the new value. function CXNetworkBumpNetworkAttributeVersion Manually bumps a network attribute version and returns the new value. function CXNetworkBumpNodeAttributeVersion Manually bumps a node attribute version and returns the new value. function CXNetworkCategorizeAttribute Converts a string attribute into category ids using the requested sort policy. function CXNetworkClearMultiCategoryEntry Clears all category ids and weights for one multi-category entry. function CXNetworkCopyNodeAttributesToEdgeAttributes Copies node attributes into an edge attribute buffer using the network's topology. `endpointMode` controls which endpoint is copied: -1 = both, 0 = source only, 1 = destination only. When copying a single endpoint and `duplicateSingleEndpoint` is true, the chosen endpoint is written twice sequentially (for double-width edge attributes). function CXNetworkDecategorizeAttribute Converts category ids back to string labels for the named attribute. function CXNetworkDefineEdgeAttribute Declares an edge attribute backing buffer. function CXNetworkDefineMultiCategoryAttribute Defines a multi-category attribute with optional per-entry weights. function CXNetworkDefineNetworkAttribute Declares a network-level attribute backing buffer. function CXNetworkDefineNodeAttribute Declares a node attribute backing buffer. Dimension defaults to 1. function CXNetworkEdgeAttributeCount Returns the number of edge attributes currently defined on the network. function CXNetworkEdgeAttributeNameAt Returns the edge attribute name at `index`, or NULL when out of range. function CXNetworkGetAttributeCategoryDictionary Returns the category dictionary for a categorical attribute, or NULL when unavailable. function CXNetworkGetAttributeCategoryDictionaryCount Returns how many category entries are defined for a categorical attribute. function CXNetworkGetAttributeCategoryDictionaryEntries Copies category ids and labels into caller-provided arrays. function CXNetworkGetEdgeAttribute Fetches an edge attribute descriptor by name. function CXNetworkGetEdgeAttributeBuffer Returns a pointer to the raw edge attribute buffer for the named attribute. function CXNetworkGetMultiCategoryEntryCount Returns the number of category entries stored for a multi-category attribute. function CXNetworkGetMultiCategoryEntryRange Returns the [start,end) range for one entry inside the packed multi-category buffers. function CXNetworkGetMultiCategoryIds Returns the packed category id buffer for a multi-category attribute. function CXNetworkGetMultiCategoryOffsetCount Returns the number of offsets stored for a multi-category attribute. function CXNetworkGetMultiCategoryOffsets Returns the packed offsets buffer for a multi-category attribute. function CXNetworkGetMultiCategoryWeights Returns the packed weight buffer, or NULL when the attribute is unweighted. function CXNetworkGetNetworkAttribute Fetches a network attribute descriptor by name. function CXNetworkGetNetworkAttributeBuffer Returns a pointer to the raw network attribute buffer for the named attribute. function CXNetworkGetNodeAttribute Fetches a node attribute descriptor by name. function CXNetworkGetNodeAttributeBuffer Returns a pointer to the raw node attribute buffer for the named attribute. function CXNetworkMultiCategoryHasWeights Returns CXTrue when the multi-category attribute stores per-entry weights. function CXNetworkNetworkAttributeCount Returns the number of network attributes currently defined on the network. function CXNetworkNetworkAttributeNameAt Returns the network attribute name at `index`, or NULL when out of range. function CXNetworkNodeAttributeCount Returns the number of node attributes currently defined on the network. function CXNetworkNodeAttributeNameAt Returns the node attribute name at `index` in the internal dictionary iteration order, or NULL when out of range. function CXNetworkRemoveEdgeAttribute Removes a sparse edge attribute and its storage. function CXNetworkRemoveNetworkAttribute Removes a sparse network attribute and its storage. function CXNetworkRemoveNodeAttribute Removes a sparse node attribute and its storage. function CXNetworkSetAttributeCategoryDictionary Replaces or remaps the category dictionary for a categorical attribute. function CXNetworkSetMultiCategoryBuffers Replaces the packed offset/id/weight buffers for a multi-category attribute. function CXNetworkSetMultiCategoryEntry Writes one entry of a multi-category attribute using category ids. function CXNetworkSetMultiCategoryEntryByLabels Writes one entry of a multi-category attribute using category labels.