OpenTestSystem::Otx::Runtime::Api::DataTypes::Structure Class Reference

Represents OTX Structure DataType. More...

#include <Structure.h>

Inheritance diagram for OpenTestSystem::Otx::Runtime::Api::DataTypes::Structure:

Public Member Functions
	Structure (const std::string &signature, std::vector< std::shared_ptr< StructureElement >> elements, std::shared_ptr< Otx::IDocument > document=nullptr, std::string specification="")
	Initializes a new instance of the Structure class. More...
std::shared_ptr< Otx::IDocument >	GetDocument () override
	Gets Document that contains the Signature. More...
const std::vector< std::shared_ptr< StructureElement > > &	GetElements () override
	Gets all elements. More...
std::string	GetFullName () override
	Gets Signature full name. More...
std::string	GetName () override
	Gets Signature name. More...
std::string	GetSignature () const
	Gets full name of structure signature. More...
std::string	GetSpecification () override
	Gets Signature specification. More...
std::string	ToLiteralString () const override
	Gets literal string. More...

Detailed Description

Represents OTX Structure DataType.

Constructor & Destructor Documentation

Structure()

OpenTestSystem::Otx::Runtime::Api::DataTypes::Structure::Structure	(	const std::string &	signature,
		std::vector< std::shared_ptr< StructureElement >>	elements,
		std::shared_ptr< Otx::IDocument >	document = nullptr,
		std::string	specification = ""
	)

Initializes a new instance of the Structure class.

Parameters

signature	Full name of structure signature.
elements	All elements.
document	The document this Structure belong to.
specification	Specification or description of structure signature.

Member Function Documentation

GetDocument()

std::shared_ptr<Otx::IDocument> OpenTestSystem::Otx::Runtime::Api::DataTypes::Structure::GetDocument ( )

overridevirtual

Gets Document that contains the Signature.

Returns

A Document which this Signature belongs to.

Implements OpenTestSystem::Otx::Runtime::Api::Otx::Signature::ISignature.

GetElements()

const std::vector<std::shared_ptr<StructureElement> >& OpenTestSystem::Otx::Runtime::Api::DataTypes::Structure::GetElements ( )

overridevirtual

Gets all elements.

Returns

All elements.

Implements OpenTestSystem::Otx::Runtime::Api::Otx::Signature::IStructureSignature.

GetFullName()

std::string OpenTestSystem::Otx::Runtime::Api::DataTypes::Structure::GetFullName ( )

overridevirtual

Gets Signature full name.

Returns

A combination of Document full name and Signature name, separated by '.'.

Implements OpenTestSystem::Otx::Runtime::Api::Otx::Signature::ISignature.

GetName()

std::string OpenTestSystem::Otx::Runtime::Api::DataTypes::Structure::GetName ( )

overridevirtual

Gets Signature name.

Returns

Procedure name.

Implements OpenTestSystem::Otx::Runtime::Api::Otx::Signature::ISignature.

GetSignature()

std::string OpenTestSystem::Otx::Runtime::Api::DataTypes::Structure::GetSignature

(

)

const

Gets full name of structure signature.

Returns

Full name of structure signature.

GetSpecification()

std::string OpenTestSystem::Otx::Runtime::Api::DataTypes::Structure::GetSpecification ( )

overridevirtual

Gets Signature specification.

Returns

Signature specification.

Implements OpenTestSystem::Otx::Runtime::Api::Otx::Signature::ISignature.

ToLiteralString()

std::string OpenTestSystem::Otx::Runtime::Api::DataTypes::Structure::ToLiteralString ( ) const

overridevirtual

Gets literal string.

Returns

Literal string.

Reimplemented from OpenTestSystem::Otx::Runtime::Api::DataTypes::Object.

---

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

• Structure.h