AftWrite Class Reference

Metadata field write class. More...

#include <AftNode.h>

Inheritance diagram for AftWrite:

Public Types
enum	OpEnum { AftWriteOpSet = 0, AftWriteOpOr, AftWriteOpAnd, AftWriteOpXor }
	AftWrite operand enum. Used to indicate the comparison to perform in AftWrite. More...
typedef std::shared_ptr< AftWrite >	Ptr
	Pointer type for writes.

Public Member Functions
	AftWrite (const AftKey newWriteKey, const AftWrite::OpEnum newWriteOp)
	Construct an metadata write node. More...
const AftKey &	writeKey () const
const AftWrite::OpEnum	writeOp () const
virtual const bool	nodeIsValid (const AftValidatorPtr &validator, std::ostream &os)
	@ returns true if node is valid
virtual const std::string	nodeType () const
virtual std::ostream &	description (std::ostream &os) const
	Append a description of the node to an output stream. More...
Public Member Functions inherited from AftNode
	AftNode (const AftNode &node)
	Copy constructor for a basic node. More...
	AftNode (const AftNodeToken newToken=AFT_NODE_TOKEN_NONE, const AftNodeToken newNext=AFT_NODE_TOKEN_NONE, const std::string newName="")
	Construct an entry for a basic node. More...
	operator const AftNodeToken () const
const AftNodeToken	nodeToken () const
const std::string	nodeName () const
const AftTypeIndex	nodeTypeIndex () const
void	setNodeNext (AftNodeToken newNext)
	Set the (optional) next node. More...
const AftNodeToken	nodeNext () const
void	setNodeParameters (const AftParameters::Ptr &newParams)
	Set the optional parameters of the node. More...
const AftParameters::Ptr	nodeParameters () const
template<class T >
std::shared_ptr< T >	nodeParameter (const std::string &name)
	Convenience parameter access template. Use this to access node parameters. More...
void	setNodeParameter (const std::string &name, const AftDataPtr &data)
	Convenience parameter setter. Use this to set node parameters. More...
virtual const bool	nodeIsContainer () const
	@ returns true if node can take entries
virtual const bool	nodeIsDelete () const
	@ returns true if node is a delete
virtual void	nextNodes (AftTokenVector &nextTokens)

Static Public Member Functions
static AftWrite::Ptr	create (const AftKey newWriteKey, const AftWrite::OpEnum newWriteOp=AftWriteOpSet)
	Factory generate an metadata write node. More...
Static Public Member Functions inherited from AftNode
template<class T >
static std::shared_ptr< T >	downcast (const AftNodePtr &node)
	Convenience downcast template. Use this instead of manual casting if required. More...

Protected Attributes
AftKey	_writeKey
	AftKey object describing the metadata field to write.
AftWrite::OpEnum	_writeOp
	Operation to perform on write.
Protected Attributes inherited from AftNode
friend	AftInsert
	AftInsert accesses the setNodeName and setNodeToken methods.
friend	AftSandbox
	AftSandbox accesses the setNodeName and setNodeToken methods.
friend	AfiNodeRpc
	AfiNodeRpc accesses the setNodeName and setNodeToken methods.
AftNodeToken	_nodeToken
	Unique token value for node.
AftNodeToken	_nodeNext
	Optional value of next node.
std::string	_nodeName
	Optional name of node.
AftParameters::Ptr	_nodeParams
	Optional node parameters.
AftTypeIndex	_nodeTypeIndex
	Scalar index type for node.

Additional Inherited Members
Protected Member Functions inherited from AftNode
void	setNodeName (std::string newName)
	Set the name of the node. More...
void	setNodeToken (AftNodeToken newToken)
	Set the token value of the node. More...
void	setNodeTypeIndex (AftTypeIndex newTypeIndex)
	Set the sandbox node type index. More...

Detailed Description

Metadata field write class.

Constructor & Destructor Documentation

AftWrite::AftWrite ( const AftKey  newWriteKey, const AftWrite::OpEnum  newWriteOp  )

inline

Construct an metadata write node.

Parameters

[in]

newWriteKey

Vector of metadata key to write to

Member Function Documentation

static AftWrite::Ptr AftWrite::create ( const AftKey  newWriteKey, const AftWrite::OpEnum  newWriteOp = AftWriteOpSet  )

inlinestatic

Factory generate an metadata write node.

Parameters

[in]	newWriteKey	Metadata key to write to
[in]	newWriteOp	Operation to perform during write

virtual std::ostream& AftWrite::description ( std::ostream &  os ) const

inlinevirtual

Append a description of the node to an output stream.

Parameters

[in]

os

Reference to output stream to append description to

Returns

Reference to output stream with text description of node appended

Reimplemented from AftNode.

virtual const std::string AftWrite::nodeType ( ) const

inlinevirtual

Returns

Printable class type of node

Reimplemented from AftNode.

const AftKey& AftWrite::writeKey ( ) const

inline

Returns

Reference the metadata key to write

const AftWrite::OpEnum AftWrite::writeOp ( ) const

inline

Returns

Write operation

---

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

• AftNode.h