Specialization of Values for strings. More...
#include <openvdb_ax/ast/AST.h>
Public Types | |
using | UniquePtr = std::unique_ptr<Value<std::string>> |
using | Type = std::string |
using | UniquePtr |
using | Type |
using | ContainerType |
Integers and Floats store their value as ContainerType, which is guaranteed to be at least large enough to represent the maximum possible supported type for the requested precision. | |
enum | NodeType |
An enumerated list of node types for all concrete node types. These can be used for faster evaluation of a given concrete node using the virtual function table via Node::nodetype() rather than performing a dynamic_cast/calling Node::isType. More... | |
using | Ptr |
Public Member Functions | |
Value (const Type &value) | |
Construct a new Value string from a string. | |
Value (const Value< Type > &other) | |
Deep copy constructor for a Value string. | |
~Value () override=default | |
Value< Type > * | copy () const override final |
The deep copy method for a Node. | |
NodeType | nodetype () const override |
Virtual method for accessing node type information. | |
const char * | nodename () const override |
Virtual method for accessing node name information. | |
const char * | subname () const override |
Virtual method for accessing node name information. | |
const ValueBase * | basetype () const override |
Virtual method for accessing a node's base class. Note that if this is called explicitly on an instance of ast::Node (the top most base class) a nullptr is returned. This is primarily used by the Visitor to support hierarchical visits. | |
const std::string & | value () const |
Access the string. | |
Value (const ContainerType value) | |
Directly construct a Value from a source integer, float or boolean, guaranteeing valid construction. Note that the provided argument should not be negative. | |
Value (const Value< std::string > &other) | |
Deep copy constructor for a Value. | |
~Value () override=default | |
Value< Type > * | copy () const override final |
The deep copy method for a Node. | |
NodeType | nodetype () const override |
Virtual method for accessing node type information. | |
const char * | nodename () const override |
Virtual method for accessing node name information. | |
const char * | subname () const override |
Virtual method for accessing node name information. | |
const ValueBase * | basetype () const override |
Virtual method for accessing a node's base class. Note that if this is called explicitly on an instance of ast::Node (the top most base class) a nullptr is returned. This is primarily used by the Visitor to support hierarchical visits. | |
ContainerType | asContainerType () const |
Access the value as its stored type. | |
std::string | value () const |
Access the value as its requested (templated) type. | |
size_t | children () const override |
Virtual method for accessing child information. Returns the number of children a given AST node owns. | |
const Node * | child (const size_t) const override |
Virtual method for accessing child information. Returns a const pointer to a child node at the given index. If the index is out of range, a nullptr is returned. | |
Name/Type | |
bool | isType () const |
Query whether or not this node is of a specific (derived) type. This method should be used to check if a node is of a particular abstract type. When checking concrete types, it's generally more efficient to check the return value of Node::nodetype() | |
Child Queries | |
int64_t | childidx () const |
Returns the child index of this node in relation to its parent, or -1 if no valid index is found (usually representing the top most node (i.e. Tree) | |
Replacement | |
bool | replace (Node *node) |
In place replacement. Attempts to replace this node at its specific location within its Abstract Syntax Tree. On a successful replacement, this node is destroyed, the provided node is inserted in its place and ownership is transferred to the parent node. No further calls to this node can be made on successful replacements. | |
virtual bool | replacechild (const size_t index, Node *node) |
Virtual method that attempted to replace a child at a given index with a provided node type. | |
Parent | |
const Node * | parent () const |
Access a const pointer to this nodes parent. | |
void | setParent (Node *parent) |
Set this node's parent. This is used during construction of an AST and should not be used. | |
Static Public Attributes | |
static constexpr bool | IsSupported |
The list of supported numerical constants. | |
Specialization of Values for strings.
using ContainerType |
Integers and Floats store their value as ContainerType, which is guaranteed to be at least large enough to represent the maximum possible supported type for the requested precision.
using Ptr |
using Type |
using Type = std::string |
using UniquePtr |
enum NodeType |
An enumerated list of node types for all concrete node types. These can be used for faster evaluation of a given concrete node using the virtual function table via Node::nodetype() rather than performing a dynamic_cast/calling Node::isType.
|
overridedefault |
|
inline |
Directly construct a Value from a source integer, float or boolean, guaranteeing valid construction. Note that the provided argument should not be negative.
|
overridedefault |
|
inline |
Access the value as its stored type.
|
inlineoverridevirtual |
Virtual method for accessing a node's base class. Note that if this is called explicitly on an instance of ast::Node (the top most base class) a nullptr is returned. This is primarily used by the Visitor to support hierarchical visits.
Reimplemented from Expression.
|
inlineoverridevirtual |
Virtual method for accessing a node's base class. Note that if this is called explicitly on an instance of ast::Node (the top most base class) a nullptr is returned. This is primarily used by the Visitor to support hierarchical visits.
Reimplemented from Expression.
|
inlineoverride |
Virtual method for accessing child information. Returns a const pointer to a child node at the given index. If the index is out of range, a nullptr is returned.
index | The child index to query |
|
inline |
Returns the child index of this node in relation to its parent, or -1 if no valid index is found (usually representing the top most node (i.e. Tree)
|
inlineoverride |
Virtual method for accessing child information. Returns the number of children a given AST node owns.
|
inline |
Query whether or not this node is of a specific (derived) type. This method should be used to check if a node is of a particular abstract type. When checking concrete types, it's generally more efficient to check the return value of Node::nodetype()
NodeT | The node type to query against. |
|
inlineoverridevirtual |
Virtual method for accessing node name information.
Implements Node.
|
inlineoverridevirtual |
Virtual method for accessing node name information.
Implements Node.
|
inlineoverridevirtual |
Virtual method for accessing node type information.
Implements Node.
|
inlineoverridevirtual |
|
inline |
Access a const pointer to this nodes parent.
|
inline |
In place replacement. Attempts to replace this node at its specific location within its Abstract Syntax Tree. On a successful replacement, this node is destroyed, the provided node is inserted in its place and ownership is transferred to the parent node. No further calls to this node can be made on successful replacements.
node | The node to insert on a successful replacement. |
|
inlinevirtual |
Virtual method that attempted to replace a child at a given index with a provided node type.
index | The child index where a replacement should be attempted |
node | The node to insert on a successful replacement. |
|
inline |
Set this node's parent. This is used during construction of an AST and should not be used.
parent | The parent to set |
|
inlineoverridevirtual |
Virtual method for accessing node name information.
Implements Node.
|
inlineoverridevirtual |
Virtual method for accessing node name information.
Implements Node.
|
inline |
Access the value as its requested (templated) type.
|
inline |
Access the string.
|
staticconstexpr |
The list of supported numerical constants.