From GridLAB-D Wiki
(Redirected from KEYWORD)
Jump to: navigation, search

gld_keyword - C++ Module API for keywords Template:NEW30

Synopsis

class gld_keyword {

private: // data
	KEYWORD core;

public: // constructors/casts
	operator KEYWORD* (void);

public: // read accessors
	char* get_name(void);
	unsigned int64 get_value(void);

public: // iterators
	bool is_last(void);
	gld_keyword* get_next(void);
};

Description

The gld_keyword class encapsulates the KEYWORD data associated with enumeration and set properties.

get_name

char* get_name(void)
This function is used to get the name of the keyword.

get_next

gld_keyword* get_next(void)
This function is used to get the next keyword.

get_value

unsigned int64 get_value(void)
This function is used to get the value of the keyword.

is_last

bool is_last(void)
This function is used to determine whether the keyword is that last one in the list of keyword.

KEYWORD

(KEYWORD*)
This cast is used to obtain a pointer to the underlying core data structure for the property keyword.

Version

The C++ Module API was introduced in Hassayampa (Version 3.0) to support multithreaded modules.

See also