Samchon Framework for CPP  1.0.0
samchon::namtree::INTExplore Class Reference

An interface for exploration. More...

#include <INTExplore.hpp>

Collaboration diagram for samchon::namtree::INTExplore:

Public Member Functions

 INTExplore ()
 Default Constructor. More...
 
virtual void construct (std::shared_ptr< library::XML >)
 Construct data of the Entity from an XML object. More...
 
auto getMinimum () const -> double
 Get minimum. More...
 
auto getMaximum () const -> double
 Get maximum. More...
 
auto getSection () const -> unsigned int
 Get section. More...
 
auto getPrecision () const -> int
 Get precision. More...
 
virtual auto toXML () const -> std::shared_ptr< library::XML >
 Get an XML object represents the Entity. More...
 
- Public Member Functions inherited from samchon::protocol::Entity
virtual auto TAG () const -> std::string=0
 A tag name when represented by XML. More...
 
 Entity ()
 Default Constructor. More...
 
virtual auto key () const -> std::string
 Get a key that can identify the Entity uniquely. More...
 

Protected Attributes

double minimum
 Minimum value. More...
 
double maximum
 Maximum value. More...
 
unsigned int section
 Section number of exploration. More...
 
int precision
 Target precision: 10precision More...
 

Detailed Description

An interface for exploration.

namtree_i_nt_explore.png

INTExplore is an interface containing some parameters for grid optimization method.

namtree_file.png
See also
samchon::namtree
Author
Jeongho Nam http://samchon.org

Definition at line 25 of file INTExplore.hpp.

Constructor & Destructor Documentation

INTExplore::INTExplore ( )

Default Constructor.

Definition at line 12 of file INTExplore.cpp.

References maximum, minimum, precision, and section.

Member Function Documentation

void INTExplore::construct ( std::shared_ptr< library::XML )
virtual

Construct data of the Entity from an XML object.

Overrides the construct() method and fetch data of member variables from the XML.

By recommended guidance, data representing member variables are contained in properties of the put XML object.

Parameters
xmlAn xml used to construct data of entity

Implements samchon::protocol::Entity.

Reimplemented in samchon::namtree::NTFile, and samchon::namtree::NTParameter.

Definition at line 20 of file INTExplore.cpp.

References maximum, minimum, precision, and section.

Referenced by samchon::namtree::NTParameter::construct().

Here is the caller graph for this function:

auto INTExplore::getMinimum ( ) const -> double

Get minimum.

Definition at line 37 of file INTExplore.cpp.

References minimum.

auto INTExplore::getMaximum ( ) const -> double

Get maximum.

Definition at line 41 of file INTExplore.cpp.

References maximum.

auto INTExplore::getSection ( ) const -> unsigned int

Get section.

Definition at line 45 of file INTExplore.cpp.

References section.

auto INTExplore::getPrecision ( ) const -> int

Get precision.

Definition at line 49 of file INTExplore.cpp.

References precision.

auto INTExplore::toXML ( ) const -> std::shared_ptr<library::XML>
virtual

Get an XML object represents the Entity.

Returns an XML object that can represents the Entity containing member variables into properties.

A member variable (not object, but atomic value like number, string or date) is categorized as a property within the framework of entity side. Thus, when overriding a toXML() method and archiving member variables to an XML object to return, puts each variable to be a property belongs to only an XML object.

Don't archive the member variable of atomic value to XML::value causing enormouse creation of XML objects to number of member variables. An Entity must be represented by only an XML instance (tag).

Standard Usage Non-standard usage abusing value
<memberList>
     <member id='jhnam88' name='Jeongho+Nam' birthdate='1988-03-11' />
     <member id='master' name='Administartor' birthdate='2011-07-28' />
</memberList>
<member>
     <id>jhnam88</id>
     <name>Jeongho+Nam</name>
     <birthdate>1988-03-11</birthdate>
</member>
Returns
An XML object representing the Entity.

Reimplemented from samchon::protocol::Entity.

Reimplemented in samchon::namtree::NTFile, and samchon::namtree::NTParameter.

Definition at line 54 of file INTExplore.cpp.

References maximum, minimum, precision, section, and samchon::protocol::Entity::toXML().

Referenced by samchon::namtree::NTParameter::toXML().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

double samchon::namtree::INTExplore::minimum
protected

Minimum value.

Definition at line 35 of file INTExplore.hpp.

Referenced by construct(), getMinimum(), INTExplore(), and toXML().

double samchon::namtree::INTExplore::maximum
protected

Maximum value.

Definition at line 40 of file INTExplore.hpp.

Referenced by construct(), getMaximum(), INTExplore(), and toXML().

unsigned int samchon::namtree::INTExplore::section
protected

Section number of exploration.

Definition at line 45 of file INTExplore.hpp.

Referenced by construct(), getSection(), INTExplore(), and toXML().

int samchon::namtree::INTExplore::precision
protected

Target precision: 10precision

Definition at line 50 of file INTExplore.hpp.

Referenced by construct(), getPrecision(), INTExplore(), and toXML().


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