All the operations that the user can perform on a running master. More...

#include <opendnp3/master/IMasterOperations.h>

Public Member Functions
virtual	~IMasterOperations ()

virtual std::shared_ptr< IMasterScan >	AddAllObjectsScan (GroupVariationID gvId, TimeDuration period, std::shared_ptr< ISOEHandler > soe_handler, const TaskConfig &config=TaskConfig::Default())=0
	Add a scan that requests all objects using qualifier code 0x06 @ return A proxy class used to manipulate the scan. More...

virtual std::shared_ptr< IMasterScan >	AddClassScan (const ClassField &field, TimeDuration period, std::shared_ptr< ISOEHandler > soe_handler, const TaskConfig &config=TaskConfig::Default())=0
	Add a class-based scan to the master. More...

virtual std::shared_ptr< IMasterScan >	AddRangeScan (GroupVariationID gvId, uint16_t start, uint16_t stop, TimeDuration period, std::shared_ptr< ISOEHandler > soe_handler, const TaskConfig &config=TaskConfig::Default())=0
	Add a start/stop (range) scan to the master. More...

virtual std::shared_ptr< IMasterScan >	AddScan (TimeDuration period, const std::vector< Header > &headers, std::shared_ptr< ISOEHandler > soe_handler, const TaskConfig &config=TaskConfig::Default())=0
	Add a recurring user-defined scan from a vector of headers @ return A proxy class used to manipulate the scan. More...

virtual void	PerformFunction (const std::string &name, FunctionCode func, const std::vector< Header > &headers, const TaskConfig &config=TaskConfig::Default())=0
	Perform any operation that requires just a function code. More...

virtual void	Restart (RestartType op, const RestartOperationCallbackT &callback, TaskConfig config=TaskConfig::Default())=0
	Perform a cold or warm restart and get back the time-to-complete value. More...

virtual void	Scan (const std::vector< Header > &headers, std::shared_ptr< ISOEHandler > soe_handler, const TaskConfig &config=TaskConfig::Default())=0
	Initiate a single user defined scan via a vector of headers. More...

virtual void	ScanAllObjects (GroupVariationID gvId, std::shared_ptr< ISOEHandler > soe_handler, const TaskConfig &config=TaskConfig::Default())=0
	Initiate a single scan that requests all objects (0x06 qualifier code) for a certain group and variation. More...

virtual void	ScanClasses (const ClassField &field, std::shared_ptr< ISOEHandler > soe_handler, const TaskConfig &config=TaskConfig::Default())=0
	Initiate a single class-based scan. More...

virtual void	ScanRange (GroupVariationID gvId, uint16_t start, uint16_t stop, std::shared_ptr< ISOEHandler > soe_handler, const TaskConfig &config=TaskConfig::Default())=0
	Initiate a single start/stop (range) scan. More...

virtual void	SetLogFilters (const opendnp3::LogLevels &filters)=0

virtual void	Write (const TimeAndInterval &value, uint16_t index, const TaskConfig &config=TaskConfig::Default())=0
	Write a time and interval object to a specific index. More...

Public Member Functions inherited from opendnp3::ICommandProcessor
virtual void	DirectOperate (CommandSet &&commands, const CommandResultCallbackT &callback, const TaskConfig &config=TaskConfig::Default())=0
	Direct operate a set of commands. More...

template<class T >
void	DirectOperate (const T &command, uint16_t index, const CommandResultCallbackT &callback, const TaskConfig &config=TaskConfig::Default())
	Direct operate a single command. More...

virtual void	SelectAndOperate (CommandSet &&commands, const CommandResultCallbackT &callback, const TaskConfig &config=TaskConfig::Default())=0
	Select and operate a set of commands. More...

template<class T >
void	SelectAndOperate (const T &command, uint16_t index, const CommandResultCallbackT &callback, const TaskConfig &config=TaskConfig::Default())
	Select/operate a single command. More...

Detailed Description

All the operations that the user can perform on a running master.

Definition at line 47 of file IMasterOperations.h.

Constructor & Destructor Documentation

◆ ~IMasterOperations()

virtual opendnp3::IMasterOperations::~IMasterOperations ( )

inlinevirtual

Definition at line 50 of file IMasterOperations.h.

Member Function Documentation

◆ AddAllObjectsScan()

virtual std::shared_ptr<IMasterScan> opendnp3::IMasterOperations::AddAllObjectsScan	(	GroupVariationID	gvId,
		TimeDuration	period,
		std::shared_ptr< ISOEHandler >	soe_handler,
		const TaskConfig &	config = `TaskConfig::Default()`
	)

pure virtual

Add a scan that requests all objects using qualifier code 0x06 @ return A proxy class used to manipulate the scan.

◆ AddClassScan()

virtual std::shared_ptr<IMasterScan> opendnp3::IMasterOperations::AddClassScan	(	const ClassField &	field,
		TimeDuration	period,
		std::shared_ptr< ISOEHandler >	soe_handler,
		const TaskConfig &	config = `TaskConfig::Default()`
	)

pure virtual

Add a class-based scan to the master.

Returns: A proxy class used to manipulate the scan

◆ AddRangeScan()

virtual std::shared_ptr<IMasterScan> opendnp3::IMasterOperations::AddRangeScan	(	GroupVariationID	gvId,
		uint16_t	start,
		uint16_t	stop,
		TimeDuration	period,
		std::shared_ptr< ISOEHandler >	soe_handler,
		const TaskConfig &	config = `TaskConfig::Default()`
	)

pure virtual

Add a start/stop (range) scan to the master.

Returns: A proxy class used to manipulate the scan

◆ AddScan()

virtual std::shared_ptr<IMasterScan> opendnp3::IMasterOperations::AddScan	(	TimeDuration	period,
		const std::vector< Header > &	headers,
		std::shared_ptr< ISOEHandler >	soe_handler,
		const TaskConfig &	config = `TaskConfig::Default()`
	)

pure virtual

Add a recurring user-defined scan from a vector of headers @ return A proxy class used to manipulate the scan.

◆ PerformFunction()

virtual void opendnp3::IMasterOperations::PerformFunction	(	const std::string &	name,
		FunctionCode	func,
		const std::vector< Header > &	headers,
		const TaskConfig &	config = `TaskConfig::Default()`
	)

pure virtual

Perform any operation that requires just a function code.

◆ Restart()

virtual void opendnp3::IMasterOperations::Restart	(	RestartType	op,
		const RestartOperationCallbackT &	callback,
		TaskConfig	config = `TaskConfig::Default()`
	)

pure virtual

Perform a cold or warm restart and get back the time-to-complete value.

◆ Scan()

virtual void opendnp3::IMasterOperations::Scan	(	const std::vector< Header > &	headers,
		std::shared_ptr< ISOEHandler >	soe_handler,
		const TaskConfig &	config = `TaskConfig::Default()`
	)

pure virtual

Initiate a single user defined scan via a vector of headers.

◆ ScanAllObjects()

virtual void opendnp3::IMasterOperations::ScanAllObjects	(	GroupVariationID	gvId,
		std::shared_ptr< ISOEHandler >	soe_handler,
		const TaskConfig &	config = `TaskConfig::Default()`
	)

pure virtual

Initiate a single scan that requests all objects (0x06 qualifier code) for a certain group and variation.

◆ ScanClasses()

virtual void opendnp3::IMasterOperations::ScanClasses	(	const ClassField &	field,
		std::shared_ptr< ISOEHandler >	soe_handler,
		const TaskConfig &	config = `TaskConfig::Default()`
	)

pure virtual

Initiate a single class-based scan.

◆ ScanRange()

virtual void opendnp3::IMasterOperations::ScanRange	(	GroupVariationID	gvId,
		uint16_t	start,
		uint16_t	stop,
		std::shared_ptr< ISOEHandler >	soe_handler,
		const TaskConfig &	config = `TaskConfig::Default()`
	)

pure virtual

Initiate a single start/stop (range) scan.

◆ SetLogFilters()

virtual void opendnp3::IMasterOperations::SetLogFilters ( const opendnp3::LogLevels & filters )

pure virtual

Parameters

filters Adjust the filters to this value

◆ Write()

virtual void opendnp3::IMasterOperations::Write	(	const TimeAndInterval &	value,
		uint16_t	index,
		const TaskConfig &	config = `TaskConfig::Default()`
	)

pure virtual

Write a time and interval object to a specific index.

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

opendnp3/master/IMasterOperations.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMasterOperations()

Member Function Documentation

◆ AddAllObjectsScan()

◆ AddClassScan()

◆ AddRangeScan()

◆ AddScan()

◆ PerformFunction()

◆ Restart()

◆ Scan()

◆ ScanAllObjects()

◆ ScanClasses()

◆ ScanRange()

◆ SetLogFilters()

◆ Write()